Template:Commons category

From WikiAlpha
Jump to: navigation, search
The below content was derived from the Wikipedia page Template:Commons category, with the list of authors located at the talk page, and is licensed according to the Creative Commons Attribution-ShareAlike 3.0 Unported License contrary to the public domain logo at the foot of the page.
[edit] [purge] Template documentation

Template:Redirects

Template:Tlb 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. Template:Tsh Template:Uses WikidataTemplate:Tracks Wikidata

Usage

Template:Tl2 Puts link-box connecting title catnam
Template:Tl2 Puts link-box showing the title shownam
Template:Tl2 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, Template:User, 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

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.

Template:Cross Do not place this template in a section all by itself without floating left.

Template: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 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

This is the TemplateData documentation for this template used by VisualEditor and other tools.

See the monthly error report for this template.

TemplateData for Commons category

<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 page name is used by default.",
                       "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

Redirects

See also