Shablono:Tlx/doc
This is a documentation subpage for Shablono:Tlx. It contains usage information, categories and other content that is not part of the original shablono page. |
Basic use
redaktar(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 Shablono:Tcpl:
{{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
redaktarMnemonically, "[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
redaktar- If the only parameter supplied is Shablono:Param, i.e. a template's name, Shablono:Tpad's output is the same as {{tl}}Shablono:Aside but in a monospaced font:
- Shablono:Tc produces: {{tl}}
- Shablono:Tc produces:
{{tl}}
- Shablono: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,{{tlx|Welcome|subst=Y}}
produces:{{subst:Welcome}}
. This is similar to the action of the{{tlxs}}
template:{{tlxs|Welcome}}
produces: Shablono: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
redaktar{{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
redaktar{{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
redaktar- 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|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}
See also
redaktar- {{tlxb}}, a version of Shablono:Tpad where the template name is shown in bold.
- {{tlb}}, a version of Shablono:Tpad where the template name is shown in bold.
- {{tlxplain}} (Shablono:Tlbare), a version of Shablono:Tpad with plainer <code> styling.
- {{temt}}, a version of Shablono: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
redaktarShablono:Template-linking templates