Template:Tle/doc: Difference between revisions

Latest revision as of 19:56, 25 October 2024

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.

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:Tle.

العربية ∙ asturianu ∙ Boarisch ∙ беларуская (тарашкевіца) ∙ български ∙ বাংলা ∙ català ∙ čeština ∙ dansk ∙ Deutsch ∙ Zazaki ∙ Ελληνικά ∙ English ∙ Esperanto ∙ español ∙ eesti ∙ euskara ∙ فارسی ∙ suomi ∙ français ∙ galego ∙ עברית ∙ हिन्दी ∙ hrvatski ∙ magyar ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ ქართული ∙ 한국어 ∙ кыргызча ∙ Lëtzebuergesch ∙ македонски ∙ മലയാളം ∙ ဘာသာမန် ∙ Bahasa Melayu ∙ Mirandés ∙ မြန်မာဘာသာ ∙ norsk bokmål ∙ Plattdüütsch ∙ Nederlands ∙ norsk ∙ polski ∙ português ∙ português do Brasil ∙ русский ∙ sicilianu ∙ Scots ∙ slovenščina ∙ српски / srpski ∙ svenska ∙ ไทย ∙ Türkçe ∙ українська ∙ اردو ∙ oʻzbekcha / ўзбекча ∙ Tiếng Việt ∙ 中文 ∙ 中文（简体） ∙ 中文（繁體） ∙ 中文（臺灣） ∙ +/−

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

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

@@ Line 1: / Line 1: @@
 __NOTOC__
+{{Mbox
+ |text = This documentation is unclear and probably inaccurate. It should be reviewed. <!-- Chealer 2024-10 -->
+ |type = style
+}}
+{{Mbox
+ |text = This template ({{T|{{BASEPAGENAME}}}}) 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.
+ |type = content <!-- Would a different type be more appropriate? Chealer 2024-10 -->
+}}
 {{TemplateBox
 |1=T
-|1d=name of the template; Will be displayed as linkable item
+|1d=Name of the template, which will be displayed as a link
 |1def=<code>Tle</code>
 |1stat=optional
@@ Line 12: / Line 20: @@
 |3stat=optional-
 |4=p1&nbsp;…&nbsp;pn
-|4d=parameter name(s) &nbsp; <small>(none for positional parameters)</small>
+|4d=parameter name(s){{Clarify|date=October 2024}} &nbsp; <small>(none for positional parameters)</small>
 |4stat=optional-
 |5=f
-|5d=possible value to format the display - see [[#Format example]]
+|5d=Separator between parameters to format the display - see [[#Format example]]
 |5stat=optional-
 |6=number
@@ Line 28: / Line 36: @@
 |name=Tle
-|desc={{Lua|Module:Iteration}}<u>Meta template</u> for template description.
+|desc={{Lua|Module:Iteration}}Displays Wikitext to invoke a template
-{{Nobold|Describes and explanes template parametrizing.}}
+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.
 |i18n-desc=The template does not generate any localizable text.
 |namespace=template
@@ Line 39: / Line 47: @@
 }}
 == 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 templates to document 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.
 {{Tle}} describes each parameter as a meta-pair <code>|pn= |n= </code>, an ''optional'' meta-parameter p{{sub|1}}...p{{sub|n}} for the name and an ''optional'' unnamed meta-parameter for the value.<br>
@@ Line 61: / Line 67: @@
 The parameter <code>number</code> can be used to automatically set all position numbers where there is no parameter name.<br>
 Values can as well be empty – but it may ''not'' be a very useful template description to say nothing about a value.
+With neither <code>T</code> nor <code>t</code> the default template name will be <code>Tle</code>.
 === Restriction ===
@@ Line 70: / Line 78: @@
 === Problems with special characters ===
-When a parameter value starts wih either <code>#</code>, <code>*</code>, <code>:</code> or <code>;</code> it may cause problems when the system interprets it to make a new line or a list;<br>
+When a parameter value starts with either <code>#</code>, <code>*</code>, <code>:</code> or <code>;</code> it may cause problems when the system interprets it to make a new line or a list;<br>
 {{T|Tle}} uses {{M|Char|+}} for an ''automatic substitution'' of these characters;
 this can be avoided by using the Unicode notation,  replacing
@@ Line 80: / Line 88: @@
 == Examples ==
-The {{T1|Color|+|case=l}} has two unnamed parameters (1=''color'', 2=''text'') and three named parameters (bg, title and css). With <br>
+The {{T|Color}} template has two unnamed parameters (1=''color'', 2=''text'') and three named parameters (<code>bg</code>, <code>title</code> and <code>css</code>). With <br>
 <code><nowiki>{{Tle|T=color|text color|any text|p3=bg|background color|p4=title|tooltip text|p5=css|CSS attributes}}</nowiki></code><br>
-this description is made:  {{Tle|T=color|text color|any text|p3=bg|background color|p4=title|tooltip text|p5=css|CSS attributes}}
+this synopsis is made:  {{Tle|T=color|text color|any text|p3=bg|background color|p4=title|tooltip text|p5=css|CSS attributes}}
-<nowiki>{{Tle|t=C| | | | | | | | | }}</nowiki> will just display {{Tle|t=C| | | | | | | | | }}
+<code><nowiki>{{Tle|t=C| | | | | | | | | }}</nowiki></code> will just display {{Tle|t=C| | | | | | | | | }}.
 Without any meta-parameter, {{Tl|Tle|incl=0}} just shows the template name: {{Tle|T=clr}} or {{Tle|t=clr}}.<br>
-With neither <code>T</code> nor <code>t</code> the default template name will be <code>Tle</code>.
 === Format example ===