Template:Tlx/doc: Difference between revisions
No edit summary |
No edit summary |
||
Line 60: | Line 60: | ||
}} |
}} |
||
{{Aligned table |cols=3 |
|||
|class=wikitable |style=border:1;cellpadding:4; |
|||
|row1style=background:whitesmoke;font-weight:bold; |
|||
| Code | Result | Remarks |
|||
| {{tlx|tlx|x0}} | {{tlx{{\sandbox}}|x0}} |   |
|||
| {{tlx|tlx|Abc}} | {{tlx{{\sandbox}}|Abc}} |   |
|||
| {{tlx|tlx|ABC}} | {{tlx{{\sandbox}}|ABC}} |   |
|||
| {{tlx|tlx|AbC}} | {{tlx{{\sandbox}}|AbC}} |   |
|||
| {{tlx|tlx|x1|one}} | {{tlx{{\sandbox}}|x1|one}} |   |
|||
| {{tlx|tlx|x2|one|two}} | {{tlx{{\sandbox}}|x2|one|two}} |   |
|||
<!--(Parameter number:)--> |
|||
| {{tlx|tlx|x3|1|2|3|4|5|6|7|8|9|10}} | {{tlx{{\sandbox}}|x3|1|2|3|4|5|6|7|8|9|10}} |   |
|||
| {{tlx|tlx|x4|1|2|3|4|5|6|7|8|9|10|11}} | {{tlx{{\sandbox}}|x4|1|2|3|4|5|6|7|8|9|10|11}} | up to 10 parameters... |
|||
| {{tlx|tlx|x5|1|2|3|4|5|6|7|8|9|10&#124;11}} | {{tlx{{\sandbox}}|x5|1|2|3|4|5|6|7|8|9|10|11}} | {{align|right|...<code>&#124;</code> for more}} |
|||
<!--(Equals-sign:)--> |
|||
| {{tlx|tlx|x1|x=u}} | {{tlx{{\sandbox}}|x1|x=u}} | the straightforward equals-sign won't work... |
|||
| {{tlx|tlx|x1|x&#61;u}} | {{tlx{{\sandbox}}|x1|x=u}} | {{align|right|...but <code>&#61;</code> is okay}} |
|||
| {{tlx|tlx|x1|x<nowiki>{{=}}</nowiki>u}} | {{tlx{{\sandbox}}|x1|x{{=}}u}} | {{align|right|...and <code><nowiki>{{=}}</nowiki></code> is okay}} |
|||
| {{tlx|tlx|x1|<nowiki>x=u</nowiki>}} | {{tlx{{\sandbox}}|x1|<nowiki>x=u</nowiki>}} | {{align|right|sticky nowiki also okay}} |
|||
<!--(Empty/space/pipe:)--> |
|||
| {{tlx|tlx|x2| |two}} | {{tlx{{\sandbox}}|x2| |two}} | empty won't work... |
|||
| {{tlx|tlx|x2|&#32;|two}} | {{tlx{{\sandbox}}|x2| |two}} | {{align|right|...but <code>&#32;</code> is okay}} |
|||
| {{tlx|tlx|x2|&nbsp;|two}} | {{tlx{{\sandbox}}|x2| |two}} | {{align|right|...<code>&nbsp;</code> is also okay}} |
|||
| {{tlx|tlx|x2|{{tag|nowiki|s}}|two}} | {{tlx{{\sandbox}}|x2|<nowiki/>|two}} | {{align|right|{{tag|nowiki|s}} handles the space}} |
|||
| {{tlx|tlx|x2| &#124; two}} | {{tlx{{\sandbox}}|x2| | two}} | {{align|right|<code>&#124;</code> is okay}} |
|||
| {{tlx|tlx|x2| {{!}} two}} | {{tlx{{\sandbox}}|x2 | {{!}} two}} | {{align|right|<nowiki>{{!}}</nowiki> is dubious}} |
|||
| {{tlx|tlx|x2|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}} | {{tlx{{\sandbox}}|x2|2=|3=two}} | empty really doesn't work |
|||
| {{tlx|tlx|x2|<nowiki>2=one</nowiki>|two}} | {{tlx{{\sandbox}}|x2|two}} | "two" overrides "2{{=}}one" |
|||
| {{tlx|tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}} | {{tlx{{\sandbox}}|x2|3=two|2=one}} | {{align|right|irregular parameter order is okay}} |
|||
}} |
|||
; Unlimited parameters as one {{tag|nowiki}} string |
; Unlimited parameters as one {{tag|nowiki}} string |
||
: {{tlx{{\sandbox}}|tlx|convert|<nowiki><nowiki>14|m|ftin|abbr=out|sp=us</nowiki></nowiki>}} |
: {{tlx{{\sandbox}}|tlx|convert|<nowiki><nowiki>14|m|ftin|abbr=out|sp=us</nowiki></nowiki>}} |
Latest revision as of 22:36, 9 May 2018
This is a documentation subpage for Template:Tlx. It contains usage information, categories and other content that is not part of the original template page. |
This template is used to show example template usage without expanding the template itself.
Basic use[edit]
(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 {{=}}:
{{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[edit]
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[edit]
- 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 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[edit]
{{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[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]
- 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[edit]
- {{tlxb}}, a version of {{tlx}} where the template name is shown in bold.
- {{tlb}}, a version of {{tl}} where the template name is shown in bold.
- {{temt}}, a version of {{tlx}} 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[edit]
Template:Template-linking templates
Template data |
---|
<templatedata> { "params": { "1": { "label": "Template name", "description": "Name of the template to link", "example": "Tlx", "type": "wiki-template-name", "required": true }, "2": { "label": "1st parameter", "type": "string" }, "3": { "label": "2nd parameter", "type": "string" }, "4": { "label": "3rd parameter", "type": "string" }, "5": { "label": "4th parameter", "type": "string" }, "6": { "label": "5th parameter", "type": "string" }, "7": { "label": "6th parameter", "type": "string" }, "8": { "label": "7th parameter", "type": "string" }, "9": { "label": "8th parameter", "type": "string" }, "10": { "label": "9th parameter", "type": "string" }, "11": { "label": "10th parameter", "type": "string" }, "12": {}, "subst": { "description": "Set to any value to show \"subst:\" before the template name", "example": "true", "type": "boolean" }, "LANG": { "label": "Language", "description": "For a link to Wikipedias in other languages", "example": "de:", "type": "string" }, "SISTER": { "description": "For an interwiki link to other sister projects", "example": "M:", "type": "string" } }, "description": "Show example template usage without expanding the template itself.", "paramOrder": [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "subst", "LANG", "SISTER" ], "format": "inline" } </templatedata> |