Template:Commons category

File:Test Template Info-Icon - Version (2).svg Template documentationviewedithistorypurge

{{#ifeq:commons category |doc

    | 

{{#ifeq:show |show

|

        }}{{#if:|
         |{{#ifexist:Template:Commons category
                  | [[Category:{{#switch:Template |Template=Template |Module=Module |User=User |#default=Wikipedia}} documentation pages]]
                  | 
                 }}
        }}
    | 
   }}

"Template:CC" redirects here. For Creative Commons templates, see Category:Creative Commons copyright templates.

This template is part of Wikimedia sister projects.

{{Commons category}} links to a "Category:" name in the Wikimedia Commons repository that corresponds to the article or category. If the Commons 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. That said, Pi bot will attempt to fix or remove links to non-existent categories. In articles, this template should be placed at the top of the last section on the page so that it floats to the right of that section. A warning will appear if the Commons link is not on Wikidata.

Usage

{{[[:{{ safesubst:#if: | {{{sister}}}: }}{{ safesubst:#if: | {{{lang}}}: }}Template:Commons category|Commons category]]{{ safesubst:#if: | |{{{2}}} }}{{ safesubst:#if: | |{{{3}}} }}{{ safesubst:#if: | |{{{4}}} }}{{ safesubst:#if: | |{{{5}}} }}{{ safesubst:#if: | |{{{6}}} }}{{ safesubst:#if: | |{{{7}}} }}{{ safesubst:#if: | |{{{8}}} }}{{ safesubst:#if: | |{{{9}}} }}}}	–	Fetches the Commons sitelink from Wikidata (where available)
{{[[:{{ safesubst:#if: | {{{sister}}}: }}{{ safesubst:#if: | {{{lang}}}: }}Template:Commons category|Commons category]]{{ safesubst:#if: catname | |catname }}{{ safesubst:#if: | |{{{3}}} }}{{ safesubst:#if: | |{{{4}}} }}{{ safesubst:#if: | |{{{5}}} }}{{ safesubst:#if: | |{{{6}}} }}{{ safesubst:#if: | |{{{7}}} }}{{ safesubst:#if: | |{{{8}}} }}{{ safesubst:#if: | |{{{9}}} }}}}	–	Puts link-box connecting title catname
{{[[:{{ safesubst:#if: | {{{sister}}}: }}{{ safesubst:#if: | {{{lang}}}: }}Template:Commons category|Commons category]]{{ safesubst:#if: catname | |catname }}{{ safesubst:#if: showname | |showname }}{{ safesubst:#if: | |{{{4}}} }}{{ safesubst:#if: | |{{{5}}} }}{{ safesubst:#if: | |{{{6}}} }}{{ safesubst:#if: | |{{{7}}} }}{{ safesubst:#if: | |{{{8}}} }}{{ safesubst:#if: | |{{{9}}} }}}}	–	Puts link-box showing the title showname
{{[[:{{ safesubst:#if: | {{{sister}}}: }}{{ safesubst:#if: | {{{lang}}}: }}Template:Commons category|Commons category]]{{ safesubst:#if: catname | |catname }}{{ safesubst:#if: position=left | |position=left }}{{ safesubst:#if: | |{{{4}}} }}{{ safesubst:#if: | |{{{5}}} }}{{ safesubst:#if: | |{{{6}}} }}{{ safesubst:#if: | |{{{7}}} }}{{ safesubst:#if: | |{{{8}}} }}{{ safesubst:#if: | |{{{9}}} }}}}	–	Floats link-box to the left side, as option to align box to left-margin
{{[[:{{ safesubst:#if: | {{{sister}}}: }}{{ safesubst:#if: | {{{lang}}}: }}Template:Commons category|Commons category]]{{ safesubst:#if: | |{{{2}}} }}{{ safesubst:#if: nowrap=yes | |nowrap=yes }}{{ safesubst:#if: | |{{{4}}} }}{{ safesubst:#if: | |{{{5}}} }}{{ safesubst:#if: | |{{{6}}} }}{{ safesubst:#if: | |{{{7}}} }}{{ safesubst:#if: | |{{{8}}} }}{{ safesubst:#if: | |{{{9}}} }}}}	–	Stops the text of the Commons category from wrapping
{{[[:{{ safesubst:#if: | {{{sister}}}: }}{{ safesubst:#if: | {{{lang}}}: }}Template:Commons category|Commons category]]{{ safesubst:#if: | |{{{2}}} }}{{ safesubst:#if: lcfirst=yes | |lcfirst=yes }}{{ safesubst:#if: | |{{{4}}} }}{{ safesubst:#if: | |{{{5}}} }}{{ safesubst:#if: | |{{{6}}} }}{{ safesubst:#if: | |{{{7}}} }}{{ safesubst:#if: | |{{{8}}} }}{{ safesubst:#if: | |{{{9}}} }}}}	–	Displays the first letter as lower-case
{{[[:{{ safesubst:#if: | {{{sister}}}: }}{{ safesubst:#if: | {{{lang}}}: }}Template:Commons category|Commons category]]{{ safesubst:#if: | |{{{2}}} }}{{ safesubst:#if: italic=no | |italic=no }}{{ safesubst:#if: | |{{{4}}} }}{{ safesubst:#if: | |{{{5}}} }}{{ safesubst:#if: | |{{{6}}} }}{{ safesubst:#if: | |{{{7}}} }}{{ safesubst:#if: | |{{{8}}} }}{{ safesubst:#if: | |{{{9}}} }}}}	–	Turn off italics for displayed text

The two parameters catname and showname (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.

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 |{{SAFESUBST:#if:position|position=}} accepts one value, |{{SAFESUBST:#if:position|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

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.

Generally:

[[{{ safesubst:#switch:

|red |rd |r =File:X mark.svg |darkred |dkred |drd |dr =File:Dark red x.svg |orange |or |o =File:Orange x.svg |yellow |yel |y =File:Dark yellow x.svg |black |blk |k =File:Black x.svg |grey |gray |gry |gy =File:SemiTransBlack x.svg

     |File:X mark.svg

}}|px|link=|alt=☒]]N Do not place this template or any box-type template in a section all by itself.

[[{{ safesubst:#switch:

|red |rd |r =File:X mark.svg |darkred |dkred |drd |dr =File:Dark red x.svg |orange |or |o =File:Orange x.svg |yellow |yel |y =File:Dark yellow x.svg |black |blk |k =File:Black x.svg |grey |gray |gry |gy =File:SemiTransBlack x.svg

     |File:X mark.svg

}}|px|link=|alt=☒]]N Do not place this template in a section containing columns without floating left.

[[{{ safesubst:#switch:

|red |rd |r =File:X mark.svg |darkred |dkred |drd |dr =File:Dark red x.svg |orange |or |o =File:Orange x.svg |yellow |yel |y =File:Dark yellow x.svg |black |blk |k =File:Black x.svg |grey |gray |gry |gy =File:SemiTransBlack x.svg

     |File:X mark.svg

}}|px|link=|alt=☒]]N Do not indent this template with colon (<syntaxhighlight lang="text" class="" style="" inline="1">:</syntaxhighlight>) or a bullet (<syntaxhighlight lang="text" class="" style="" inline="1">*</syntaxhighlight>) markup.

Specifically:

• In articles, this template should be placed at the top of the last section on the page so that it floats to the right of that section.
  • See Wikipedia:Wikimedia sister projects#Where to place links for more information and alternatives.
• In disambiguation pages, this template is usually placed at the top of the page.
• 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.

Resolving discrepancies

This template compares locally-defined values against the interwiki links to Commons stored on Wikidata. The discrepancies are highlighted through the addition of maintenance categories. Pages can be removed from the tracking categories by correcting the local link; removing misplaced template uses; fixing the sitelinks on Wikidata; or expanding the category system on Commons. A workaround is to switch to {{Commons category multi}}, but ideally there should be one Commons category link per article, and it should be easy for readers to identify the related content on Commons. Some suggested approaches are:

The link is to a more general topic than the article:

1. Is there a more specific Commons category that could be linked to instead?
2. If not, could it be created with images connected to the article?
3. Or if there aren't any images connected to the article on Commons, could the Commons category link be removed?

There are links to multiple Commons categories in the article:

1. Could they be replaced by a single Commons category that has the rest as subcategories?
2. Do all of the Commons categories still exist?
3. Are they all necessary, or could they be removed?

The Commons category links back to the wrong Wikipedia article:

1. Can you move the sitelink to the Wikidata item for the article?

Tracking categories

Normal categories

• {{#if:|{{{name}}}|Category:Commons category link from Wikidata}} (3)
• {{#if:|{{{name}}}|Category:Commons category link is on Wikidata}} (3)

Maintenance categories

• {{#if:|{{{name}}}|Category:Commons category link is defined as the pagename}} (3)
• {{#if:|{{{name}}}|Category:Commons category link is locally defined}} (3)
• {{#if:|{{{name}}}|Category:Commons category link is the pagename}} (3)

TemplateData

{{#if:|{{#switch:

|=[https://bambots.brucemyers.com/TemplateParam.php?wiki=enwiki&template=%7B%7B%23if%3ACommons+category%7CCommons+category%7CCommons+category%7D%7D {{#ifeq:{{safesubst:#switch: {{{lc}}}
|no
|n
|f
|false
|off
|0        = no
|         = no
|¬        = no
|yes
|y
|t
|true
|on
|1        = yes
|#default = no

}}|no|S|s}}ee a monthly parameter usage report] for {{#if:Commons category|Template:Commons category|this template}} in articles{{#ifeq:{{safesubst:#switch: y

|no
|n
|f
|false
|off
|0        = no
|         = no
|¬        = no
|yes
|y
|t
|true
|on
|1        = yes
|#default = no

}}|yes| based on {{#if:Commons category|its|this}} TemplateData}}.

|None|none=[https://bambots.brucemyers.com/TemplateParam.php?wiki=enwiki&template=%7B%7B%23if%3ACommons+category%7CCommons+category%7CCommons+category%7D%7D {{#ifeq:{{safesubst:#switch: {{{lc}}}
|no
|n
|f
|false
|off
|0        = no
|         = no
|¬        = no
|yes
|y
|t
|true
|on
|1        = yes
|#default = no

}}|no|P|p}}arameter usage report]{{#ifeq:{{safesubst:#switch: y

|no
|n
|f
|false
|off
|0        = no
|         = no
|¬        = no
|yes
|y
|t
|true
|on
|1        = yes
|#default = no

}}|yes| based on {{#if:Commons category|its|this}} TemplateData}}

|for|For=[https://bambots.brucemyers.com/TemplateParam.php?wiki=enwiki&template=%7B%7B%23if%3ACommons+category%7CCommons+category%7CCommons+category%7D%7D {{#ifeq:{{safesubst:#switch: {{{lc}}}
|no
|n
|f
|false
|off
|0        = no
|         = no
|¬        = no
|yes
|y
|t
|true
|on
|1        = yes
|#default = no

}}|no|P|p}}arameter usage report] for {{#if:Commons category|Template:Commons category|Template:Commons category}}{{#ifeq:{{safesubst:#switch: y

|no
|n
|f
|false
|off
|0        = no
|         = no
|¬        = no
|yes
|y
|t
|true
|on
|1        = yes
|#default = no

}}|yes| based on {{#if:Commons category|its|this}} TemplateData}}.

|#default=[1]{{#ifeq:{{safesubst:#switch: y
|no
|n
|f
|false
|off
|0        = no
|         = no
|¬        = no
|yes
|y
|t
|true
|on
|1        = yes
|#default = no

}}|yes| based on {{#if:Commons category|its|this}} TemplateData}} }}|This is the {{#if:|TemplateData|TemplateData}} for this template used by TemplateWizard, VisualEditor and other tools. {{#switch:

|=[https://bambots.brucemyers.com/TemplateParam.php?wiki=enwiki&template=%7B%7B%23if%3ACommons+category%7CCommons+category%7CCommons+category%7D%7D {{#ifeq:{{safesubst:#switch: {{{lc}}}
|no
|n
|f
|false
|off
|0        = no
|         = no
|¬        = no
|yes
|y
|t
|true
|on
|1        = yes
|#default = no

}}|no|S|s}}ee a monthly parameter usage report] for {{#if:Commons category|Template:Commons category|this template}} in articles{{#ifeq:{{safesubst:#switch: y

|no
|n
|f
|false
|off
|0        = no
|         = no
|¬        = no
|yes
|y
|t
|true
|on
|1        = yes
|#default = no

}}|yes| based on {{#if:Commons category|its|this}} TemplateData}}.

|None|none=[https://bambots.brucemyers.com/TemplateParam.php?wiki=enwiki&template=%7B%7B%23if%3ACommons+category%7CCommons+category%7CCommons+category%7D%7D {{#ifeq:{{safesubst:#switch: {{{lc}}}
|no
|n
|f
|false
|off
|0        = no
|         = no
|¬        = no
|yes
|y
|t
|true
|on
|1        = yes
|#default = no

}}|no|P|p}}arameter usage report]{{#ifeq:{{safesubst:#switch: y

|no
|n
|f
|false
|off
|0        = no
|         = no
|¬        = no
|yes
|y
|t
|true
|on
|1        = yes
|#default = no

}}|yes| based on {{#if:Commons category|its|this}} TemplateData}}

|for|For=[https://bambots.brucemyers.com/TemplateParam.php?wiki=enwiki&template=%7B%7B%23if%3ACommons+category%7CCommons+category%7CCommons+category%7D%7D {{#ifeq:{{safesubst:#switch: {{{lc}}}
|no
|n
|f
|false
|off
|0        = no
|         = no
|¬        = no
|yes
|y
|t
|true
|on
|1        = yes
|#default = no

}}|no|P|p}}arameter usage report] for {{#if:Commons category|Template:Commons category|Template:Commons category}}{{#ifeq:{{safesubst:#switch: y

|no
|n
|f
|false
|off
|0        = no
|         = no
|¬        = no
|yes
|y
|t
|true
|on
|1        = yes
|#default = no

}}|yes| based on {{#if:Commons category|its|this}} TemplateData}}.

|#default=[2]{{#ifeq:{{safesubst:#switch: y
|no
|n
|f
|false
|off
|0        = no
|         = no
|¬        = no
|yes
|y
|t
|true
|on
|1        = yes
|#default = no

}}|yes| based on {{#if:Commons category|its|this}} TemplateData}} }}}}

TemplateData for Commons category

{{#switch:

 {{#if:
 | {{{demospace}}}    
 | {{#ifeq:Template|Template
   | template
   | other
   }}
 }}

| template = {{safesubst:#if:{{safesubst:#ifeq:Commons|sandbox|1}}{{safesubst:#ifeq:Commons category|doc|1}}||

}} | other | #default = }} <TemplateData> { "description": "This template creates a small box containing a link to a category on Commons. 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.", "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 }, "nowrap": { "label": "nowrap", "description": "Stops the text of the Commons category from wrapping", "type": "string", "required": false }, "lcfirst": { "label": "lcfirst", "description": "Displays the first letter as lower-case", "type": "string", "required": false } } } </TemplateData>

Redirects

• {{C cat}}
• {{Category commons}}
• {{Category Commons}}
• {{Cc}}
• {{Ccat}}
• {{Commons cat}}
• {{Commonscat}}
• {{Commonscategory}}
• {{Commonsimages cat}}
• {{Wikimedia commons cat}}

See also

{{safesubst:#if:|

}}

• Wikipedia:Manual of Style/Layout § External links
• {{Commons}}—shows Commons box
• {{Commons-inline}}—shows Commons gallery inline
• {{Commons category}}—shows Commons category box
• {{Commons category-inline}}—shows Commons category inline
• {{Commons category multi}}—to list up to twelve categories
• {{Commons and category}}—shows Commons box with both gallery and category
• {{Commons and category inline}}—shows Commons gallery and category inline
• {{Copy to Wikimedia Commons}}
• {{Wikimedia Commons redirect}}—specialized soft redirect template for Commons
• {{Wiki category}}—to link to a gallery hosted on Wikipedia
• mw:Manual:Pywikibot/commonscat.py

{{safesubst:#if:|

}}

• {{Sister project links}}—to link all Wikinews, Wikisource, etc.
• {{Wikibooks}} / {{Wikibooks inline}}
• {{Wikidata property}}
• {{Wikinews}} / {{Wikinews inline}}
• {{Wikiquote}} / {{Wikiquote inline}}
• {{Wikisource}} / {{Wikisource inline}}
• {{Wikispecies}} / {{Wikispecies inline}}
• {{Wikiversity}} / {{Wikiversity inline}}
• {{Wikivoyage}} / {{Wikivoyage inline}}
• {{Wiktionary}} / {{Wiktionary inline}}

{{safesubst:#if:{{safesubst:#ifeq:Commons|sandbox|1}}{{safesubst:#ifeq:Commons category|doc|1}}|| }}

The above documentation is transcluded from Template:Commons category/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.