Template:Category

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search
Template documentationview · edit · history · purge ]
This documentation is transcluded from Template:Category/doc.

This template is used in other templates to categorize pages to a stated category only when the template is used in the stated namespace. Pages in other namespace are not categorized.

Usage

{{Category |1= |2= |3= }}

Template parameters

ParameterDescriptionDefaultStatus
1category nameThe name of the target category (without the prefix Category: and without quotation marks). The template doesn't test whether the target category exists.emptyrequired
2namespaceThe namespace from which only pages were categorized.(main - gallery)optional
3sortkeyA sortkey for the page in the target category.{{PAGENAME}}optional
Template data
<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.


Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.


Wikipedia's help about TemplateDataCommons-specific information

This template is used in other templates to categorize pages to a stated category only when the template is used in the stated namespace. Pages in other namespace are not categorized.

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
category name1

The name of the target category (without the prefix Category: and without quotation marks). The template doesn't test whether the target category exists.

Linerequired
namespace2

The namespace from which only pages were categorized.

Default
(main - gallery)
Lineoptional
sortkey3

A sortkey for the page in the target category.

Default
{{PAGENAME}}
Auto value
{{PAGENAME}}
Lineoptional

Additional information

The template is intended to be used in the following namespaces: the Template namespace

The template is intended to be used by the following user groups: all users

See also

Localization

To add your language to the list of languages supported by this template, please edit the template and add a row to the "{{LangSwitch|}}" construct. It takes the form "|xx= Your translation " (xx being the code of your language)