ਫਰਮਾ:Tlx/doc
This is a documentation subpage for ਫਰਮਾ:Tlx. It contains usage information, categories and other content that is not part of the original ਫਰਮਾ page. |
{{tlx|Template|first parameter|second|third|...|tenth}}
→{{template|first parameter|second|third|...|tenth}}
{{tlx|Template|2=first parameter|3=second|4=third|...|11=tenth}}
→{{template|first parameter|second|third|...|tenth}}
if they might contain "=" signs.{{tlx|Template|
→<nowiki>first|second|...|999th</nowiki>
}}{{template|first|second|...|999th}}
(for more than 10 parameters)
Purpose and naming
ਸੋਧੋMnemonically 'Template link expanded'. After {{tl}}
'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 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&></nowiki></code>
. 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>
.
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 w: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
ਸੋਧੋ- 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.
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}} | ... |
{{tlx|x1|x=u}} | {{x1}} | the straightforward equals-sign won't work... |
{{tlx|x1|x=u}} | {{x1|x=u}} | ...but |
{{tlx|x1|x{{=}}u}} | {{x1|x=u}} | ...and |
{{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 |
{{tlx|x2| |two}} | {{x2| |two}} | ... |
{{tlx|x2|<nowiki/>|two}} | {{x2||two}} | <nowiki/> handles the space |
{{tlx|x2| | two}} | {{x2| | two}} |
|
{{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
ਸੋਧੋ- {{tl}} for template statements
- {{tls}} for template statements requiring substitution
- 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.
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 |
{{tlf}} 2
|
{{tls}} {{tlsp}}
|
{{tn}}
|
{{tla}}
|
Code
|
code=yes ortt=yes
|
{{tlx}}
|
{{tlc}} 2{{tld}} 2{{tnull}}
|
{{tlxs}}
|
N/A | |
Bold | bold=yes
|
{{tlb}}
|
N/A | |||
Bold code
|
bold=yes|code=yes
|
{{tlxb}}
|
- 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.