View source for Template:Commons/doc

{{Documentation subpage}}
{{tsh|common}}
<!--{{High-use}}-->
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
{{For|other uses in Wikipedia|Wikipedia:COMMON (disambiguation)}}
{{Distinguish|Template:Copy to Wikimedia Commons}}
<!--{{Lua|Module:Commons link}}-->
This template is part of Wikipedia's [[Wikipedia:Wikimedia sister projects|sister projects]]. This template links an article to a page on [[commons:|Wikimedia Commons]], containing a gallery of related media. Note that it does not link to a Commons category, which will give a larger selection of media; for that use [[Template:Commons category]].

==Usage==
::{|
|-
|{{Tlx|Commons}}||—puts link-box with current page's name.
|-
|{{Tlx|Commons|''pagename''}}||—puts link-box connecting title ''pagename''.
|-
|{{Tlx|Commons|''pagename''|''showname''}}||—puts link-box showing the title ''showname''.
|-
|{{Tlx|Commons|''pagename''|3=position=left}}||—floats link-box to the left side.
|}

To place this template on the page, type '''<nowiki>{{</nowiki>Commons|''pagename''}}''', where ''pagename'' is the name of a page on Wikimedia Commons (defaults to <small><nowiki>"{{PAGENAME}}"</nowiki></small>, the end-name of a page where used).
* The optional 2nd parameter gives the displayed link text.
* The {{Para|position}} parameter accepts one keyword, <code>left</code>, to float the box to the left instead of to the right.
* To link to a ''Category'', use the related template {{Tlx|Commons category|''catname''}}, where ''catname'' is the name of the category.

==Location==
{{Commons templates location}}

==Defaults==
The ''pagename'' defaults to wiki-variable <small><nowiki>"{{PAGENAME}}"</nowiki></small>, which is the end-name of the page where used. For a Template:Txxx, the <small><nowiki>{{PAGENAME}}</nowiki></small> would be the end-name "Txxx". For a Category:Catxxx, that page would have <small><nowiki>{{PAGENAME}}</nowiki></small> as the end-name "Catxxx".

The default positioning of the link-box is to the right-side.

==Examples==
{| style="border:1px solid #808080; padding:1px;"
|{{tlx|Commons}}
|}
produces
{{Commons}}
{{clear}}

{| style="border:1px solid #808080; padding:1px;"
|{{tlx|Commons|Reconquista}}
|}
produces
{{Commons|Reconquista}}
{{clear}}

{| style="border:1px solid #808080; padding:1px;"
|{{tlx|Commons|Category:Reconquista}}
|}
produces
{{Commons|Category:Reconquista}}
{{clear}}

{| style="border:1px solid #808080; padding:1px;"
|{{tlx|Commons|Reconquista|retaking of the Iberian Peninsula}}
|}
produces
{{Commons|Reconquista|retaking of the Iberian Peninsula}}
{{clear}}

{| style="border:1px solid #808080; padding:1px;"
|{{tlx|Commons|Reconquista|position{{=}}left}}
|}
produces
{{Commons|Reconquista|position=left}}
{{clear}}

==Template data==
{{TemplateData header}}
<!--<templatedata>-->
<syntaxhighlight lang="JSON">
{
"description": "Creates a small box with a link to a related page on Wikimedia Commons.",
"params": {
  "1": {
    "label": "Pagename",
    "description": "The page name on Commons. The article's page name is used as a default.",
    "type": "string",
    "required": false
  },
  "2": {
    "label": "Showname",
    "description": "Optional displayed link text.",
    "type": "string",
    "required": false
  },
  "position": {
    "label": "Position",
    "description": "Position to display the box: 'left' floats the box to the left rather than the default which is on the right.",
    "type": "string",
    "required": false
  }
}}
</syntaxhighlight>
<!--</templatedata>-->

== Tracking categories ==
=== Normal categories ===
* {{clc|Commons link from Wikidata}}
* {{clc|Commons link is on Wikidata}}
=== Maintenance categories ===
* {{clc|Commons link is defined as the pagename}}
* {{clc|Commons link is locally defined}}
* {{clc|Commons link is the pagename}}
* {{clc|Inconsistent wikidata for Commons gallery}}

==See also==
{{Commons templates see also}}
<includeonly>{{Sandbox other||
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
[[Category:Interwiki link templates]]
[[Category:Wikimedia Commons templates]]
}}</includeonly>