JChris.FillionR: 1 revision

2011-10-23T04:58:31Z

1 revision

JChris.FillionR: Created page with '{{documentation subpage}} ==Usage== Code:

 * {{tlx|example|parameter1|parameter2...}} * {{tlx|SISTER=W:|example|parameter1|parameter2...}}

Result: * {{tlx|example|pa…'

2011-10-21T20:55:11Z

Created page with '{{documentation subpage}} ==Usage== Code: <pre> * {{tlx|example|parameter1|parameter2...}} * {{tlx|SISTER=W:|example|parameter1|parameter2...}} </pre> Result: * {{tlx|example|pa…'

Show changes

WOSlinker: remove cat

2011-10-09T11:16:32Z

remove cat

New page

<includeonly>
''This '{{Tlx|Tlx}}' template documentation is [[w:Wikipedia:Template doc page pattern|transcluded]] for all ''Tlx family templates (Tlx, Tlxc, Tlxm, Tlxw, Tlxb)'' [[{{fullurl:Template:Tlx/doc |action=edit}} edit]].{{#ifeq:{{SITENAME}}|Meta| |[[M:template:{{PAGENAMEE}}|Masterpage]]
 }}</includeonly><noinclude>
{{Documentation subpage}}
{{-}}
</noinclude>



: {{Tlx|Tlx|Template|first parameter|second|third|...|tenth}} → {{Tlx|Template|first parameter|second|third|...|tenth}}
: {{Tlx|Tlx|Template|2=first parameter|3=second|4=third|...|11=tenth}} → {{Tlx|Template|first parameter|second|third|...|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 ==
[[Wikt: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 [[Help:Pipe trick|pipe-tricked]] [[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 "&#124;''...''"). A keyword parameter can be used with equals code &#61; or <nowiki>{{=}}</nowiki> or in nowiki-text: "<nowiki>size=10</nowiki>" or all parameters as a string in <nowiki>"<nowiki>"</nowiki> 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 {{nobr|<code><nowiki><code><nowiki></nowiki></code>}}, for example: {{nobr|<code><nowiki><code><nowiki>{{Anytemplate|arg1=23|size=250px|</nowiki><var>other parameters...</var><nowiki>}}</nowiki></code></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 {{nobr|<code><nowiki><pre>...</pre></nowiki></code>}}.

----

* If given no additional parameters except ''<code> 'template name' (<nowiki>{{{1}}}</nowiki>), </code>'' it presents the same as the similar {{tl|Tl}} [[macro]] template -- a blue link nested in [[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 [[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 ==

{{[[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||
{{#ifeq:{{SITENAME}}|Meta||
;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 ==
* [[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). [[Template:Tlb]] is the same, except it uses regular text instead of a monospaced non-proportional font.
* [[Template:Temt]], – same as {{tl|Tlx}}, but handles template names with the Template: prefix and templates not in the [[Wikipedia:Namespace|Template: namespace]] <nowiki>{{ns:10}}</nowiki>.
* [[Template:Para]] – for giving examples of template parameters and values only, instead of entire templates with parameters.
{{tl-nav}}





<includeonly>

[[Category:Typing-aid templates |{{PAGENAME}}]]
[[Category:Internal link templates |{{PAGENAME}}]]
[[Category:Interwiki link templates |{{PAGENAME}}]]


[[cy:Nodyn:Tlx]]
[[de:Vorlage:Vorlage]]
[[fr:Modèle:Lmp]]
[[fa:الگو:الگوب]]
[[hsb:Předłoha:Tlx]]
[[hy:Կաղապար:Tlx]]
[[ko:틀:Tlx]]
[[ia:Patrono:Tlx]]
[[os:Шаблон:Tlp]]
[[mk:Шаблон:Швп]]
[[ja:Template:Tlx]]
[[no:Mal:Tlx]]
[[pt:Predefinição:Tlx]]
[[ro:Format:Tlx]]
[[ru:Template:Tlx]]
[[simple:Template:Tlx]]
[[sr:Šablon:Tlx]]
[[th:แม่แบบ:Tlx]]
[[tl:Suleras:Tlx]]
[[uk:Шаблон:Tlx]]
[[ur:سانچہ:Tlx]]
[[zh:Template:Tlx]]
</includeonly>

Template:Tlx/doc - Revision history

JChris.FillionR: 1 revision

JChris.FillionR: Created page with '{{documentation subpage}} ==Usage== Code:
* {{tlx|example|parameter1|parameter2...}} * {{tlx|SISTER=W:|example|parameter1|parameter2...}}
Result: * {{tlx|example|pa…'

WOSlinker: remove cat

← Older revision	Revision as of 04:58, 23 October 2011
(No difference)