Template:Tlx
Template documentation (for the above template, sometimes hidden or invisible)
Subpages of this template:
This template documentation requires cleanup. Please discuss this issue on the talk page and improve it if you can. This template documentation has been tagged since 01:52, 22 May 2009 (UTC). |
{{tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}} → {{template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}}
Purpose and naming
Mnemonically 'Template link expanded'... after {{tl}} Template link'
- This template takes another template-name and some associated Wikipedia: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 five pass parameters (numbered or nowiki-keywords) for the specified template are displayed as 'placeholders', and over 5 parameters can be displayed using a coded vertical-bar (as in "|..."). A keyword parameter can be used, when tagged as a nowiki-keyword: "<nowiki>size=10<\nowiki>" with each keyword parameter surrounded by "<nowiki>" tags; see Examples at bottom. For more details, see the this talk page.
- Exceptions: If the intended template lists numerous/keyword parameters, then perhaps this template should really not be used, and just hardcode the usage with
<code><nowiki>
, for example:<code><nowiki>{{Anytemplate|arg1=23|size=250px|other parameters...}}</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<pre>...</pre>
.
- If given no additional parameters except
'template name' ({{{1}}}),
it presents the same as the similar {{Tl}} 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.
- Comparatively, {{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}} 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}} will display {{Welcome}}.
- 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. Small 'front end' Shell or convience templates {{Tlxw}} and {{Tlxm}} are typing-aid templates available at Meta for automatic substitution in discussions about templates on Wikipedia or Meta.
- This usage also applies to interwiki capable template variations
- {{Tlxc}} -- which links to templates on Wikimedia Commons (The Commons).
- {{Tlxm}} -- which links to templates on Meta
- {{Tlxw}} -- which links to templates on Wikipedia
Documentation
{{Tlx}} is a generalization of {{Tl|x}}, {{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
- {{Tlx|template name}}
- {{Tlx|template name|param}}
- {{Tlx|template name|1|2|3}}
- {{Tlx|template name|1|2|3|more}}
- {{Tlx|template name|param=value}}
Up to three 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}} | {{x0}} | |
{{Tlx|Abc}} | {{Abc}} | |
{{Tlx|ABC}} | {{ABC}} | |
{{Tlx|AbC}} | {{AbC}} | |
{{Tlx|x1|one}} | one}} | |
{{Tlx|x2|one|two}} | one|two}} | |
{{Tlx|x3|1|2|3}} | 1|2|3}} | |
{{Tlx|x4|1|2|3|4}} | 1|2|3|4}} | up to 5 parameters, then ... |
{{Tlx|x4|1|2|3|4}} | 1|2|3|4}} | | for more |
{{Tlx|x1|x=u}} | {{x1}} | = won't work |
{{Tlx|x1|x=u}} | x=u}} | = is okay |
{{Tlx|x1|x{{=}}u}} | x=u}} | {{=}} is okay |
{{Tlx|x1|<nowiki>x=u</nowiki>}} | x=u}} | sticky nowiki is okay |
{{Tlx|x2| |two}} | two}} | empty won't work |
{{Tlx|x2| |two}} | |two}} |   is okay |
{{Tlx|x2| |two}} | |two}} | is okay |
{{Tlx|x2| | two}} | | two}} | | is okay |
{{Tlx|x2| {{!}} two}} | {{x2| | two}} | {{!}} is dubious |
{{Tlx|x2|2=|3=two}} | {{x2|two}} | empty really doesn't work |
{{Tlx|x2|2=one|two}} | {{x2|two}} | two clobbers 2=one |
{{Tlx|x2|3=two|2=one}} | {{x2|one|two}} | right to left okay |
See also
Template:Para – for giving examples of template parameters and values only, instead of entire templates with parameters.