Template:Commons category/doc
 | This is a documentation subpage for Template:Commons category. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on 29,000+ pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
 | As with other interwiki links, if you misspell your link target, the link will still appear blue, not red. Check spelling carefully. |
{{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 "blue" even though the link will fail. Check the existence of the category on commons as well as the spelling of names carefully.
Commons category (P373) (see uses)
Usage
[change source]{{Commons category|catnam}}– Puts link-box connecting title catnam {{Commons category|catnam|shownam}}– Puts link-box showing the title shownam {{Commons category|catnam|position=left}}– 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 "Category:" 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 bot account, AvicBot (talk · contribs), 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.
For example, on the Polar bear page, {{Commons category|Ursus maritimus|Polar bears}} produces a link to Commons:Category:Ursus maritimus displayed as "Polar bears".
The parameter |position= accepts one value, |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
[change source]
Do not place this template in a section all by itself without floating left.
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 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
[change source]TemplateData for Commons category
This template creates a small box containing a link to a category on Commons.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Category name | 1 | 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. | String | optional |
| Displayed text | 2 | 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. | String | optional |
| Position | position | When set to 'left', the template will be positioned on the left side of the page. Otherwise it will default to the right side. | String | optional |
Tracking categories
[change source]- Category:Commons category with local link different than on Wikidata (0)
- Category:Commons category with page title different than on Wikidata (0)
- Category:Commons category without a link on Wikidata (0)
- Category:Commons category template with no category set (0)
Redirects
[change source]{{Cc}}{{Ccat}}{{Commonscat}}{{Commons cat}}{{Wikimedia commons cat}}{{Category commons}}{{C cat}}{{Commonscategory}}{{Commonsimages cat}}
See also
[change source]- 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 Wikimedia sister projects (Wikinews, Wikisource, etc.)