View source for Template:Commons category/doc

{{documentation subpage}}
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
{{redirects|Template:CC|Creative Commons templates|Category:Creative Commons copyright templates}}
{{hatnote|This template is part of [[Wikipedia:Wikimedia sister projects|Wikimedia sister projects]].}}
{{high-risk| 658000+ }}
{{mbox|text=As with other [[H:IW|interwiki links]], if you misspell your link target, the link will still appear blue, not red. Check spelling carefully.}}
<!--[WP:Database_reports] transclusions-->

{{tlb|Commons category}} links to a "Category:" name in the [[Wikimedia Commons]] repository. If that category name is misspelled or missing, the link will still appear "[[Help:Link color|blue]]" even though the link will fail. Check the existence of the category on commons as well as the spelling of names carefully.
{{tsh|Ccat|Commonscat|Cc}}
{{Uses Wikidata|P373}}‎
{{Tracks Wikidata|P373|cat=Commons category Wikidata tracking categories‎}}‎

==Usage==
:{|
|-
| {{tl2|Commons category|''catnam''}} || – || Puts link-box connecting title ''catnam''
|-
| {{tl2|Commons category|''catnam''|''shownam''}} || – || Puts link-box showing the title ''shownam''
|-
| {{tl2|Commons category|''catnam''|3=position=left}} || style="vertical-align:top;" | – || Floats link-box to the left side, as option to align box to left-margin
|}

The two parameters ''catnam'' and ''shownam'' (1 & 2) are optional, and are intended for cases where the Commons category name is different from the Wikipedia page name. The first parameter is the name of the corresponding category on the Wikimedia Commons, ''without'' the "<code>Category:</code>" prefix. If this first parameter is used, then the template will display the Commons category name, which may be confusing to readers. This text can be overridden by the second parameter, where the Wikipedia page name would typically be used.

A [[WP:BOT|bot account]], {{user|AvicBot}}, currently runs a task which automatically fills in the first parameter where it is blank, thus providing some protection against category links breaking when pages are moved. It should therefore be safe to omit this when manually editing pages if the page title matches the Commons category title.

{{Commons category|Ursus maritimus|Polar bears}}
For example, on the [[Polar bear]] page, {{tlc|Commons category|Ursus maritimus|Polar bears}} produces a link to [[Commons:Category:Ursus maritimus]] displayed as "[[Commons:Category:Ursus maritimus|Polar bears]]". 

The parameter {{para|position}} accepts one value, {{para|position|left}}, that moves the box to the left side, instead of the default right side. More information may be found at [[Template:Side box]].

==Location==
[[File:Sister link template columns problem.jpg|thumb|If using a large, graphical template produces odd layout problems, like the excessive white space shown on the right of this screenshot, then switch to a different ''sister template''.]]

{{cross}} '''Do not place this template in a section all by itself without floating left.'''

{{cross}} '''Do not place this template in a section containing columns without floating left.'''

In articles, this template should be placed at the ''top'' of the last section on the page. On [[WP:disambiguation pages|disambiguation pages]], this template is usually placed at the top of the page.  See [[Wikipedia:Wikimedia sister projects#Where to place links]] for more information and alternatives.

In categories, this template should be grouped with other templates at the beginning of the category introduction. This avoids unnecessary white space as any text is floated around the template boxes.

==TemplateData==
{{TemplateDataHeader}}
<TemplateData>
{
        "description": "This template creates a small box containing a link to a category on Commons.",
        "params": {
                "1": {
                        "label": "Category name",
                        "description": "The name of the Commons category this template will link to. If no value is provided the Commons category value from Wikidata is used, and if none was provided there then the page name is used.",
                        "type": "string",
                        "required": false
                },
		"2": {
                        "label": "Displayed text",
                        "description": "The text that the link will display to the user. If no value is provided it will default to category name or page name, in that order.",
                        "type": "string",
                        "required": false
                },
		"position": {
                        "label": "Position",
                        "description": "When set to 'left', the template will be positioned on the left side of the page. Otherwise it will default to the right side.",
                        "type": "string",
                        "required": false
                }
        }
		
}
</TemplateData>

==Tracking categories==
<!-- {{clc|Commons category with local link same as on Wikidata}}  – deleted per [[Wikipedia:Categories for discussion/Log/2017 January 25]] -->
* {{clc|Commons category with local link different than on Wikidata}}
<!-- * {{clc|Commons category with page title same as on Wikidata}} – deleted per [[Wikipedia:Categories for discussion/Log/2017 January 25]] -->
* {{clc|Commons category with page title different than on Wikidata}} 
* {{clc|Commons category without a link on Wikidata}}

== Redirects ==
* {{Tlx|Cc}}
* {{Tlx|Ccat}}
* {{Tlx|Commonscat}}
* {{Tlx|Commons cat}}
* {{Tlx|Wikimedia commons cat}}
* {{Tlx|Category commons}}
* {{Tlx|C cat}}
* {{Tlx|Commonscategory}}
* {{Tlx|Commonsimages cat}}

==See also==
* [[Template:Commons]]
* [[Template:Commons-inline]] – shows Commons gallery inline
* [[Template:Commons category-inline]] – shows Commons category inline
* [[Template:Commons category multi]] – lists up to 6 categories
* [[Template:Commons and category]] – shows Commons box with both gallery and category
* [[Template:Commons and category-inline]] – shows Commons gallery and category inline
* [[Template:Commons redirect]] - specialized soft redirect template for Commons
* [[Template:Sister project links]] – links to all [[Wikipedia:Sister projects|Wikimedia sister projects]] (Wikinews, Wikisource, etc.)

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
[[Category:Exclude in print]]
[[Category:Interwiki category linking templates]]
[[Category:Interwiki link templates]]
[[Category:Wikimedia Commons templates]]
[[Category:Templates that add a tracking category]]

{{#ifeq:Template:Commons category|{{FULLPAGENAME}}|
}}}}</includeonly>