Template:Auxiliary template common notice/doc
Preformatted {{TemplateBox}} for character-substitution templates.
Usage
{{Auxiliary template common notice
|name =
}}
Template parameters
- 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.
Wikipedia's help about TemplateData • Commons-specific information
Preformatted {{TemplateBox}} for character-substitution templates.
Parameter | Description | Type | Status | |
---|---|---|---|---|
HTML Entity | entity | HTML character entity name | String | optional |
Title | name | name of the template (needed for viewing the documentation on another page than the template page, in particular for viewing the documentation page separately)
| Template | suggested |
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
Placement:
in the '/doc' subpage of a template
Relies on:
- {{Escape template list}}
- {{TemplateBox}}
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)