Quelltext der Seite Vorlage:Tlx/doc

<!--

--><noinclude>{{Documentation subpage}}{{clear}}</noinclude>
{{#ifeq:{{BASEPAGENAME}}|Tlx |{{High-use|}} }}

== Basic use ==
''(Note: In the following examples, [[wpen:Ellipsis|ellipses (groups of three dots)]] indicate where parameters have been omitted.)''

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

Where parameters might contain one or more equals-signs ("="), replace each equals-sign with {{tl|{{=}}}}:
: {{tlx{{\sandbox}}|tlx|tlx|''first''<nowiki>{{=}}</nowiki>''something''|''second''|''third''<nowiki>{{=}}</nowiki>''something''|...|tenth}} produces: {{tlx{{\sandbox}}|tlx|''first{{=}}something''|''second''|''third{{=}}something''|...|''tenth''}}

For more than ten parameters, possibly also containing equals-signs, use {{tag|nowiki}} thus:
: {{tlx{{\sandbox}}|tlx|tlx|&lt;nowiki><nowiki>''first''|''second''|''third=something''|...|''999th''</nowiki>&lt;/nowiki>}} produces: {{tlx{{\sandbox}}|tlx|<nowiki>first|second|third=something|...|999th</nowiki>}}

== Purpose and naming ==

[[Wikt:mnemonic|Mnemonically]], "[{{padlr|'''t'''}}]emplate [{{padlr|'''l'''}}]ink e['''x''']panded" (after {{tlpad|tl}}, "[{{padlr|'''t'''}}]emplate [{{padlr|'''l'''}}]ink").

This template allows an example of calling a template, accompanied by one or more parameters<!-- ("pass parameters", i.e. [[Help:Pipe trick|pipe-tricked]] [[m:Parameter#Parameters|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 "{{small|&amp;#124;}}…"). A keyword parameter can be used with equals code &amp;#61; or <nowiki>{{=}}</nowiki> or in nowiki-text: "{{tag|nowiki|content=size=10}}" or all parameters as a string in "{{tag|nowiki|o}}" tags; see ''[[#Examples|Examples]]'' at bottom. For more details, see [[wpen:{{TALKPAGENAME}}|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 {{tag|code|o}}{{tag|nowiki|o}}. For example:
: {{tag|code|content={{tag|nowiki|content=<nowiki>{{Anytemplate|arg1=23|size=250px|</nowiki><var>other parameters...</var><nowiki>}}</nowiki>}}}}.
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 {{tag|pre}}.

===Parameters===
* If the only parameter supplied is {{param|1}}, i.e. a template's name, {{tl|tlx}}'s output is the same as {{tl|tl}} i.e. a link within [[wpen:Braces (punctuation)|braces]] but in a [[wpen:monospaced font|monospaced font]]:
** {{tc|tl|tl}} produces: {{tl|tl}}
** {{tc|tlx|tl}} produces: {{tlx{{\sandbox}}|tl}}
: {{tl|tl}} will also not take nor display additional parameters.

; Named parameters
{{para|subst}}
: Setting this parameter to any non-blank value will prefix the string <code>subst:</code> linked to [[wpen:Help:Substitution|Help:Substitution]]. This is useful to indicate when a template should be substituted. For example, {{tlx{{\sandbox}}|tlx|draft|3=subst=Y}} produces: {{tlx{{\sandbox}}|draft|subst=Y}}.
{{para|SISTER}}
: For an interwiki link to other sister projects facilitating interwiki template documentation and/or discussion.
{{para|LANG}}
: For a link to other languages facilitating cross-language template documentation and/or discussion.

== Documentation ==

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

===Usage===
:<code>{&#123;tlx{{!}}Templatename&#125;}</code>
:<code>{&#123;tlx{{!}}Templatename{{!}}param&#125;}</code>
:<code>{&#123;tlx{{!}}Templatename{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10&#125;}</code>
:<code>{&#123;tlx{{!}}Templatename{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10&amp;#124;more&#125;}</code>
:<code>{&#123;tlx{{!}}Templatename{{!}}param&amp;#61;value&#125;}</code>
There are up to 10 placeholders for parameters of the specified template.

===Examples===
{{#switch:{{SITENAME}} |Wikipedia|Meta= |
; Note: At the en.wikipedia and Meta sites, '''X0, X1, X2,&nbsp;... 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.
}}

{{Aligned table |cols=3
 |class=wikitable |style=border:1;cellpadding:4;
 |row1style=background:whitesmoke;font-weight:bold;
 | Code                           | Result                             | Remarks
 | {{tlx|tlx|x0}}                 | {{tlc{{\sandbox}}|x0}}             | &#160;
 | {{tlx|tlx|Abc}}                | {{tlc{{\sandbox}}|Abc}}            | &#160;
 | {{tlx|tlx|ABC}}                | {{tlc{{\sandbox}}|ABC}}            | &#160;
 | {{tlx|tlx|AbC}}                | {{tlc{{\sandbox}}|AbC}}            | &#160;
 | {{tlx|tlx|x1|one}}             | {{tlc{{\sandbox}}|x1|one}}         | &#160;
 | {{tlx|tlx|x2|one|two}}         | {{tlc{{\sandbox}}|x2|one|two}}     | &#160;
 <!--(Parameter number:)-->
 | {{tlx|tlx|x3|1|2|3|4|5|6|7|8|9&#124;10}}             | {{tlc{{\sandbox}}|x3|1|2|3|4|5|6|7|8|9|10}}         | &#160;
 | {{tlx|tlx|x4|1|2|3|4|5|6|7|8|9&#124;10&#124;11}}     | {{tlc{{\sandbox}}|x4|1|2|3|4|5|6|7|8|9|10|11}}      | up to 10 parameters...
 | {{tlx|tlx|x5|1|2|3|4|5|6|7|8|9&#124;10&amp;#124;11}} | {{tlc{{\sandbox}}|x5|1|2|3|4|5|6|7|8|9|10&#124;11}} | {{align|right|...<code>&amp;#124;</code> for more}}
 <!--(Equals-sign:)-->
 | {{tlx|tlx|x1|x&#61;u}}              | {{tlc{{\sandbox}}|x1|x=u}}         | the straightforward equals-sign won't work...
 | {{tlx|tlx|x1|x&amp;#61;u}}          | {{tlc{{\sandbox}}|x1|x&#61;u}}     | {{align|right|...but <code>&amp;#61;</code> is okay}}
 | {{tlx|tlx|x1|x<nowiki>{{=}}</nowiki>u}} | {{tlc{{\sandbox}}|x1|x{{=}}u}} | {{align|right|...and <code><nowiki>{{=}}</nowiki></code> is okay}}
 | {{tlx|tlx|x1|&lt;nowiki&gt;x&#61;u&lt;/nowiki&gt;}} | {{tlc{{\sandbox}}|x1|<nowiki>x=u</nowiki>}} | {{align|right|sticky nowiki also okay}}
 <!--(Empty/space/pipe:)-->
 | {{tlx|tlx|x2|&#160;|two}}           | {{tlc{{\sandbox}}|x2| |two}}         | empty won't work...
 | {{tlx|tlx|x2|&amp;#32;|two}}        | {{tlc{{\sandbox}}|x2|&#32;|two}}     | {{align|right|...but <code>&amp;#32;</code> is okay}}
 | {{tlx|tlx|x2|&amp;nbsp;|two}}       | {{tlc{{\sandbox}}|x2|&nbsp;|two}}    | {{align|right|...<code>&amp;nbsp;</code> is also okay}}
 | {{tlx|tlx|x2|{{tag|nowiki|s}}|two}} | {{tlc{{\sandbox}}|x2|<nowiki/>|two}} | {{align|right|{{tag|nowiki|s}} handles the space}}
 | {{tlx|tlx|x2| &amp;#124; two}}      | {{tlc{{\sandbox}}|x2| &#124; two}}   | {{align|right|<code>&amp;#124;</code> is okay}}
 | {{tlx|tlx|x2| {&#123;!&#125;} two}} | {{tlc{{\sandbox}}|x2 | {{!}} two}}   | {{align|right|<nowiki>{{!}}</nowiki> is dubious}}

 | {{tlx|tlx|x2|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}} | {{tlc{{\sandbox}}|x2|2=|3=two}} | empty really doesn't work
 
 | {{tlx|tlx|x2|<nowiki>2=one</nowiki>|two}} | {{tlc{{\sandbox}}|x2|2=one|two}} | "two" overrides "2{{=}}one"

 | {{tlx|tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}} | {{tlc{{\sandbox}}|x2|3=two|2=one}} | {{align|right|irregular parameter order is okay}}
}}
; Unlimited parameters as one {{tag|nowiki}} string 
: {{tlx{{\sandbox}}|tlx|convert|<nowiki>&lt;nowiki>14|m|ftin|abbr=out|sp=us&lt;/nowiki></nowiki>}}

== See also ==

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

== Template-linking templates ==
{{Template-linking templates}}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |{{#ifeq:{{BASEPAGENAME}}|Tlx |
[[Category:Internal link templates]]

}} }}</includeonly>