Vorlage:Tlx/doc

This is [[MediaWiki:Tagline]]. Set to <code>display:none</code> by chameleon skin.
Wechseln zu:Navigation, Suche

Basic use

(Note: In the following examples, ellipses (groups of three dots) indicate where parameters have been omitted.)

{{tlx|tl|first parameter|second parameter|third|…|tenth}} produces: {{tl|first parameter|second parameter|third|…|tenth}}

Where parameters might contain one or more equals-signs ("="), replace each equals-sign with {{}}:

{{tlx|tlx|first{{=}}something|second|third{{=}}something|...|tenth}} produces: {{tlx|first=something|second|third=something|...|tenth}}

For more than ten parameters, possibly also containing equals-signs, use <nowiki>...</nowiki> thus:

{{tlx|tlx|<nowiki>''first''|''second''|''third=something''|...|''999th''</nowiki>}} produces: {{tlx|first|second|third=something|...|999th}}

Purpose and naming

Mnemonically, "[t]emplate [l]ink e[x]panded" (after {{tl}}, "[t]emplate [l]ink").

This template allows an example of calling a template, accompanied by one or more parameters, to be displayed without also causing the template to be called.

Up to ten of the template's parameters (numbered or nowiki-keywords) may be displayed as placeholders, while more than over 10 parameters can be displayed using a coded vertical-bar (as in "&#124;…"). A keyword parameter can be used with equals code &#61; or {{=}} or in nowiki-text: "<nowiki>size=10</nowiki>" or all parameters as a string in "<nowiki>" tags; see Examples at bottom. For more details, see this talk page.

Exceptions

If the intended template lists numerous parameters, then perhaps this template should really not be used, and just hardcode the usage with <code><nowiki>. For example:

<code><nowiki>{{Anytemplate|arg1=23|size=250px|other parameters...}}</nowiki></code>.

If a vertical display, with parameters on their own lines, is desired, this can also be laid out manually in this manner, or more rapidly done with <pre>...</pre>.

Parameters

  • If the only parameter supplied is {{{1}}}, i.e. a template's name, {{tlx}}'s output is the same as {{tl}} i.e. a link within braces but in a monospaced font:
    • {{tl|tl}} produces: {{tl}}
    • {{tlx|tl}} produces: {{tl}}
{{tl}} will also not take nor display additional parameters.
Named parameters

|subst=

Setting this parameter to any non-blank value will prefix the string subst: linked to Help:Substitution. This is useful to indicate when a template should be substituted. For example, {{tlx|draft|subst=Y}} produces: {{subst:draft}}.

|SISTER=

For an interwiki link to other sister projects facilitating interwiki template documentation and/or discussion.

|LANG=

For a link to other languages facilitating cross-language template documentation and/or discussion.

Documentation

{{Tlx}} is a generalization of {{tl}}, {{tlp}} etc, with output that is arguably more legible. This depends on the browser, but narrow gaps between characters such as "{", "|", "}" and links can be hard to read when not monospaced.

Usage

{{tlx|Templatename}}
{{tlx|Templatename|param}}
{{tlx|Templatename|1|2|3|4|5|6|7|8|9|10}}
{{tlx|Templatename|1|2|3|4|5|6|7|8|9|10&#124;more}}
{{tlx|Templatename|param&#61;value}}

There are up to 10 placeholders for parameters of the specified template.

Examples

Note
At the en.wikipedia and Meta sites, X0, X1, X2, ... X9 are sandbox templates for experimentation on involved templates that need be in template space. An auto-cleansing software facility exists that might be used to duplicate the facility on other sister projects.
Code Result Remarks
{{tlx|x0}} {{x0}}  
{{tlx|Abc}} {{Abc}}  
{{tlx|ABC}} {{ABC}}  
{{tlx|AbC}} {{AbC}}  
{{tlx|x1|one}} {{x1|one}}  
{{tlx|x2|one|two}} {{x2|one|two}}  
{{tlx|x3|1|2|3|4|5|6|7|8|9|10}} {{x3|1|2|3|4|5|6|7|8}}  
{{tlx|x4|1|2|3|4|5|6|7|8|9|10|11}} {{x4|1|2|3|4|5|6|7|8}} up to 10 parameters...
{{tlx|x5|1|2|3|4|5|6|7|8|9|10&#124;11}} {{x5|1|2|3|4|5|6|7|8}}
...&#124; for more
{{tlx|x1|x=u}} {{x1}} the straightforward equals-sign won't work...
{{tlx|x1|x&#61;u}} {{x1|x=u}}
...but &#61; is okay
{{tlx|x1|x{{=}}u}} {{x1|x=u}}
...and {{=}} is okay
{{tlx|x1|<nowiki>x=u</nowiki>}} {{x1|x=u}}
sticky nowiki also okay
{{tlx|x2| |two}} {{x2||two}} empty won't work...
{{tlx|x2|&#32;|two}} {{x2| |two}}
...but &#32; is okay
{{tlx|x2|&nbsp;|two}} {{x2| |two}}
...&nbsp; is also okay
{{tlx|x2|<nowiki />|two}} {{x2||two}}
<nowiki /> handles the space
{{tlx|x2| &#124; two}} {{x2| | two}}
&#124; is okay
{{tlx|x2| {{!}} two}} {{x2| | two}}
{{!}} is dubious
{{tlx|x2|2=|3=two}} {{x2||two}} empty really doesn't work
{{tlx|x2|2=one|two}} {{x2|two}} "two" overrides "2=one"
{{tlx|x2|3=two|2=one}} {{x2|one|two}}
irregular parameter order is okay
Unlimited parameters as one <nowiki>...</nowiki> string
{{tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}

See also

  • {{para}}, for the presentation of template parameters and values (e.g. |paraname=val, |another=, etc).
  • {{tli}}, for linking modules via #invoke.

Template-linking templates

  • 1 {{tlg}} is the most general, allowing any combination of text style and/or link style options.
  • 2 Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.
  • 3 Uses monospace font but not <code>...</code>.