Template:Tle

{{ Tle }}

Template documentation[ view · edit · history · purge ]

This documentation is transcluded from Template:Tle/doc.

Meta template for template description.

Describes and explains template parametrizing.

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  … n	parameter value(s); may contain wiki syntax, if necessary		empty	optional
p1 … pn	parameter name(s)   (none for positional parameters)		empty	optional
f	possible value to format the display - see #Format example		empty	optional
number	any value: show the default numbers of positional parameters		empty	optional
kbd	any value: displays parameter names with fixed-pitch font		empty	optional
style	possible display style modification - see #Style example		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: Template editors

See also

{{Para}}

{{Showname}} to see all parameters and values of a template transclusion

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.

{{ Tle }} describes each parameter as a meta-pair |pn= |n= , an optional meta-parameter p₁...p_n 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 p_n.

To describe the parameters of template Tle, the following can be used:
{{ Tle | T = Tle | 1 = parm-value1 | 2 = parm-value2 | ... | 0n = parm-valuen0 | p1 = parm-name1 | p2 = parm-name2 | ... | pn = parm-name_n }}

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 }}

The parameter number can be used to automatically set all position numbers where there is no parameter name.
Values can as well be empty – but it may not be 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 its value; at least an empty value is necessary.
Because the check for a parameter name occurs only when there is a parameter value, superfluous names without values will be ignored:

{{Tle|t=m||||p3=parameter#3}} will give {{ M |   |   | parameter#3 =   }} 0 name and (empty) value for 3^rd parameter

{{Tle|t=m||||p4=superfluous}} will give {{ M |   |   |   }} 0 no value for the 4^th parameter exists - |p4 is ignored

Problems with special characters

When a parameter value starts with either #, *, : or ; it may cause problems when the system interprets it to make a new line or a list;
{{Tle}} uses Module:Char for an automatic substitution of these characters; this can be avoided by using the Unicode notation, replacing

# by #

* by *

: by :

; by &#59;

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.

Format example

The parameter f allows to format the display: its value precedes each parameter. The following example shows how this can be done with f=<br>{{0}}
{{ File generation description
0 | SVG tool = Inkscape
0 | W3C error count = 3
0 | Text as path = yes
0 | Graphic Lab = de
0 | Topic = structural formula }}

Style example

{{ Tle
0 | t = Template
0 | aaaa
0 | bbb.bbb.bbb.bbb
0 | cccccccccc
0 | p2 = param-B
0 | f = <br>{{0}}
0 | style = font-family:courier,monospace;font-style:normal;font-weight:normal;font-size:110%;color:#369
0 | style2 = font-family:condensed;font-weight:bold;font-size:112% }}

will display this description:

{{ Template
0 | aaaa
0 | param-B = bbb.bbb.bbb.bbb
0 | cccccccccc }}

Template links

List of templates using {{T/main}}

Code	Result	Notes	lock
{{T|example}}	{{Example}}	makes brackets part of the link; see docu
{{T0|example}}	Example	just link, without the brackets; see docu
{{T1|example}}	{{Example}}	inner brackets are part of the link; see docu
{{T2|example}}	{{Example}}	brackets are not a part of the link; see docu
{{Tl|example}}	{{Example}}	makes brackets around the link; see docu
{{Tls|example}}	{{subst:example}}	no parameters, adds "subst:"
Templates showing parameters 0 Meta template {{Tle}} is easiest to parametrize.
{{Tle|T=F|p1=1|v1|p2=2|v2|p3=3|v3}}	{{ F | 1 = v1 | 2 = v2 | 3 = v3 }}	decribes template parameters by names and values
{{Tlx|example|1|2|3|4|5||7|8|9}}	{{example|1|2|3|4|5|7|8|...}}	up to 8 parameters
{{Tlf|example|1|2|3|...up to 8}}	{{example|1|2|3|...up to 8}}	up to 8 parameters, no link; see docu
{{Tlc|example|1|2|3|4|||7|up to 8|9}}	{{example|1|2|3|4|||7|up to 8}}	up to 8 parameters, no link, <code> style
{{Tld|example|1|2||3||}}	{{example|1||2|3||}}	up to 8 parameters, <code> style; see docu
{{Tlr|User:Example}}	{{User:Example}}	like {{tl}} but for any namespace
{{Tlsu|User:Example}}	{{subst:User:Example}}	like {{tlr}}, but also adds "subst:"
Alternative forms 0 These ignore empty parameters.
{{Tlp|example|1|2|3|4|5||7|8|9}}	{{example|1|2|3|4|5|7|8}}	up to 8 parameters; ignores empty parms
{{Tl2|example|p1|p2}}	{{example|p1|p2}}	up to 2 parameters, <code> style; see docu
{{Tlsp|example|1|2|3|4|5|6|7|8|9}}	{{subst:example|1|2|3|4|5|6|7|8|...}}	up to 8 parameters, adds linked "subst:"; see doc
{{Tlsx|example|1|2|3|4|5|6|7|8|9}}	{{subst:example|1|2|3|4|5|...}}	up to 5 parameters, adds linked "subst:", <code> style

General-purpose formatting

Comparison of template-linking templates according to the styles of generated text and link produced

Text style ↓	{{tlg}} options to achieve text style	Link style
		Linked	Unlinked	Linked with subst	Unlinked with subst	Linked including braces
{{tlg}} options to achieve link style	N/A	DEFAULT	nolink=yes	subst=yes	nolink=yes|subst=yes	braceinside=yes
normal	DEFAULT	{{tlg}} {{T2}} {{tlx}} {{tlp|1|2|...}} {{Template:tlr}} {{Template:tlu}}	{{tlf}} <template link>	{{subst:tls}} {{subst:tlsp}} {{subst:Template:tlsu}}	N/A	{{T}}
code	code=yes	{{tl2}}	{{tlc}} <template link>	{{subst:tlsx}}	{{subst:tlsc}} <template link>	N/A
monospace	plaincode=yes	{{tld}}	N/A	{{subst:tltts}}	N/A	{{Tl}}
kbd	kbd=yes