Note: This documentation for {{tlx}}
is also transcluded by its derivatives {{tlxb}}
, {{tlxc}}
, {{tlxw}}
( · master page).
This template is used to show example template usage without expanding the template itself.
Contents
Basic use
(Note: In the following examples, ellipses (groups of three dots) indicate where parameters have been omitted.)
{{tlx|Template|first parameter|second parameter|third|...|tenth}}
produces:{{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}}
produces:{{Template|first=something|second|third=something|...|tenth}}
For more than ten parameters, possibly also containing equals-signs, use <nowiki>...</nowiki>
thus:
{{tlx|Template|<nowiki>''first''|''second''|''third=something''|...|''999th''</nowiki>}}
produces:{{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>
.<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>
.
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}} 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|Welcome|subst=Y}}
produces:{{subst:Welcome}}
. This is similar to the action of the{{tlxs}}
template:{{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
Code | Result | Remarks |
{{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... |
{{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|x1|x=u}} |
{{x1}} |
the straightforward equals-sign won't work... |
{{tlx|x1|x=u}} |
{{x1|x=u}} |
...but
= is okay |
{{tlx|x1|x{{=}}u}} |
{{x1|x=u}} |
...and
{{=}} is okay |
{{tlx|x1|<nowiki>x=u</nowiki>}} |
{{x1|x=u}} |
sticky nowiki also okay
|
{{tlx|x2| |two}} |
{{x2|two}} |
empty won't work... |
{{tlx|x2| |two}} |
{{x2| |two}} |
...but
  is okay |
{{tlx|x2| |two}} |
{{x2| |two}} |
...
is also okay |
{{tlx|x2| |
{{x2||two}} |
<nowiki /> handles the space |
{{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" overrides "2=one" |
{{tlx|x2|3=two|2=one}} |
{{x2|one|two}} |
irregular parameter order is okay
|
- Unlimited parameters as one
<nowiki>...</nowiki>
string {{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.
- {{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=
).
Template-linking templates
General-purpose formatting
Link style → | Linked | Unlinked | Linked with subst | Linked including braces | Linked with alternative text | |
---|---|---|---|---|---|---|
Text style ↓ | ↓ {{tlg}} options1 → |
N/A | nolink=yes |
subst=yes |
braceinside=yes |
alttext=Foo 2=Foo |
Normal | N/A | {{tlg}} 1, 2{{tl}} {{tlp}} 2{{tlu}} 4 |
{{tlf}} 2 |
{{tls}} {{tlsp}} |
{{tn}} |
{{tla}} |
Code |
code=yes ortt=yes |
{{tlx}} {{tltt}} {{tltt2}} |
{{tlc}} 2{{tld}} 2{{tnull}} |
{{tlxs}} {{tltts}} {{tltts3}} {{tltss}} 3 |
N/A | |
Bold | bold=yes |
{{tlb}} |
N/A | |||
Bold code |
bold=yes|code=yes |
{{tlxb}} |
||||
Italic code |
italic=yes|code=yes |
{{tlxi}} |
- 1
{{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. - 3 Uses monospace font but not
<code>...</code>
. - 4 Allows links to templates in any namespace.
Other formatting templates
Code example | Effect | Notes |
---|---|---|
{{tl2|Hatnote|lang=fr}} |
{{hatnote}} |
Supports linking to sister projects (e.g., fr:Hatnote) |
{{tlu|User:Ahunt/SSHFS}} |
{{User:Ahunt/SSHFS}} | Supports linking to any namespace |
{{xpd|Hatnote|Some hatnote text}} |
"{{hatnote|Some hatnote text}}" gives "
Some hatnote text
" [1] |
Shows code, example and a link to expand the template code |
{{para|title|<var>book title</var>}} |
|title=book title |
Formats template parameters for display, with or without values |
With utility links
Code example | Effect |
---|---|
{{lts|Hatnote}} |
Template:Hatnote( talk links history) |
{{t links|Hatnote}} |
Hatnote ( talk history links # /subpages /doc /sbox /sbox diff /test) · Module:hatnote |
{{tfd links|Hatnote}} |
Template:Hatnote ( · talk · history · links · logs · subpages · delete) |
{{tiw|Hatnote}} |
Template:hatnote (backlinks ) |
{{tltt|Hatnote}} |
{{Hatnote}} |
{{tetl|Hatnote}} |
{{ Hatnote }} |
{{tsetl|Hatnote}} |
{{ subst: Hatnote }} |
{{ti|Hatnote}} |
Template:Hatnote (talk · links · ) |
{{tic|Hatnote}} |
Template:Hatnote (talk links ) |
{{tiw|Hatnote}} |
Template:Hatnote (backlinks ) |
{{tlt|Hatnote}} |
{{Hatnote}} (talk) |
{{ttl|Hatnote}} |
{{Hatnote}} (t/l) |
{{twlh|Hatnote}} |
Template:Hatnote (links, talk) |