Template:TemplateBox/doc: Difference between revisions
Template page
More actions
autotranslatable |
No edit summary |
||
| Line 1: | Line 1: | ||
{{TemplateBox | {{TemplateBox | ||
|1|1d=parameter name (up to 20, 1, 2, ...)|1d|2d=description of the parameter (up to 20, 1d, 2d, ...)|1def|3d=default value for the first specified parameter (1def, 2def, ..., 20def)|1stat|4d=status of the parameter (required, optional, optional- [optional and not present in the standard form], deprecated)|name|5d=name of the template|desc|6d=description of what the template does|namespace|7d=namespaces, the template is intended to use in|usergroup|8d=usergroup that is meant to use the template|usage-notes| | |1|1d=parameter name (up to 20, 1, 2, ...)|1d|2d=description of the parameter (up to 20, 1d, 2d, ...)|1def|3d=default value for the first specified parameter (1def, 2def, ..., 20def)|1stat|4d=status of the parameter (required, optional, optional- [optional and not present in the standard form], deprecated)|name|5d=name of the template|desc|6d=description of what the template does|namespace|7d=namespaces, the template is intended to use in|usergroup|8d=usergroup that is meant to use the template|placement|9d=placement on the page|usage-notes|10d=notes about the correct usage of the template|type|11d=what type is the template (infobox, formatting, licence tag, ...)|example|12d=example use (just write down the parameters, separated by <nowiki>{{!}}</nowiki>)|i18n-method|13d=method the localization is achieved by (known values: 'autotranslate' [using [[Template:Autotranslate|autotranslate]]], 'switch' [using a switch tag in the template itself], '-' [no localization needed])|i18n-desc|14d=additional info about the localization|seealso|15d=relevant links (put in a list of them)|setscats|16d=what categories are automatically set by the template (put in a linked list of them)|lines|17d=are the parameters typically put into new lines or all on one line ("multi": multiple lines, "one": one line)|shorthand|18d=shorthand for easy use (redirects to main template)|relieson|19d=list of templates on which the template's basic functionality relies | ||
|name=TemplateBox | |name=TemplateBox | ||
|desc=The template provides a uniform way to provide basic information about the use of a template. | |desc=The template provides a uniform way to provide basic information about the use of a template. | ||
|namespace=Template | |namespace=Template | ||
|usergroup=all | |usergroup=all | ||
|placement=in the '/doc' subpage of a template | |||
|type=infobox | |type=infobox | ||
|example= | |example= | ||
Revision as of 16:00, 22 April 2009
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 =
|seealso =
|setscats =
|lines =
|shorthand =
|relieson =
}}
Template parameters
| Parameter | Description | Default | Status | |
|---|---|---|---|---|
1 | parameter name (up to 20, 1, 2, ...) | empty | optional | |
1d | description of the parameter (up to 20, 1d, 2d, ...) | empty | optional | |
1def | default value for the first specified parameter (1def, 2def, ..., 20def) | empty | optional | |
1stat | status of the parameter (required, optional, optional- [optional and not present in the standard form], deprecated) | 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 | 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 (just write down the parameters, separated by {{!}}) | empty | optional | |
i18n-method | method the localization is achieved by (known values: 'autotranslate' [using autotranslate], 'switch' [using a switch tag in the template itself], '-' [no localization needed]) | empty | optional | |
i18n-desc | additional info about the localization | 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 ("multi": multiple lines, "one": one line) | 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.