Template:Tle/doc: Difference between revisions
More actions
format |
m format |
||
| Line 16: | Line 16: | ||
|name=Tle | |name=Tle | ||
|desc=Meta template for template description. | |desc=<u>Meta template</u> for template description. | ||
Describes<!-- and explanes--> template parameters | Describes<!-- and explanes--> template parameters | ||
|namespace=Template | |namespace=Template | ||
|i18n-desc=The template does not generate any localizable text. | |i18n-desc=The template does not generate any localizable text. | ||
Wikimedia Commons has lots of template templates, but non can really describe the parametrizing. | Wikimedia Commons has lots of '''template templates''', but non can really describe the parametrizing. | ||
|usergroup=all | |usergroup=all | ||
|usage-notes= | |usage-notes= | ||
|seealso= | |seealso= | ||
}} | }} | ||
== Explanation == | |||
It is necessary to distinct between a template and its parameter names and parameter values, and this meta-template with its meta-parameter-names and meta-parameter-values. | |||
In general, each parameter is described with a meta-pair <code>n= |pn= </code>, an unnamed meta-parameter for the value and (optional) its named meta-parameter p1...p9 for the name.<br> | |||
For unnamed parameters this name can be the number; if even that is not needed some or all named meta-parameters may dismiss. | |||
== Example == | == Example == | ||
After specifying the template name, ''its parameter values'' are specified with the unnamed parameters; ''its parameter names'' can be specified with | After specifying the template name, ''its parameter values'' are specified with the unnamed meta-parameters; ''its parameter names'' can be specified with the meta-parameters p1 to pn. | ||
To describe the parameters of template Tle, the following can be used:<br> | To describe the parameters of template <tt>Tle</tt>, the following can be used:<br> | ||
{{Tle|T=Tle|p1=T|template-name|parm-value1|parm-value2 | ...|parm-value{{Smallsub|n}}|p2=1|p3=2|p4=n | {{Tle|T=Tle|p1=T|template-name|parm-value1|parm-value2 | ...|parm-value{{Smallsub|n}}|p2=1|p3=2|p4=n | ||
|parm-name1|parm-name2 | ...|parm-name{{Smallsub|n}}|p5=p1|p6=p2|p7=p{{Smallsub|n}}}} | |parm-name1|parm-name2 | ...|parm-name{{Smallsub|n}}|p5=p1|p6=p2|p7=p{{Smallsub|n}}}} | ||
A template with only unnamed parameters e.g.<br> | A template with only unnamed parameters e.g.<br> | ||
{{Tle|t=example|parm-value1|parm-value2 | ...|parm-value{{Smallsub|n}} | {{Tle|t=example|p1=1|parm-value1|p2=2|parm-value2 | ...|p3=n|parm-value{{Smallsub|n}}}} | ||
or without the numbers<br> | or without the numbers<br> | ||
Revision as of 10:07, 26 February 2015
Meta template for template description. Describes template parameters
Usage
{{Tle}}
Template parameters
| Parameter | Description | Default | Status | |
|---|---|---|---|---|
t | name of the template. Will be displayed as plain text | Tle | optional | |
T | name of the template. Will be displayed as linkable item When parameter "T" is specified, an additional parameter "t" is ignored | empty | optional | |
1 … 9 | parameter value | empty | optional | |
p1 … p9 | parameter name | 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 == Localization ==
The template does not generate any localizable text.
Wikimedia Commons has lots of template templates, but non can really describe the parametrizing.
Explanation
It is necessary to distinct between a template and its parameter names and parameter values, and this meta-template with its meta-parameter-names and meta-parameter-values.
In general, each parameter is described with a meta-pair n= |pn= , an unnamed meta-parameter for the value and (optional) its named meta-parameter p1...p9 for the name.
For unnamed parameters this name can be the number; if even that is not needed some or all named meta-parameters may dismiss.
Example
After specifying the template name, its parameter values are specified with the unnamed meta-parameters; its parameter names can be specified with the meta-parameters p1 to pn.
To describe the parameters of template Tle, the following can be used:
{{ Tle | T = template-name | 1 = parm-value1 | 2 = parm-value2 | ... | n = parm-valuen | p1 = parm-name1 | p2 = parm-name2 | ... | pn = parm-namen }}
A template with only unnamed parameters e.g.
{{ Example | 1 = parm-value1 | 2 = parm-value2 | ... | n = parm-valuen }}
or without the numbers
{{ Example | parm-value1 | parm-value2 | ... | parm-valuen }}
{{Commons:Link templates/Template links}}