User:Patsagorn Y./sandbox 4
 | Uses Lua: |
 | This template uses TemplateStyles: |
The template provides a uniform way to provide basic information about the use of a template. See: Commons:Template documentation and Commons:TemplateData.
Usage
{{TemplateBox|1=|1d=|1d-td=|1type=|1def=|1stat=|name=|desc=|namespace=|usergroup=|placement=|usage-notes=|type=|example=|example-value=|i18n-method=|i18n-desc=|i18n-mediawiki-msg=|i18n-subpage=|seealso=|setscats=|print=|shorthand=|relieson=}}
Parameters
| Parameter name | Description | Default value | required or optional?
|
|---|---|---|---|
| parameter #1 (1) | parameter name (similarly 2, 3, …). Note that if all of the parameters beginning with a number are removed from the template, the usage notes will state "The template takes no parameters." | empty | optional |
| 1d | description of the parameter (similarly 2d, 3d, …) Template:TemplateBox/use suffix | empty | optional |
| 1d-td | description of the parameter (similarly 2d-td, 3d-td, …) for Extension:TemplateData which does not accept Wiki-markup. If this parameter is omitted, 1d is used. You can always override the defaults specifically for TemplateData by appending -td to the parameter-name. You can specify a language by appending your language-code. E.g. 3d-td-en would be the English translation of the description of parameter 3 which will be used in TemplateData. Template:TemplateBox/use suffix
|
empty | optional |
| 1label | A (very) brief name for the parameter. Try to keep under 20-ish characters. 1label-de would be the German translation of this label. Template:TemplateBox/use suffix | empty | optional |
| 1aliases | List of aliases. An alias is an alternative name for the parameter that may be used instead of (not in addition to) the primary name. Separate them by / (a slash) | empty | optional |
| 1type | The type of the parameter, for (soft) type hinting. Please refer to the list of possible values. | empty | optional |
| 1set | Label and ID of a set in one. Multiple parameters can be grouped in a set, if either none or all of them must be supplied. Try to keep under 20-ish characters. | empty | optional |
| 1def | default value for the parameter (similarly 2def, 3def, …) Template:TemplateBox/use suffix | empty | optional |
| 1stat | status of the parameter (similarly 2stat, 3stat, …); possible values:
|
optional | optional |
| useTemplateData | whether the template should expose TemplateData - omitting means "false", setting to 1, true or yes, "true". Setting to only will suppress the house-made table. Setting useTemplateData to export will turn TemplateBox into a preformatted Copy&Paste template. | empty | 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) | {{BASEPAGENAME}} | required |
| desc | description of what the template does Template:TemplateBox/use suffix | empty | required |
| namespace | namespaces, the template is intended to be used in; possible values:
Template:TemplateBox/doc/nslist Any other values will show as “unknown”. |
no namespace specified | required |
| usergroup | usergroup that is meant to use the template; possible values: Template:TemplateBox/doc/usergroup | 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). There is also example2 for a second example. | empty | optional |
| example-value | If there is more than one parameter you would like to show or if there are named parameters, use: Template:TemplateBox/doc/example-value | 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 |
| i18n-subpage | i18n | 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) | empty | optional |
| The way the parameters are typically arranged (horizontally or vertically). Possible values: multi - parameters arranged in multiple lines; one - one line; infobox - multiple lines and space padding in front of the =. | one (if type param ≠ infobox) | optional | |
| lines | Use parameter print instead. | empty | optional |
| shorthand | shorthand for easy use (redirects to main template). See examples here and here of lists of redirects, and searches for more. | 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
Relies on:
Module:TemplateBox, Module:Languages
See also
About: TemplateData
{{Commons:TemplateData}}
Complications
( NOTE : the {{sed|1}} template links appears HERE : >>> )
A complication is that the template suppresses section editing links on the whole page of the documented template, and also on its documentation page, even for paragraphs outside the part produced by this template TemplateBox. Template:Sed can be used (as is done here) to create an edit link anyway.