Template:Tle/doc: Difference between revisions
More actions
m format |
m format |
||
| Line 29: | Line 29: | ||
Wikimedia Commons has lots of other '''template templates''', but none is really able to describe complicated parametrizing easily. | Wikimedia Commons has lots of other '''template templates''', but none is really able to describe complicated parametrizing easily. | ||
In general, each parameter is described with a meta-pair <code>|pn= |n= </code>, an ''optional'' meta-parameter p1... | In general, each parameter is described with a meta-pair <code>|pn= |n= </code>, an ''optional'' meta-parameter p1...p25 for the name and an ''optional'' unnamed meta-parameter for the value.<br> | ||
For unnamed parameters this name can be the number; if even that is not needed, some or all meta-parameter | For unnamed parameters this name can be the number; if even that is not needed, some or all meta-parameter ''names'' may dismiss. | ||
== How to use == | == How to use == | ||
| Line 36: | Line 36: | ||
To describe the parameters of template <tt>Tle</tt>, 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| | {{Tle|T=Tle|p1=T|Tle|parm-value1|parm-value2 | ...|parm-value{{Smallsub|n}}{{0}}|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={{0}}p1|p6=p2|p7=p{{Smallsub|n}}}} | ||
A template with only unnamed parameters may look like e.g.<br> | A template with only unnamed parameters may look like e.g.<br> | ||
| Line 48: | Line 48: | ||
=== Restriction === | === Restriction === | ||
While the values can be specified without names, it makes no sense to specify a name without his value; at least an empty value is necessary. | While the '''values''' can be specified without names, it makes no sense to specify a '''name''' without his value; at least an empty value is necessary.<br> | ||
Superfluous names without values will be ignored: | Superfluous names without values will be ignored: | ||
:<tt><nowiki>{{Tle|t=m||||p3=parameter#3}}</nowiki></tt> will give {{Tle|t=m||||p3=parameter#3}} | :<tt><nowiki>{{Tle|t=m||||p3=parameter#3}}</nowiki></tt> will give {{Tle|t=m||||p3=parameter#3}} | ||
Revision as of 17:34, 29 June 2019
Meta template for template description. Describes template parameters
Usage
{{Tle |T= }}
Template parameters
| Parameter | Description | Default | Status | |
|---|---|---|---|---|
T | name of the template; Will be displayed as linkable item | Tle | optional | |
t | name of the template; Will be displayed as plain text When parameter "T" is specified, an additional parameter "t" is ignored | empty | optional | |
1 … 25 | parameter value; may contain wiki syntax, if necessary | empty | optional | |
p1 … p25 | parameter name | empty | optional | |
Additional information
The template is intended to be used in the following namespaces: all namespaces
The template is intended to be used by the following user groups: all users == Localization ==
The template does not generate any localizable text.
Explanation
It is necessary to distinguish between a template and its parameter names and parameter values, and this meta-template with its meta-parameter-names and meta-parameter-values.
Wikimedia Commons has lots of other template templates, but none is really able to describe complicated parametrizing easily.
In general, each parameter is described with a meta-pair |pn= |n= , an optional meta-parameter p1...p25 for the name and an optional unnamed meta-parameter for the value.
For unnamed parameters this name can be the number; if even that is not needed, some or all meta-parameter names may dismiss.
How to use
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 = Tle | 1 = parm-value1 | 2 = parm-value2 | ... | n = parm-valuen | p1 = parm-name1 | p2 = parm-name2 | ... | pn = parm-namen }}
A template with only unnamed parameters may look like e.g.
{{ Example | 1 = parm-value1 | 2 = parm-value2 | ... | n = parm-valuen }}
or without the numbers
{{ Example | parm-value1 | parm-value2 | ... | parm-valuen }}
Values can as well be empty - even if it is not a very useful template description to say nothing about a value.
Restriction
While the values can be specified without names, it makes no sense to specify a name without his value; at least an empty value is necessary.
Superfluous names without values will be ignored:
- {{Tle|t=m||||p3=parameter#3}} will give {{ M | parameter#3 = }}
- {{Tle|t=m||||p4=superfluous}} will give {{ M }}
Examples
The template:{{Color}} has two unnamed parameters (1=color, 2=text) and three named parameters (bg, title and css). With
{{Tle|T=color|text color|any text|p3=bg|background color|p4=title|tooltip text|p5=css|CSS attributes}}
this description is made: {{ Color | text color | any text | bg = background color | title = tooltip text | css = CSS attributes }}
{{Tle|t=C| | | | | | | | | }} will just display {{ C }}
Without any meta-parameter, {{Tle}} just shows the template name: {{ Clr }} or {{ Clr }}.
With neither T nor t the default template name will be Tle.
{{Commons:Link templates/Template links}}