Template:Tlx
en.wikipedia.org/wiki/Template:Tlx
This '{{tlx}} !-- -->{{#if:|' template documentation is doc page pattern transcluded for all tlx family templates (tlx, tlxc, tlxw, tlxb) [edit].Masterpage
- {{tlx|Template|first parameter|second|third|...|tenth}}
!-- -->{{#if:second| → {{Template|first parameter|second|third|...|tenth}} !-- -->{{#if:third|
- {{tlx|Template|2=first parameter|3=second|4=third|5=...|11=tenth}}
!-- -->{{#if:3=second| → {{Template|first parameter|second|third|...|tenth}} !-- -->{{#if:third| if they might contain "=" signs.
- {{tlx|Template|<nowiki>first|second|...|999th</nowiki>}}
!-- -->{{#if:second| → {{Template|first|second|...|999th}} !-- -->{{#if:| (for more than 10 parameters)
Purpose and naming
Mnemonically] 'Template link expanded'. After {{tl}} !-- -->{{#if:| 'Template link'.
- This template takes another template-name and some associated trick pipe-tricked (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 "|..."). A keyword parameter can be used with equals code = or {{=}} or in nowiki-text: "
<nowiki>size=10</nowiki>
" or all parameters as a string in "<nowiki>
" tags; see 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
<code>
<nowiki>
, for example:<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<nowiki>{{Anytemplate|arg1=23|size=250px|other parameters...}}</nowiki>
</code><pre>...</pre>
.
- If given no additional parameters except
'template name' ({{{1}}}),
it presents the same as the similar {{tl}} (computer science) macro template -- a blue link nested in 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.
- {{tl|tl}}
!-- -->{{#if:| display compared to {{tlx|tl}} !-- -->{{#if:|: (tl: {{tl}} versus tlx: {{tl}} !-- -->{{#if:|)
- Comparatively, {{tl}}
!-- -->{{#if:| 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}}
!-- -->{{#if:| 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|Welcome|subst=Y}} !-- -->{{#if:| will display {{subst:Welcome}} !-- -->{{#if:|.
- 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
{{Tlx}} is a generalization of {{tl}}, {{tlp}}, 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
- {{Tlx|template name}}
- {{Tlx|template name|param}}
- {{Tlx|template name|1|2|3|4|5|6|7|8|9|10}}
- {{Tlx|template name|1|2|3|4|5|6|7|8|9|10|more}}
- {{Tlx|template name|param=value}}
Up to 10 placeholders for parameters of the specified template
Examples
- 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.
Code | Result | Remark | |||
---|---|---|---|---|---|
{{tlx|x0}} | --
-->{{#if:| |
{{x0}} | --
-->{{#if:| |
||
{{tlx|Abc}} | --
-->{{#if:| |
{{Abc}} | --
-->{{#if:| |
||
{{tlx|ABC}} | --
-->{{#if:| |
{{ABC}} | --
-->{{#if:| |
||
{{tlx|AbC}} | --
-->{{#if:| |
{{AbC}} | --
-->{{#if:| |
||
{{tlx|x1|one}} | --
-->{{#if:| |
{{x1|one}} | --
-->{{#if:| |
||
{{tlx|x2|one|two}} | --
-->{{#if:two| |
{{x2|one|two}} | --
-->{{#if:| |
||
{{tlx|x3|1|2|3|4|5|6|7|8|9|10}} | --
-->{{#if:2| |
{{x3|1|2|3|4|5|6|7|8|9|10}} | --
-->{{#if:3| |
||
{{tlx|x4|1|2|3|4|5|6|7|8|9|10|11}} | --
-->{{#if:2| |
{{x4|1|2|3|4|5|6|7|8|9|10|...}} | --
-->{{#if:3| |
up to 10 parameters, then ... | |
{{tlx|x5|1|2|3|4|5|6|7|8|9|10|11}} | --
-->{{#if:2| |
{{x5|1|2|3|4|5|6|7|8|9|10|11}} | --
-->{{#if:3| |
| for more | |
{{tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}} | --
-->{{#if:| |
unlimited parameters as one nowiki string | |||
{{tlx|x1|x=u}} | --
-->{{#if:| |
{{x1}} | --
-->{{#if:| |
= won't work | |
{{tlx|x1|x=u}} | --
-->{{#if:| |
{{x1|x=u}} | --
-->{{#if:| |
= is okay | |
{{tlx|x1|x{{=}}u}} | --
-->{{#if:| |
{{x1|x=u}} | --
-->{{#if:| |
{{=}} is okay | |
{{tlx|x1|<nowiki>x=u</nowiki>}} | --
-->{{#if:| |
{{x1|x=u}} | --
-->{{#if:| |
sticky nowiki is okay | |
{{tlx|x2| |two}} | --
-->{{#if:two| |
{{x2|two}} | --
-->{{#if:| |
empty won't work | |
{{tlx|x2| |two}} | --
-->{{#if:two| |
{{x2| |two}} | --
-->{{#if:| |
  is okay | |
{{tlx|x2| |two}} | --
-->{{#if:two| |
{{x2| |two}} | --
-->{{#if:| |
is okay | |
{{tlx|x2| | two}} | --
-->{{#if:| |
{{x2| | two}} | --
-->{{#if:| |
| is okay | |
{{tlx|x2| {{!}} two}} | --
-->{{#if:| |
{{x2| | two}} | --
-->{{#if:| |
{{!}} | --
-->{{#if:| is dubious |
{{tlx|x2|2=|3=two}} | --
-->{{#if:3=two| |
{{x2|two}} | --
-->{{#if:| |
empty really doesn't work | |
{{tlx|x2|2=one|two}} | --
-->{{#if:two| |
{{x2|two}} | --
-->{{#if:| |
two clobbers 2=one | |
{{tlx|x2|3=two|2=one}} | --
-->{{#if:2=one| |
{{x2|one|two}} | --
-->{{#if:| |
right to left okay |
See also
- Template:tlxb – same as {{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 {{tlx}}, but handles template names with the Template: prefix and templates not in the Template: namespace {{ns:10}}.
- Template:Para – for giving examples of template parameters and values only, instead of entire templates with parameters.
The above documentation is transcluded from Template:Tlx/doc. (edit | history) Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Please add categories and interwikis to the /doc subpage. Subpages of this template. |
!-- -->{{#if:|