Kigezo:Tlx
This {{tlx}} template documentation is transcluded for all tlx family templates (tlx, tlxc, tlxw, tlxb) [edit].master page
| This template is used on 850,000+ pages, and changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in a user subpage, and consider discussing changes at the talk page before implementing them. |
- Basic use
{{tlx|Template|first parameter|second parameter|third|...|tenth}}→{{Template|first parameter|second parameter|third|...|tenth}}
Where parameters might contain one or more equals-signs ("="), replace each equals-sign with {{=}}:
{{tlx|Template|first{{=}}something|second|third{{=}}something|...|tenth}}→{{Template|first=something|second|third=something|...|tenth}}
For more than ten parameters, possibly also containing equals-signs, use:
{{tlx|Template|<nowiki>''first''|''second''|''third=something''|...|''999th''</nowiki>}}→{{Template|first|second|third=something|...|999th}}
Purpose and naming
[hariri chanzo]Mnemonically, "[t]emplate [l]ink e[x]panded" (after {{tl}}, "[t]emplate [l]ink").
This template allows an example of calling a template, accompanied by one or more 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 "|..."). 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. For more details, see 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
<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>.
Parameters
[hariri chanzo]- 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 noticeably 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 non-blank value 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{{subst:Welcome}}. This is similar to the action of the{{tlxs}}template:{{Tlxs|Welcome}}will display Kigezo:Tlxs.- Additionally, Tlx will take a named parameter
|SISTER=to link interwiki to other sister projects such as one of these examples:|SISTER=M:(Meta),|SISTER=Q:(WikiQuote),|SISTER=S:(WikiSource), etc. allowing documentation or discourse about a template across interwiki boundaries. - Tlx will also take a named parameter
|LANG=to link to other language Wikipedias, such as one of these examples:|LANG=de:(German),|LANG=sv:(Swedish), etc. allowing documentation or discourse about a template across language boundaries.
Documentation
[hariri chanzo]{{Tlx}}
is a generalization of {{Tl}}, {{Tlp}},
etc., with arguably better-readable
output. This depends on the browser, but too-narrow
uses of "{", "|", "}" in conjunction
with links can be hard to read when not monospaced (and hard to click on; for uses like {{!}}, see {{tln}}, which makes the click target bigger).
Usage
[hariri chanzo]{{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
[hariri chanzo]
| Code | Result | Remark |
|---|---|---|
{{Tlx|x0}} |
{{x0}} |
|
{{Tlx|Abc}} |
{{Abc}} |
|
{{Tlx|ABC}} |
{{ABC}} |
|
{{Tlx|AbC}} |
{{AbC}} |
|
{{Tlx|x1|one}} |
{{x1|one}} |
|
{{Tlx|x2|one|two}} |
{{x2|one|two}} |
|
{{Tlx|x3|1|2|3|4|5|6|7|8|9|10}} |
{{x3|1|2|3|4|5|6|7|8|9|10}} |
|
{{Tlx|x4|1|2|3|4|5|6|7|8|9|10|11}} |
{{x4|1|2|3|4|5|6|7|8|9|10|...}} |
up to 10 parameters, then ... |
{{Tlx|x5|1|2|3|4|5|6|7|8|9|10|11}} |
{{x5|1|2|3|4|5|6|7|8|9|10|11}} |
| for more |
{{Tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}} |
unlimited parameters as one nowiki string | |
{{Tlx|x1|x=u}} |
{{x1}} |
= won't work |
{{Tlx|x1|x=u}} |
{{x1|x=u}} |
= is okay |
{{Tlx|x1|x{{=}}u}} |
{{x1|x=u}} |
{{=}} is okay |
{{Tlx|x1|<nowiki>x=u</nowiki>}} |
{{x1|x=u}} |
sticky nowiki is okay |
{{Tlx|x2| |two}} |
{{x2|two}} |
empty won't work |
{{Tlx|x2| |two}} |
{{x2| |two}} |
  is okay |
{{Tlx|x2| |two}} |
{{x2| |two}} |
is okay |
{{Tlx|x2| | two}} |
{{x2| | 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
[hariri chanzo]- 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.
| Link Style | Linked | Unlinked | Linked with subst: | Linked including braces | Linked with alternative text | |
|---|---|---|---|---|---|---|
| Text Style | {{tlg}} option |
-- | |
|
|
|
| Normal | -- | {{tl}}, {{tlp}}; {{tlg}} |
{{tlf}} |
{{tls}}, {{tlsp}} |
{{tn}} |
{{tla}} |
| Teletype | |
{{tlx}} |
{{tld}} |
{{tlxs}} |
||
| Bold | |
{{tlb}} |
||||
| Bold Teletype | |
{{tlxb}} |
||||
| Italic Teletype | |
{{tlxi}} |
||||
Code |
|
{{tlc}} |
{{tlg}} is the most general, allowing any combination of the above options.