Template:Tlx
Note: This documentation for {{tlx}}
is also transcluded by its derivatives {{tlxb}}
, {{tlxc}}
, {{tlxw}}
, {{tlxU}}
(edit · master page).
This template is used on 980,000+ pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please consider discussing changes on the talk page before implementing them. |
Contents
Basic use
(Note: In the following examples, ellipses (groups of three dots) indicate where parameters have been omitted.)
- {{tlx
- redirect Template:When in sandbox
(...because {{When in sandbox}} returns "/sandbox" when transcluded on a sandbox page)|tlx|Template|first parameter|second parameter|third|…|tenth}} produces: {{tlx
- redirect Template:When in sandbox
(...because {{When in sandbox}} returns "/sandbox" when transcluded on a sandbox page)|Template|first parameter|second parameter|third|…|tenth}}
Where parameters might contain one or more equals-signs ("="), replace each equals-sign with {{=}}
:
- {{tlx
- redirect Template:When in sandbox
(...because {{When in sandbox}} returns "/sandbox" when transcluded on a sandbox page)|tlx|Template|first{{=}}something|second|third{{=}}something|...|tenth}} produces: {{tlx
- redirect Template:When in sandbox
(...because {{When in sandbox}} returns "/sandbox" when transcluded on a sandbox page)|Template|first=something|second|third=something|...|tenth}}
For more than ten parameters, possibly also containing equals-signs, use <nowiki>...</nowiki>
thus:
- {{tlx
- redirect Template:When in sandbox
(...because {{When in sandbox}} returns "/sandbox" when transcluded on a sandbox page)|tlx|Template|<nowiki>''first''|''second''|''third=something''|...|''999th''</nowiki>}} produces: {{tlx
- redirect Template:When in sandbox
(...because {{When in sandbox}} returns "/sandbox" when transcluded on a sandbox page)|Template|first|second|third=something|...|999th}}
Purpose and naming
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><code class="nowrap" style=""><nowiki>{{Anytemplate|arg1=23|size=250px|other parameters...}}</nowiki>
</code></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>
.
Parameters
- If the only parameter supplied is
{{{1}}}
, i.e. a template's name, {{tlx}}'s output is the same as {{tl}} – i.e. a link within braces – but in a monospaced font:-
{{tl|tl}}
produces: {{tl}} -
{{tlx|tl}}
produces: {{tlx
-
- redirect Template:When in sandbox
(...because {{When in sandbox}} returns "/sandbox" when transcluded on a sandbox page)|tl}}
- {{tl}} will also not take nor display additional parameters.
- Named parameters
|subst=
- Setting this parameter to any non-blank value will prefix the string
subst:
linked to Help:Substitution. This is useful to indicate when a template should be substituted. For example, {{tlx
- redirect Template:When in sandbox
(...because {{When in sandbox}} returns "/sandbox" when transcluded on a sandbox page)|tlx|Welcome|3=subst=Y}} produces: {{tlx
- redirect Template:When in sandbox
(...because {{When in sandbox}} returns "/sandbox" when transcluded on a sandbox page)|Welcome|subst=Y}}. This is similar to the action of the {{tlx
- redirect Template:When in sandbox
(...because {{When in sandbox}} returns "/sandbox" when transcluded on a sandbox page)|tlxs}} template: {{tlx
- redirect Template:When in sandbox
(...because {{When in sandbox}} returns "/sandbox" when transcluded on a sandbox page)|tlxs|Welcome}} produces:
{{subst:welcome}}
.
|SISTER=
- For an interwiki link to other sister projects, such as:
|SISTER=M:
(Meta),|SISTER=Q:
(WikiQuote),|SISTER=S:
(WikiSource), etc, facilitating interwiki template documentation and/or discussion.
|LANG=
- For a link to Wikipedias in other languages, such as:
|LANG=de:
(German),|LANG=sv:
(Swedish), etc, facilitating cross-language template documentation and/or discussion.
Documentation
{{Tlx}} is a generalization of {{tl}}, {{tlp}} etc, with output that is arguably more legible. This depends on the browser, but narrow gaps between characters such as " { ", " | ", " } " and links can be hard to read when not monospaced (and hard to click on; for uses like {{!}}
, see {{tlw}}, which makes the click target bigger).
Usage
{{tlx|Templatename}}
{{tlx|Templatename|param}}
{{tlx|Templatename|1|2|3|4|5|6|7|8|9|10}}
{{tlx|Templatename|1|2|3|4|5|6|7|8|9|10|more}}
{{tlx|Templatename|param=value}}
There are up to 10 placeholders for parameters of the specified template.
Examples
- Note
- At the en.wikipedia and Meta sites, 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.
- Unlimited parameters as one
<nowiki>...</nowiki>
string - {{tlx
- redirect Template:When in sandbox
(...because {{When in sandbox}} returns "/sandbox" when transcluded on a sandbox page)|tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}
See also
- {{tlxb}}, a version of {{tlx}} where the template name is shown in bold.
- {{tlb}}, a version of {{tl}} where the template name is shown in bold.
- {{tlxplain}} (tlxpl), a version of {{tlx}} with plainer <code> styling.
- {{temt}}, a version of {{tlx}} that handles templates whose names include "Template:" and pages outside the Template: namespace that are treated as templates.
- {{para}}, for the presentation of template parameters and values (e.g.
|paraname=val
,|another=
, etc).
Template-linking templates
Templates by syntax
Link style → | Linked | Unlinked | Linked with subst | Linked including braces | Linked with alternative text | |
---|---|---|---|---|---|---|
Text style ↓ | ↓ {{tlg}} options1 →
|
N/A |
|
|
|
|
Normal | N/A | {{tlg}} 1, 2{{tl}} {{t links}} {{tlp}} 2
|
{{tlf}} 2
|
{{tls}} {{tlsp}}
|
{{tn}}
|
{{tla}}
|
Code
|
or
|
{{tlx}}
|
{{tlc}} 2{{tld}} 2{{tnull}}
|
{{tlxs}}
|
N/A | |
Bold |
|
{{tlb}}
|
N/A | |||
Bold code
|
|
{{tlxb}}
| ||||
Italic code
|
|
{{tlxi}}
|
{{tlg}}
is the most general, allowing any combination of text style and/or link style options.2 = Prevents wrapping of text by placing it inside
<span class="nowrap">...</span>
tags.Templates with example
{{lts|Hatnote}} |
→ | Template:Hatnote(edit talk links history) |
{{t links|Hatnote}} |
→ | Hatnote (edit · talk · history · links · /subpages · /doc · /doc edit · /sbox · /sbox diff · /test) |
{{tfd links|Hatnote}} |
→ | <div id="Template:Hatnote"/>Template:Hatnote (edit|talk|history|links|logs|delete) |
{{tiw|Hatnote}} |
→ | Template:hatnote (backlinks edit) |
{{tl|Hatnote}} |
→ | {{hatnote}}
|
{{tl2|Hatnote}} |
→ | {{hatnote}}
|
{{tla|Hatnote|some label}} |
→ | {{some label}} |
{{tlb|Hatnote}} |
→ | {{hatnote}} |
{{tlc|Hatnote}} |
→ | {{hatnote}}
|
{{tld|Hatnote}} |
→ | {{hatnote}}
|
{{tlf|Hatnote}} |
→ | {{hatnote}} |
{{tlg|Hatnote}} |
→ | {{hatnote}} |
{{tlp|Hatnote}} |
→ | {{hatnote}} |
{{tls|Hatnote}} |
→ | {{subst:hatnote}} |
{{tlsp|Hatnote}} |
→ | {{subst:hatnote}} |
{{tlu|Hatnote}} |
→ | {{hatnote}} |
{{tlx|Hatnote}} |
→ | {{hatnote}}
|
{{tlxb|Hatnote}} |
→ | {{hatnote}}
|
{{tlxi|Hatnote}} |
→ | {{hatnote}}
|
{{tlxs|Hatnote}} |
→ | {{subst:hatnote}}
|
{{tn|Hatnote}} |
→ | {{hatnote}} |
{{tnull|Hatnote}} |
→ | {{hatnote}}
|
{{xpd|Hatnote}} |
→ |
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 to the /doc subpage. Subpages of this template. |