Template:Tlb
Explanation
[edit]This template is a copy of {{tlxb}} except that it uses normal text instead of non-proportional, monospaced text:
Code | Result | Remark |
---|---|---|
{{tlb|Template name}}
|
{{Template name}} | |
{{tlb|Template name|parm1|parm2}}
|
{{Template name|parm1|parm2}} | |
{{tlb|Template name|parm1|parm2{{=}}foo}}
|
{{Template name|parm1|parm2=foo}} | Equal signs need to be escaped using {{=}} .
|
{{tlb}}
|
{{[[Template:Tlb|]]}} | This actually substitutes the current page name. Useful as a self-reference; won't be linked. |
{{tlb|SISTER=m:|3x}}
|
{{3x}} | Link to page on another wiki. |
I.e., it's a {{tl}}-style template-link tag that boldfaces the template name, and accepts parameters. It's main use is in distinguishing between multiple templates with similar names, in documentation, talk page discussions, etc.
The rest of the documentation is for {{tlx}}, which works the same way (although it doesn't currently behave sanely when no parameters are given; use {{tlu}} instead).
Note: This documentation for {{tlx}}
is also transcluded by its derivatives {{tlxb}}
, {{tlxc}}
, {{tlxw}}
, {{tlxU}}
(edit · master page).
Basic use
[edit](Note: In the following examples, ellipses (groups of three dots) indicate where parameters have been omitted.)
- {{tlxTemplate:\sandbox|tlx|Template|first parameter|second parameter|third|…|tenth}} produces: {{tlxTemplate:\sandbox|Template|first parameter|second parameter|third|…|tenth}}
Where parameters might contain one or more equals-signs ("="), replace each equals-sign with Template:Tcpl:
- {{tlxTemplate:\sandbox|tlx|Template|first{{=}}something|second|third{{=}}something|...|tenth}} produces: {{tlxTemplate:\sandbox|Template|first=something|second|third=something|...|tenth}}
For more than ten parameters, possibly also containing equals-signs, use <nowiki>...</nowiki>
thus:
- {{tlxTemplate:\sandbox|tlx|Template|<nowiki>''first''|''second''|''third=something''|...|''999th''</nowiki>}} produces: {{tlxTemplate:\sandbox|Template|first|second|third=something|...|999th}}
Purpose and naming
[edit]Mnemonically, "[t]emplate [l]ink e[x]panded" (after Template:Tlpad, "[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
[edit]- If the only parameter supplied is Template:Param, i.e. a template's name, Template:Tpad's output is the same as Template:TlpadTemplate:Aside but in a monospaced font:
{{tl|tl}}
produces: {{tl}}{{tlx|tl}}
produces: {{tlxTemplate:\sandbox|tl}}
- Template:Tpad 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, {{tlxTemplate:\sandbox|tlx|Welcome|3=subst=Y}} produces: {{tlxTemplate:\sandbox|Welcome|subst=Y}}. This is similar to the action of the {{tlxTemplate:\sandbox|tlxs}} template: {{tlxTemplate:\sandbox|tlxs|Welcome}} produces: Template:Tlxs.
|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
[edit]Template:Tlpad 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 "Template:Thinsp", "Template:Thinsp", "Template:Thinsp" and links can be hard to read when not monospaced (and hard to click on; for uses like {{!}}
, see Template:Tlpad, which makes the click target bigger).
Usage
[edit]{{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
[edit]Code | Result | Remarks |
{{tlx|x0}} | {{tlxTemplate:\sandbox|x0}} | |
{{tlx|Abc}} | {{tlxTemplate:\sandbox|Abc}} | |
{{tlx|ABC}} | {{tlxTemplate:\sandbox|ABC}} | |
{{tlx|AbC}} | {{tlxTemplate:\sandbox|AbC}} | |
{{tlx|x1|one}} | {{tlxTemplate:\sandbox|x1|one}} | |
{{tlx|x2|one|two}} | {{tlxTemplate:\sandbox|x2|one|two}} | |
{{tlx|x3|1|2|3|4|5|6|7|8|9|10}} | {{tlxTemplate:\sandbox|x3|1|2|3|4|5|6|7|8|9|10}} | |
{{tlx|x4|1|2|3|4|5|6|7|8|9|10|11}} | {{tlxTemplate:\sandbox|x4|1|2|3|4|5|6|7|8|9|10|11}} | up to 10 parameters... |
{{tlx|x5|1|2|3|4|5|6|7|8|9|10|11}} | {{tlxTemplate:\sandbox|x5|1|2|3|4|5|6|7|8|9|10|11}} | ...
| for more |
{{tlx|x1|x=u}} | {{tlxTemplate:\sandbox|x1|x=u}} | the straightforward equals-sign won't work... |
{{tlx|x1|x=u}} | {{tlxTemplate:\sandbox|x1|x=u}} | ...but
= is okay |
{{tlx|x1|x{{=}}u}} | {{tlxTemplate:\sandbox|x1|x=u}} | ...and
{{=}} is okay |
{{tlx|x1|<nowiki>x=u</nowiki>}} | {{tlxTemplate:\sandbox|x1|x=u}} | sticky nowiki also okay
|
{{tlx|x2| |two}} | {{tlxTemplate:\sandbox|x2| |two}} | empty won't work... |
{{tlx|x2| |two}} | {{tlxTemplate:\sandbox|x2| |two}} | ...but
  is okay |
{{tlx|x2| |two}} | {{tlxTemplate:\sandbox|x2| |two}} | ...
is also okay |
{{tlx|x2| | {{tlxTemplate:\sandbox|x2||two}} | <nowiki /> handles the space |
{{tlx|x2| | two}} | {{tlxTemplate:\sandbox|x2| | two}} | | is okay |
{{tlx|x2| {{!}} two}} | {{tlxTemplate:\sandbox|x2 | | two}} | {{!}} is dubious
|
{{tlx|x2|2=|3=two}} | {{tlxTemplate:\sandbox|x2|2=|3=two}} | empty really doesn't work |
{{tlx|x2|2=one|two}} | {{tlxTemplate:\sandbox|x2|2=one|two}} | "two" overrides "2=one" |
{{tlx|x2|3=two|2=one}} | {{tlxTemplate:\sandbox|x2|3=two|2=one}} | irregular parameter order is okay
|
- Unlimited parameters as one
<nowiki>...</nowiki>
string - {{tlxTemplate:\sandbox|tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}
See also
[edit]- Template:Tlpad, a version of Template:Tpad where the template name is shown in bold.
- Template:Tlpad, a version of Template:Tpad where the template name is shown in bold.
- Template:Tlpad (tlxpl), a version of Template:Tpad with plainer <code> styling.
- Template:Tlpad, a version of Template:Tpad 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
[edit]Template:Template-linking templates