模板:Tlx/doc
Basic use
編輯(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:Tlf:
- {{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
編輯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 Template:Param, i.e. a template's name, Template:Tlf's output is the same as {{tl}} – i.e. a link within braces – but in a monospaced font:
- Template:Tc produces: {{tl}}
- Template:Tc produces: {{tlxTemplate:\sandbox|tl}}
- Template:Tlf 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
編輯{{Tlx}} is a generalization of {{tl|x}}, {{tlp|x}} 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|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 {{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.
範例
編輯- 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.
| 代碼 | 結果 | 註釋 |
{{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}} | Template:Align |
{{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}} | Template:Align |
{{tlx|x1|x{{=}}u}} | {{tlxTemplate:\sandbox|x1|x=u}} | Template:Align |
{{tlx|x1|<nowiki>x=u</nowiki>}} | {{tlxTemplate:\sandbox|x1|x=u}} | Template:Align |
{{tlx|x2| |two}} | {{tlxTemplate:\sandbox|x2| |two}} | empty won't work... |
{{tlx|x2| |two}} | {{tlxTemplate:\sandbox|x2| |two}} | Template:Align |
{{tlx|x2| |two}} | {{tlxTemplate:\sandbox|x2| |two}} | Template:Align |
{{tlx|x2| | {{tlxTemplate:\sandbox|x2||two}} | Template:Align |
{{tlx|x2| | two}} | {{tlxTemplate:\sandbox|x2| | two}} | Template:Align |
{{tlx|x2| {{!}} two}} | {{tlxTemplate:\sandbox|x2 | | two}} | Template:Align |
{{tlx|x2|2=|3=two}} | {{tlxTemplate:\sandbox|x2|2=|3=two}} | empty really doesn't work |
{{tlx|x2|2=one|two}} | {{tlxTemplate:\sandbox|x2|two}} | "two" overrides "2=one" |
{{tlx|x2|3=two|2=one}} | {{tlxTemplate:\sandbox|x2|3=two|2=one}} | Template:Align |
- Unlimited parameters as one
<nowiki>……</nowiki>string - {{tlxTemplate:\sandbox|tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}
參見
編輯- {{tlxb}}, a version of Template:Tlf where the template name is shown in bold.
- {{tlb}}, a version of Template:Tlf where the template name is shown in bold.
- {{temt}}, a version of Template:Tlf 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
編輯Template:Template-linking templates