Template:Auxiliary template common notice/doc: Difference between revisions
More actions
Create documentation subpage for {{Auxiliary template common notice}} |
|||
| Line 10: | Line 10: | ||
| namespace = Template | | namespace = Template | ||
| usergroup = all | | usergroup = all | ||
| relieson = {{ | | relieson = | ||
* {{tld|Escape template list}} | |||
| placement = {{LangSwitch | | placement = {{LangSwitch | ||
| en = in the '/doc' subpage of a template | | en = in the '/doc' subpage of a template | ||
| Line 26: | Line 27: | ||
| 1 = name | | 1 = name | ||
| 1default = <nowiki>{{ | | 1default = <nowiki>{{BASEPAGENAME}}</nowiki> | ||
| 1stat = required | | 1stat = required | ||
| 1type = wiki-template-name | | 1type = wiki-template-name | ||
| 1label = | | 1label-en = Title | ||
| 1label-de = Titel | | 1label-de = Titel | ||
| 1label-et = pealkiri | | 1label-et = pealkiri | ||
| Line 39: | Line 40: | ||
| 1label-pt = título | | 1label-pt = título | ||
| 1d | | 1d-en = name of the template <small>''(needed for viewing the documentation on another page than the template page, in particular for viewing the documentation page separately)''</small> | ||
| 1d-bar = Name vo da Vurlog <small>''(den braucht ma, um de Dokumentazion auf a åndern Seit ois auf da Vurlgnseitn — speziell auf da Dokumentationsseitn soibst — dårstoin zum kenna)''</small> | | 1d-bar = Name vo da Vurlog <small>''(den braucht ma, um de Dokumentazion auf a åndern Seit ois auf da Vurlgnseitn — speziell auf da Dokumentationsseitn soibst — dårstoin zum kenna)''</small> | ||
| 1d-de = Name der Vorlage <small>''(wird benötigt um die Dokumentation auf einer anderen Seite als der Vorlagenseite — insbesondere auf der Dokumentationsseite selbst — darstellen zu können)''</small> | | 1d-de = Name der Vorlage <small>''(wird benötigt um die Dokumentation auf einer anderen Seite als der Vorlagenseite — insbesondere auf der Dokumentationsseite selbst — darstellen zu können)''</small> | ||
| Line 53: | Line 54: | ||
| 2type = string | | 2type = string | ||
| 2label | | 2label-en = Description | ||
| 2label-de = Beschreibung | | 2label-de = Beschreibung | ||
| 2label-et = kirjeldus | | 2label-et = kirjeldus | ||
| Line 60: | Line 61: | ||
| 2label-pt = descrição | | 2label-pt = descrição | ||
| 2d | | 2d-en = description of what the template does | ||
| 2d-et = kirjeldus sellest, mida mall teeb | | 2d-et = kirjeldus sellest, mida mall teeb | ||
| 2d-hu = Sablon leírása | | 2d-hu = Sablon leírása | ||
| Line 68: | Line 69: | ||
| 3 = entity | | 3 = entity | ||
| 3label = HTML Entity | | 3label = HTML Entity | ||
| 3d | | 3d-en = HTML character entity name | ||
| 3stat = optional- | | 3stat = optional- | ||
| 3type = string | | 3type = string | ||
| Line 74: | Line 75: | ||
<includeonly>{{Sandbox other|| | <includeonly>{{Sandbox other|| | ||
<!-- Categories below this line; interwikis at Wikidata --> | <!-- Categories below this line; interwikis at Wikidata --> | ||
[[Category:Multi-template documentation]] | |||
[[Category:Template documentation]] | [[Category:Template documentation]] | ||
[[Category:TemplateData documentation]] | |||
}}</includeonly> | }}</includeonly> | ||
Revision as of 03:50, 13 June 2021
Preformatted {{TemplateBox}} for character-substitution templates.
Usage
{{Auxiliary template common notice
|name =
|desc =
}}
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 | |
|---|---|---|---|---|
| Description | desc | description of what the template does | String | required |
| HTML Entity | entity | HTML character entity name | String | optional |
| Title | name | name of the template <small>''(needed for viewing the documentation on another page than the template page, in particular for viewing the documentation page separately)''</small>
| Template | required |
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: