Teamplaid:TemplateBox/documentation
 | This is a documentation subpage for . It contains usage information, categories and other content that is not part of the original teamplaid page. |
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=
}}
Parameters
| Parameter name | Description | Default value | required or optional?
|
|---|---|---|---|
| parameter #1 (1) | parameter name (similarly 2, 3, .., up to 24) | empty | optional |
| 1d | description of the parameter (similarly 2d, 3d, .., up to 24d) | empty | optional |
| 1def | default value for the parameter (similarly 2def, 3def, .., up to 24def) | empty | optional |
| 1stat | status of the parameter (similarly 2stat, 3stat, .., up to 24stat); possible values:
|
optional | optional |
| 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) | {{PAGENAME}} | required |
| desc | description of what the template does | empty | required |
| namespace | namespaces, the template is intended to be used in; possible values:
Any other values will show as “unknown”. |
no namespace specified | required |
| usergroup | usergroup that is meant to use the template; possible values:
|
no user group specified | 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:
|
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 Teamplaid:TemplateBox/layout.
To add your language to the list of languages supported by this template, please copy the code of Teamplaid: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.
Complications
Beurla
cànan Baidhearn
Gearmailtis
Portagailis