Template documentation
|
---|
Note: portions of the template sample may not be visible without values provided. |
View or edit this documentation. (About template documentation) |
Editors can experiment in this template's sandbox and test case pages. |
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.)
- produces:
Where parameters might contain one or more equals-signs ("="), replace each equals-sign with {{=}}:
- produces:
For more than ten parameters, possibly also containing equals-signs, use <nowiki>...</nowiki>
thus:
- produces:
Purpose and naming
Mnemonically, template link expanded (after template link).
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 20 of the template's parameters (numbered or nowiki-keywords) may be displayed as placeholders, while more than over 20 parameters can be displayed using a coded vertical bar (pipe) symbol, 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. If you use 21 or more parameters, all after the 20th will be replaced with a single |...
at the end of the parameter list.
- 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|tl}}
produces: {{tl}}{{tlx|tl}}
produces:
- {{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, produces: . This is similar to the action of the template: produces:{{subst:welcome}}
.
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 {{Tn}}, 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
TemplateData
TemplateData documentation used by VisualEditor and other tools
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
see the monthly error report for this template.
TemplateData for Tlxw Show example template usage without expanding the template itself. {{tnull}} is similar without linking the template.
|