Template:TemplateBox/doc: Difference between revisions
More actions
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{TemplateBox | {{TemplateBox | ||
|1|1d={{LangSwitch | |1|1d={{LangSwitch | ||
|en=parameter name ( | |en=parameter name (similarly 2, 3, .., up to 20) | ||
|de=Name des Parameters (bis 20, 1, 2, etc.) | |de=Name des Parameters (bis 20, 1, 2, etc.) | ||
|fr=Nom du paramètre (jusqu’à 20 : 1, 2, ..., 20). | |fr=Nom du paramètre (jusqu’à 20 : 1, 2, ..., 20). | ||
| Line 7: | Line 7: | ||
}} | }} | ||
|1d|2d={{LangSwitch | |1d|2d={{LangSwitch | ||
|en=description of the parameter ( | |en=description of the parameter (similarly 2d, 3d, .., up to 20d) | ||
|de=Beschreibung des Parameters (bis 20, 1, 2, etc.) | |de=Beschreibung des Parameters (bis 20, 1, 2, etc.) | ||
|fr=Description du paramètre (jusqu’à 20 : 1d, 2d, ..., 20d). | |fr=Description du paramètre (jusqu’à 20 : 1d, 2d, ..., 20d). | ||
| Line 13: | Line 13: | ||
}} | }} | ||
|1def|3d={{LangSwitch | |1def|3d={{LangSwitch | ||
|en=default value for the parameter ( | |en=default value for the parameter (similarly 2def, 3def, .., up to 20def) | ||
|de=Standardwert des Parameters (bis 20, 1, 2, etc.) | |de=Standardwert des Parameters (bis 20, 1, 2, etc.) | ||
|fr=Valeur par défaut du paramètre (jusqu’à 20 : 1def, 2def, ..., 20def) | |fr=Valeur par défaut du paramètre (jusqu’à 20 : 1def, 2def, ..., 20def) | ||
| Line 19: | Line 19: | ||
}} | }} | ||
|1stat|4d={{LangSwitch | |1stat|4d={{LangSwitch | ||
|en=status of the parameter; possible values: | |en=status of the parameter (similarly 2stat, 3stat, .., up to 20stat); possible values: | ||
|de=Status des Parameters Mögliche Werte: | |de=Status des Parameters Mögliche Werte: | ||
|fr=Statut du paramètre. Valeurs possibles : | |fr=Statut du paramètre. Valeurs possibles : | ||
Revision as of 07:26, 19 September 2010
The template provides a uniform way to provide basic information about the use of a template.
Usage
{{TemplateBox
|1 =
|1d =
|1def =
|1stat =
|name =
|desc =
|namespace =
|usergroup =
|placement =
|usage-notes =
|type =
|example =
|i18n-method =
|i18n-desc =
|i18n-mediawiki-msg =
|seealso =
|setscats =
|lines =
|shorthand =
|relieson =
}}
Template parameters
| Parameter | Description | Default | Status | |
|---|---|---|---|---|
1 | parameter name (similarly 2, 3, .., up to 20) | empty | optional | |
1d | description of the parameter (similarly 2d, 3d, .., up to 20d) | empty | optional | |
1def | default value for the parameter (similarly 2def, 3def, .., up to 20def) | empty | optional | |
1stat | status of the parameter (similarly 2stat, 3stat, .., up to 20stat); possible values:
| optional | optional | |
name | name of the template | {{PAGENAME}} | required | |
desc | description of what the template does | empty | required | |
namespace | namespaces, the template is intended to use in | empty | required | |
usergroup | usergroup that is meant to use the template | empty | required | |
placement | placement on the page. Possible values:
| empty | optional | |
usage-notes | notes about the correct usage of the template | empty | optional | |
type | what type is the template (infobox, formatting, licence tag, ...) | empty | optional | |
example | example use (works with a single unnamed parameter only) | empty | optional | |
i18n-method | method the localization is achieved by. Known values:
| empty | optional | |
i18n-desc | additional info about the localization | empty | optional | |
i18n-mediawiki-msg | When using "mediawiki-msg" as method, optionally put the name of the message here. Falls back to:
Wm-license-{{lc:{{BASEPAGENAME}}}}-text | empty | optional | |
seealso | relevant links (put in a list of them) | empty | optional | |
setscats | what categories are automatically set by the template (put in a linked list of them) | one | optional | |
lines | are the parameters typically put into new lines or all on one line. Possible values:
| empty | optional | |
shorthand | shorthand for easy use (redirects to main template) | empty | optional | |
relieson | list of templates on which the template's basic functionality relies | empty | optional | |
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
Localization
This template is localized through {{Autotranslate}}. The layout of the template can be found under Template:TemplateBox/layout.
To add your language to the list of languages supported by this template, please copy the code of Template:TemplateBox/en (or any other language version you prefer to translate) and replace the text strings in there (the form below can be used to create a translation, the English version is preloaded in the edit box). Please change the parameter lang from en (or whatever language you are translating) to the language code of your language.