View source for Template:Commons category/doc

{{documentation subpage}}
{{Message_box |id = |halign = |malign = |backgroundcolor = |image  =Nuvola mimetypes info.png|30px |heading = |message =Note how misspelled words seem to be valid links to Wikimedia. Check spelling carefully.}}

<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

The "[[Template:Commons category]]" links to a "Category:" name in the Wikimedia Commons repository (edited using a Wikimedia login name).  If that category name is misspelled or missing, the link will still appear "blue" even though the link will fail. Check spelling of names carefully.

=== Usage ===
:{|
|-
|{{tl2|Commons category}}||width=16px valign=top|&mdash;|| puts link-box with current page's name as the category.
|-
|{{tl2|Commons category|''catnam''}}||&mdash;|| puts link-box connecting title ''catnam''.
|-
|{{tl2|Commons category|''catnam''|''shownam''}}||&mdash;|| puts link-box showing the title ''shownam''.
|-
|{{tl2|Commons category |''catnam''|3=position=left}}||valign=top|&mdash;|| 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 LIMSwiki 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 LIMSwiki page name would typically be used.

The parameter "position=" accepts one value, <code>left</code>, that moves the box to the left side, instead of the default right side. More information may be found at <code>{{tl|Side box}}</code>.

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

===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.'''

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

In articles, this template should normally be placed at the ''top'' of the "External links" section, if one exists, or at the top of the last section on the page, if no external links section exists.  On disambiguation pages, this template is usually placed at the top of the page.

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

=== See also ===
* [[Template:Commons+cat]] - shows Commons box with both gallery and category
* [[Template:Commons cat multi]] – to include multiple categories.
* [[Template:Commons category-inline]]
* [[Template:Commons-inline]] - inline link to Commons in list format, not a box

<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Interwiki category linking templates]]
[[Category:Interwiki link templates]]
[[Category:Wikimedia Commons templates]]

</includeonly>