From Wikimedia Commons, the free media repository
Jump to: navigation, search
Documentation icon Documentationviewedithistorypurge

This documentation is transcluded from Template:Autocat/doc.

Explains in a category page which template should be used in pages in order to categorize them there.


{{Autocat |1= |2= |param= |missing= }}

Template parameters

 Parameter text is empty
<templatedata>JSON</templatedata> ./. {{TemplateBox}}

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 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 or the template as described in various Wikipediae.

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

Explains in a category page which template should be used in pages in order to categorize them there.

Template parameters
Parameter Description Type Default Auto value Status
template 1template name of the template that must be used for categorisation string empty empty required
value 2value value the first parameter (or the specified parameter below) must have for categorisation string empty empty optional
comment comment additional comment displayed in an issue message box (it's now preferable to use the "Cmbox" template separately) string empty empty deprecated
missing parameter missing parameter that must be missing (or empty) for categorisation string empty empty optional
pages? ns when this parameter is set and not empty (this is the default behavior), the displayed notice concerns the insertion of the specified template in pages of normal namespaces (articles, galleries, pages de discussion ou de documentation, etc.) instead of file description pages only when this parameter is explicitly set to an empty value string 1 empty optional
set parameter param name of the parameter that must be set for categorisation string 1 empty optional

Additional information

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

The template is intended to be used by the following user groups: no user group specified

Relies on:
{{Image template notice}}

See also



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)