Template:Autocat

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search
Template documentationview · edit · history · purge ]
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.

Usage

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

Template parameters

<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

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

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
template1 template

name of the template that must be used for categorisation

Templaterequired
value2 value

value the first parameter (or the specified parameter below) must have for categorisation

Stringoptional
commentcomment

additional comment displayed in an issue message box (it's now preferable to use the "Cmbox" template separately)

Stringdeprecated
missing parametermissing

parameter that must be missing (or empty) for categorisation

Stringoptional
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, discussion or documentation pages, etc.) instead of file description pages only when this parameter is explicitly set to an empty value

Default
1
Stringoptional
set parameterparam

name of the parameter that must be set for categorisation

Default
1
Stringoptional

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

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)