Template:Tle

Template documentation[ view · edit · history · purge ]

This documentation is transcluded from Template:Tle/doc.

This documentation is unclear and probably inaccurate. It should be reviewed.

This template ({{Tle}}) allows to document different templates. To avoid confusion, when reading the following documentation, it is necessary to distinguish this template and its (meta-)parameters from the templates it documents and their parameters.

Uses Lua:

Module:Iteration

Displays Wikitext to invoke a template

Shows a synopsis or an example invocation for a template. The example or synopsis can use parameters of the documented templates, whether these are named or not.

Usage

Template parameters

Parameter	Description	Default	Status
`T`	Name of the template, which will be displayed as a link	`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)^{[Please clarify – October 2024]} (none for positional parameters)	empty	optional
`f`	Separator between parameters 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

Explanation

Wikimedia Commons has lots of other templates to document 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.

With neither T nor t the default template name will be Tle.

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

Examples

The {{Color}} template 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 synopsis 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 }}.

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 | SVG tool = Inkscape | W3C error count = 3 | Text as path = yes | Graphic Lab = de | Topic = structural formula }}

Style example

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

will display this description: