Editing Template:Tlx/doc

<includeonly>{{small |1=''This documentation for {{tlx|tlx}} is also [[w:Wikipedia:Template doc page pattern|transcluded]] by its derivatives {{tlx|tlxb}}, {{tlx|tlxc}}, {{tlx|tlxw}}, {{tlx|tlxU}} ([<span class="plainlinks">[{{fullurl:Template:Tlx/doc |action=edit}} edit]</span>]{{#ifeq:{{SITENAME}}|Meta |). |{{dot}}[[M:template:{{PAGENAMEE}}|master page]]).}}<!--(end small:)-->}}</includeonly><!--

--><noinclude>{{Documentation subpage}}{{clear}}</noinclude>
{{High-use|850,000+}}

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

: {{tlx |tlx|Template|''first parameter''|''second parameter''|''third''|...|''tenth''}} <!--
    -->{{bigger|→}} {{tlx |Template|''first parameter''|''second parameter''|''third''|...|''tenth''}}

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

For more than ten parameters, possibly also containing equals-signs, use:
: {{tlx |tlx|Template|&lt;nowiki><nowiki>''first''|''second''|''third=something''|...|''999th''</nowiki>&lt;/nowiki>}} <!--
    -->{{bigger|→}} {{Tlx|Template|<nowiki>first|second|third=something|...|999th</nowiki>}}

== Purpose and naming ==

[[Wikt:mnemonic|Mnemonically]], "['''t''']emplate ['''l''']ink e['''x''']panded" (after <code>{{tlx|tl}}</code>, "['''t''']emplate ['''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;</small>''...''"). 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 [[{{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 given no additional parameters except ''<code>&nbsp;'template&nbsp;name'&nbsp;(<nowiki>{{{1}}}</nowiki>), </code>''&nbsp;it presents the same as the similar {{tl|Tl}} [[Macro (computer science)|macro]] template -- a blue link nested in [[brackets|curly-braces]]-- the same as a user would apply the template without parameters, but with a noticeably clearer font and spacing on most modern browsers. 
** {{Tlx|Tl|Tl}} display compared to {{Tlx|Tlx|Tl}}: (Tl: {{Tl|Tl}} versus Tlx: {{Tlx|Tl}}) 
* Comparatively, {{Tlx|Tl}} will not take or display additional parameters, and for minor technical reasons, may be preferred for mere listing and referencing in long pages involving a lot of template expansions.
* {{tlx|Tlx}} has a named parameter {{para|subst}}. Setting this parameter to any non-blank value will place the string "<code>subst:</code>" before the template name, linked to [[Help:Substitution]]. This is useful to indicate when a template should be substituted. For example {{tlx|Tlx|Welcome|3=subst=Y}} will display {{Tlx|Welcome|subst=Y}}. This is similar to the action of the {{tlx|tlxs}} template: {{tlx|Tlxs|Welcome}} will display {{Tlxs|Welcome}}.
* Additionally, Tlx will take a named parameter {{para|SISTER}} to link interwiki to [[H:IW|other sister projects]] such as one of these examples: {{para|SISTER|M:}} ([[m:|Meta]]), {{para|SISTER|Q:}} ([[q:|WikiQuote]]), {{para|SISTER|S:}} ([[s:|WikiSource]]), etc. allowing documentation or discourse about a template across interwiki boundaries.
* Tlx will also take a named parameter {{para|LANG}} to link to [[H:ILL|other language Wikipedias]], such as one of these examples: {{para|LANG|de:}} ([[:de:|German]]), {{para|LANG|sv:}} ([[:sv:|Swedish]]), etc. allowing documentation or discourse about a template across language boundaries.

== Documentation ==

{{tlx|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}}'", "{{thinsp}}'''|'''{{thinsp}}", "{{thinsp}}'''}'''{{thinsp}}" and links can be hard to read when not monospaced (and hard to click on; for uses like <code><nowiki>{{!}}</nowiki></code>, see {{tlx|tln}}, which makes the click target bigger).

===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}}                 | {{tlx|x0}}             | &#160;
 | {{tlx|tlx|Abc}}                | {{tlx|Abc}}            | &#160;
 | {{tlx|tlx|ABC}}                | {{tlx|ABC}}            | &#160;
 | {{tlx|tlx|AbC}}                | {{tlx|AbC}}            | &#160;
 | {{tlx|tlx|x1|one}}             | {{tlx|x1|one}}         | &#160;
 | {{tlx|tlx|x2|one|two}}         | {{tlx|x2|one|two}}     | &#160;
 <!--(Parameter number:)-->
 | {{tlx|tlx|x3|1|2|3|4|5|6|7|8|9&#124;10}}             | {{tlx|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}}     | {{tlx|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}} | {{tlx|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}}              | {{tlx|x1|x=u}}         | the straightforward equals-sign won't work...
 | {{tlx|tlx|x1|x&amp;#61;u}}          | {{tlx|x1|x&#61;u}}     | {{align|right|...but <code>&amp;#61;</code> is okay}}
 | {{tlx|tlx|x1|x<nowiki>{{=}}</nowiki>u}} | {{tlx|x1|x{{=}}u}} | {{align|right|...and <code><nowiki>{{=}}</nowiki></code> is okay}}
 | {{tlx|tlx|x1|&lt;nowiki&gt;x&#61;u&lt;/nowiki&gt;}} | {{tlx|x1|<nowiki>x=u</nowiki>}} | {{align|right|sticky nowiki also okay}}
 <!--(Empty/space/pipe:)-->
 | {{tlx|tlx|x2|&#160;|two}}           | {{tlx|x2| |two}}         | empty won't work...
 | {{tlx|tlx|x2|&amp;#32;|two}}        | {{tlx|x2|&#32;|two}}     | {{align|right|...but <code>&amp;#32;</code> is okay}}
 | {{tlx|tlx|x2|&amp;nbsp;|two}}       | {{tlx|x2|&nbsp;|two}}    | {{align|right|...<code>&amp;nbsp;</code> is also okay}}
 | {{tlx|tlx|x2|{{tag|nowiki|s}}|two}} | {{tlx|x2|<nowiki/>|two}} | {{align|right|{{tag|nowiki|s}} handles the space}}
 | {{tlx|tlx|x2| &amp;#124; two}}      | {{tlx|x2| &#124; two}}   | {{align|right|<code>&amp;#124;</code> is okay}}
 | {{tlx|tlx|x2| {&#123;!&#125;} two}} | {{tlx|x2 | {{!}} two}}   | {{align|right|{{tlx|!}} is dubious}}

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

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

== See also ==
* [[Template:Tlxb]], a version of {{tlspc|tlx}} where the template name is shown in bold.
*: [[Template:Tlb]], a version of {{tlspc|tl}} where the template name is shown in bold.
* [[Template:Temt]], a version of {{tlspc|tlx}} that handles templates whose names include "Template:" and pages outside the Template: [[Wikipedia:Namespace|namespace]] that are treated as templates.
* [[Template:Para]], for the presentation of template parameters and values (e.g. {{para|paraname|val}}, {{para|another}}, etc).

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

<includeonly> 
{{#ifeq:{{SUBPAGENAME}}|sandbox |
 | {{#ifeq:{{BASEPAGENAME}}|Tlx
    | [[Category:Internal template-link templates]]
      [[Category:Interwiki link templates]]
      [[Category:Typing-aid templates]]
}} }}

[[de:Vorlage:Vorlage]]
</includeonly>