1,964
edits
Changes
Documentation yay
<includeonly><!-----------------Interwiki Doc page pattern------------------->
<small>''This '{{tlx|tlx}}' template documentation is [http://en.wikipedia.org/wiki/w:Wikipedia:Template doc page pattern transcluded] for all ''tlx family templates (tlx, tlxc, tlxw, tlxb)'' [<span class="plainlinks">[{{fullurl:Template:tlx/doc |action=edit}} edit]</span>].{{#ifeq:{{SITENAME}}|Meta| |[http://en.wikipedia.org/wiki/M:template:{{PAGENAMEE}} Masterpage]
}}</small></includeonly><noinclude>
{{Documentation subpage}}
{{-}}
</noinclude>
<!-- Parent template(s) usage begins: --->
: {{tlx|tlx|Template|first parameter|second|third|...|tenth}} → {{tlx|Template|first parameter|second|third|...|tenth}}
: {{tlx|tlx|Template|3=2=first parameter|4=3=second|5=4=third|6=5=...|7=11=tenth}} → {{tlx|Template|2=first parameter|3=second|4=third|5=...|11=tenth}} if they might contain "=" signs.
: {{tlx|tlx|Template|<nowiki>first|second|...|999th</nowiki>}} → {{tlx|Template|<nowiki>first|second|...|999th</nowiki>}} (for more than 10 parameters)
== Purpose and naming ==
[http://en.wiktionary.org/wiki/mnemonic Mnemonically]] ''''T'''emplate '''l'''ink e'''x'''panded'. After <tt>{{tlx|Tl}}</tt> ''''T'''emplate '''l'''ink'.
* This template takes another ''template-name'' and some associated [http://en.wikipedia.org/wiki/Help:Pipe trick pipe-tricked] [http://en.wikipedia.org/wiki/m:Parameter#Parameters (numbered) parameters] (or 'pass parameters'), and displays them as an 'example demonstration' of how the ''template-name'' template could be coded, literally. Its primary use is in instruction and documentation.
* '''''Specifics:''''' Up to 10 pass parameters (numbered or nowiki-keywords) for the specified template are displayed as 'placeholders', and over 10 parameters can be displayed using a coded vertical-bar (as in "<small>&#124;</small>''...''"). A keyword parameter can be used with equals code &#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 ''[http://en.wikipedia.org/wiki/#Examples Examples]'' at bottom.
* '''''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}}.
----
* If given no additional parameters except ''<code> 'template name' (<nowiki>{{{1}}}</nowiki>), </code>'' it presents the same as the similar {{tl|Tl}} [http://en.wikipedia.org/wiki/Macro (computer science) macro] template -- a blue link nested in [http://en.wikipedia.org/wiki/brackets curly-braces]-- the same as a user would apply the template without parameters, but with a noticably 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 ''subst''. Setting this parameter to any string of length 1 or greater will place the string "subst:" before the template name, linked to [http://en.wikipedia.org/wiki/Help:Substitution Help:Substitution]. This is useful to indicate when a template should be substituted. For example {{tlx|tlx|Welcome|<nowiki>subst=Y</nowiki>}} will display {{tlx|Welcome|subst=Y}}.
* Additionally, tlx will take a 'named' parameter 'SISTER' to link interwiki to other sister projects such as one of these examples: '|SISTER=W:', 'tlx|SISTER=M:', 'tlx|SISTER=Q:', 'tlx|SISTER=S:', allowing documentation or discourse about a template across interwiki boundaries.
== Documentation ==
{{[http://en.wikipedia.org/wiki/Template:{{BASEPAGENAME}} {{BASEPAGENAME}}]}}
is a generalization of {{Tl|Tl|x}}, {{Tl|Tlp|x|y}},
etcetera with arguably better readable
output. This depends on the browser, but too narrow
uses of "'''{'''", "'''|'''", "'''}'''" in conjunction
with links can be hard to read.
=== Usage ===
:<tt>{{{{BASEPAGENAME}}{{!}}template name}}</tt>
:<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}param}}</tt>
:<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10}}</tt>
:<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10&#124;more}}</tt>
:<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}param&#61;value}}</tt>
''Up to 10 placeholders for parameters of the specified template''
=== Examples ===
{{#ifeq:{{SITENAME}}|Wikipedia|<!-- Skip message--->|
{{#ifeq:{{SITENAME}}|Meta|<!-- No note needed --->|<!-- Other Sisters Note: --->
;Note: On the source sister projects, en.wikipedia and Meta, '''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.
}}}}
{| border="1" cellpadding="4" class="wikitable"
! Code
! Result
! Remark
|-
|{{tlx|tlx|x0}}
|{{tlx|x0}}
|| 
|-
|{{tlx|tlx|Abc}}
|{{tlx|Abc}}
|| 
|-
|{{tlx|tlx|ABC}}
|{{tlx|ABC}}
|| 
|-
|{{tlx|tlx|AbC}}
|{{tlx|AbC}}
|| 
|-
|{{tlx|tlx|x1|one}}
|{{tlx|x1|one}}
|| 
|-
|{{tlx|tlx|x2|one|two}}
|{{tlx|x2|one|two}}
|| 
|-
|{{tlx|tlx|x3|1|2|3|4|5|6|7|8|9|10}}
|{{tlx|x3|1|2|3|4|5|6|7|8|9|10}}
|| 
|-
|{{tlx|tlx|x4|1|2|3|4|5|6|7|8|9|10|11}}
|{{tlx|x4|1|2|3|4|5|6|7|8|9|10|11}}
|up to 10 parameters, then ...
|-
|{{tlx|tlx|x5|1|2|3|4|5|6|7|8|9|10&#124;11}}
|{{tlx|x5|1|2|3|4|5|6|7|8|9|10|11}}
|align="right"|<tt>&#124;</tt> for more
|-
|colspan=2| {{tlx|tlx|convert|<nowiki><nowiki>14|m|ftin|abbr=out|sp=us</nowiki></nowiki>}}
|unlimited parameters as one nowiki string
|-
|{{tlx|tlx|x1|x=u}}
|{{tlx|x1|x=u}}
|'''=''' won't work
|-
|{{tlx|tlx|x1|x&#61;u}}
|{{tlx|x1|x=u}}
|align="right"|<tt>&#61;</tt> is okay
|-
|{{tlx|tlx|x1|x<nowiki>{{=}}</nowiki>u}}
|{{tlx|x1|x{{=}}u}}
|align="right"|<tt><nowiki>{{=}}</nowiki></tt> is okay
|-
|{{tlx|tlx|x1|<nowiki>x=u</nowiki>}}
|{{tlx|x1|<nowiki>x=u</nowiki>}}
|align="right"|sticky nowiki is okay
|-
|{{tlx|tlx|x2| |two}}
|{{tlx|x2| |two}}
|empty won't work
|-
|{{tlx|tlx|x2|&#32;|two}}
|{{tlx|x2| |two}}
|align="right"|<tt>&#32;</tt> is okay
|-
|{{tlx|tlx|x2|&nbsp;|two}}
|{{tlx|x2| |two}}
|align="right"|<tt>&nbsp;</tt> is okay
|-
|{{tlx|tlx|x2| &#124; two}}
|{{tlx|x2| | two}}
|align="right"|<tt>&#124;</tt> is okay
|-
|| {{tlx|tlx|x2| {{!}} 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''' clobbers '''2=one'''
|-
|| {{tlx|tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}}
|| {{tlx|x2|3=two|2=one}}
|align="right"|right to left okay
|}
== See also ==
* [http://en.wikipedia.org/wiki/Template:tlxb Template:tlxb] – same as {{tl|tlx}}, but gives the template name in boldface type (this can be useful when stressing the difference between two similarly named templates). [http://en.wikipedia.org/wiki/Template:Tlb Template:Tlb] is the same, except it uses regular text instead of a monospaced non-proportional font.
* [http://en.wikipedia.org/wiki/Template:Temt Template:Temt], – same as {{tl|tlx}}, but handles template names with the Template: prefix and templates not in the [http://en.wikipedia.org/wiki/Wikipedia:Namespace Template: namespace] <nowiki>{{ns:10}}</nowiki>.
* [http://en.wikipedia.org/wiki/Template:Para Template:Para] – for giving examples of template parameters and values only, instead of entire templates with parameters.
{{tl-nav}}
<!--- Categories applied to both /doc style Documentation page and to the parent templates --->
<!-- Add the Categories for this doc or usage page (only-- not for the calling template) BELOW THIS LINE --->
tt>{
<small>''This '{{tlx|tlx}}' template documentation is [http://en.wikipedia.org/wiki/w:Wikipedia:Template doc page pattern transcluded] for all ''tlx family templates (tlx, tlxc, tlxw, tlxb)'' [<span class="plainlinks">[{{fullurl:Template:tlx/doc |action=edit}} edit]</span>].{{#ifeq:{{SITENAME}}|Meta| |[http://en.wikipedia.org/wiki/M:template:{{PAGENAMEE}} Masterpage]
}}</small></includeonly><noinclude>
{{Documentation subpage}}
{{-}}
</noinclude>
<!-- Parent template(s) usage begins: --->
: {{tlx|tlx|Template|first parameter|second|third|...|tenth}} → {{tlx|Template|first parameter|second|third|...|tenth}}
: {{tlx|tlx|Template|3=2=first parameter|4=3=second|5=4=third|6=5=...|7=11=tenth}} → {{tlx|Template|2=first parameter|3=second|4=third|5=...|11=tenth}} if they might contain "=" signs.
: {{tlx|tlx|Template|<nowiki>first|second|...|999th</nowiki>}} → {{tlx|Template|<nowiki>first|second|...|999th</nowiki>}} (for more than 10 parameters)
== Purpose and naming ==
[http://en.wiktionary.org/wiki/mnemonic Mnemonically]] ''''T'''emplate '''l'''ink e'''x'''panded'. After <tt>{{tlx|Tl}}</tt> ''''T'''emplate '''l'''ink'.
* This template takes another ''template-name'' and some associated [http://en.wikipedia.org/wiki/Help:Pipe trick pipe-tricked] [http://en.wikipedia.org/wiki/m:Parameter#Parameters (numbered) parameters] (or 'pass parameters'), and displays them as an 'example demonstration' of how the ''template-name'' template could be coded, literally. Its primary use is in instruction and documentation.
* '''''Specifics:''''' Up to 10 pass parameters (numbered or nowiki-keywords) for the specified template are displayed as 'placeholders', and over 10 parameters can be displayed using a coded vertical-bar (as in "<small>&#124;</small>''...''"). A keyword parameter can be used with equals code &#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 ''[http://en.wikipedia.org/wiki/#Examples Examples]'' at bottom.
* '''''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}}.
----
* If given no additional parameters except ''<code> 'template name' (<nowiki>{{{1}}}</nowiki>), </code>'' it presents the same as the similar {{tl|Tl}} [http://en.wikipedia.org/wiki/Macro (computer science) macro] template -- a blue link nested in [http://en.wikipedia.org/wiki/brackets curly-braces]-- the same as a user would apply the template without parameters, but with a noticably 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 ''subst''. Setting this parameter to any string of length 1 or greater will place the string "subst:" before the template name, linked to [http://en.wikipedia.org/wiki/Help:Substitution Help:Substitution]. This is useful to indicate when a template should be substituted. For example {{tlx|tlx|Welcome|<nowiki>subst=Y</nowiki>}} will display {{tlx|Welcome|subst=Y}}.
* Additionally, tlx will take a 'named' parameter 'SISTER' to link interwiki to other sister projects such as one of these examples: '|SISTER=W:', 'tlx|SISTER=M:', 'tlx|SISTER=Q:', 'tlx|SISTER=S:', allowing documentation or discourse about a template across interwiki boundaries.
== Documentation ==
{{[http://en.wikipedia.org/wiki/Template:{{BASEPAGENAME}} {{BASEPAGENAME}}]}}
is a generalization of {{Tl|Tl|x}}, {{Tl|Tlp|x|y}},
etcetera with arguably better readable
output. This depends on the browser, but too narrow
uses of "'''{'''", "'''|'''", "'''}'''" in conjunction
with links can be hard to read.
=== Usage ===
:<tt>{{{{BASEPAGENAME}}{{!}}template name}}</tt>
:<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}param}}</tt>
:<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10}}</tt>
:<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10&#124;more}}</tt>
:<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}param&#61;value}}</tt>
''Up to 10 placeholders for parameters of the specified template''
=== Examples ===
{{#ifeq:{{SITENAME}}|Wikipedia|<!-- Skip message--->|
{{#ifeq:{{SITENAME}}|Meta|<!-- No note needed --->|<!-- Other Sisters Note: --->
;Note: On the source sister projects, en.wikipedia and Meta, '''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.
}}}}
{| border="1" cellpadding="4" class="wikitable"
! Code
! Result
! Remark
|-
|{{tlx|tlx|x0}}
|{{tlx|x0}}
|| 
|-
|{{tlx|tlx|Abc}}
|{{tlx|Abc}}
|| 
|-
|{{tlx|tlx|ABC}}
|{{tlx|ABC}}
|| 
|-
|{{tlx|tlx|AbC}}
|{{tlx|AbC}}
|| 
|-
|{{tlx|tlx|x1|one}}
|{{tlx|x1|one}}
|| 
|-
|{{tlx|tlx|x2|one|two}}
|{{tlx|x2|one|two}}
|| 
|-
|{{tlx|tlx|x3|1|2|3|4|5|6|7|8|9|10}}
|{{tlx|x3|1|2|3|4|5|6|7|8|9|10}}
|| 
|-
|{{tlx|tlx|x4|1|2|3|4|5|6|7|8|9|10|11}}
|{{tlx|x4|1|2|3|4|5|6|7|8|9|10|11}}
|up to 10 parameters, then ...
|-
|{{tlx|tlx|x5|1|2|3|4|5|6|7|8|9|10&#124;11}}
|{{tlx|x5|1|2|3|4|5|6|7|8|9|10|11}}
|align="right"|<tt>&#124;</tt> for more
|-
|colspan=2| {{tlx|tlx|convert|<nowiki><nowiki>14|m|ftin|abbr=out|sp=us</nowiki></nowiki>}}
|unlimited parameters as one nowiki string
|-
|{{tlx|tlx|x1|x=u}}
|{{tlx|x1|x=u}}
|'''=''' won't work
|-
|{{tlx|tlx|x1|x&#61;u}}
|{{tlx|x1|x=u}}
|align="right"|<tt>&#61;</tt> is okay
|-
|{{tlx|tlx|x1|x<nowiki>{{=}}</nowiki>u}}
|{{tlx|x1|x{{=}}u}}
|align="right"|<tt><nowiki>{{=}}</nowiki></tt> is okay
|-
|{{tlx|tlx|x1|<nowiki>x=u</nowiki>}}
|{{tlx|x1|<nowiki>x=u</nowiki>}}
|align="right"|sticky nowiki is okay
|-
|{{tlx|tlx|x2| |two}}
|{{tlx|x2| |two}}
|empty won't work
|-
|{{tlx|tlx|x2|&#32;|two}}
|{{tlx|x2| |two}}
|align="right"|<tt>&#32;</tt> is okay
|-
|{{tlx|tlx|x2|&nbsp;|two}}
|{{tlx|x2| |two}}
|align="right"|<tt>&nbsp;</tt> is okay
|-
|{{tlx|tlx|x2| &#124; two}}
|{{tlx|x2| | two}}
|align="right"|<tt>&#124;</tt> is okay
|-
|| {{tlx|tlx|x2| {{!}} 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''' clobbers '''2=one'''
|-
|| {{tlx|tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}}
|| {{tlx|x2|3=two|2=one}}
|align="right"|right to left okay
|}
== See also ==
* [http://en.wikipedia.org/wiki/Template:tlxb Template:tlxb] – same as {{tl|tlx}}, but gives the template name in boldface type (this can be useful when stressing the difference between two similarly named templates). [http://en.wikipedia.org/wiki/Template:Tlb Template:Tlb] is the same, except it uses regular text instead of a monospaced non-proportional font.
* [http://en.wikipedia.org/wiki/Template:Temt Template:Temt], – same as {{tl|tlx}}, but handles template names with the Template: prefix and templates not in the [http://en.wikipedia.org/wiki/Wikipedia:Namespace Template: namespace] <nowiki>{{ns:10}}</nowiki>.
* [http://en.wikipedia.org/wiki/Template:Para Template:Para] – for giving examples of template parameters and values only, instead of entire templates with parameters.
{{tl-nav}}
<!--- Categories applied to both /doc style Documentation page and to the parent templates --->
<!-- Add the Categories for this doc or usage page (only-- not for the calling template) BELOW THIS LINE --->
tt>{