K (1 Version) |
imported>Oetterer |
||
| Zeile 1: | Zeile 1: | ||
| − | {{# | + | <noinclude>{{Documentation subpage}}{{clear}}</noinclude> |
| − | {{documentation}} | + | |
| − | <!-- | + | == Basic use == |
| − | </ | + | ''(Note: In the following examples, [[wpen:Ellipsis|ellipses (groups of three dots)]] indicate where parameters have been omitted.)'' |
| + | |||
| + | : {{tlx{{\sandbox}}|tlx|tl|''first parameter''|''second parameter''|''third''|…|''tenth''}} produces: {{tlx{{\sandbox}}|tl|''first parameter''|''second parameter''|''third''|…|''tenth''}} | ||
| + | |||
| + | Where parameters might contain one or more equals-signs ("="), replace each equals-sign with {{tl|{{=}}}}: | ||
| + | : {{tlx{{\sandbox}}|tlx|tlx|''first''<nowiki>{{=}}</nowiki>''something''|''second''|''third''<nowiki>{{=}}</nowiki>''something''|...|tenth}} produces: {{tlx{{\sandbox}}|tlx|''first{{=}}something''|''second''|''third{{=}}something''|...|''tenth''}} | ||
| + | |||
| + | For more than ten parameters, possibly also containing equals-signs, use {{tag|nowiki}} thus: | ||
| + | : {{tlx{{\sandbox}}|tlx|tlx|<nowiki><nowiki>''first''|''second''|''third=something''|...|''999th''</nowiki></nowiki>}} produces: {{tlx{{\sandbox}}|tlx|<nowiki>first|second|third=something|...|999th</nowiki>}} | ||
| + | |||
| + | == Purpose and naming == | ||
| + | |||
| + | [[Wikt:mnemonic|Mnemonically]], "[{{padlr|'''t'''}}]emplate [{{padlr|'''l'''}}]ink e['''x''']panded" (after {{tlpad|tl}}, "[{{padlr|'''t'''}}]emplate [{{padlr|'''l'''}}]ink"). | ||
| + | |||
| + | This template allows an example of calling a template, accompanied by one or more parameters<!-- ("pass parameters", i.e. [[Help:Pipe trick|pipe-tricked]] [[m:Parameter#Parameters|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 "{{small|&#124;}}…"). A keyword parameter can be used with equals code &#61; or <nowiki>{{=}}</nowiki> or in nowiki-text: "{{tag|nowiki|content=size=10}}" or all parameters as a string in "{{tag|nowiki|o}}" tags; see ''[[#Examples|Examples]]'' at bottom. For more details, see [[wpen:{{TALKPAGENAME}}|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 {{tag|code|o}}{{tag|nowiki|o}}. For example: | ||
| + | : {{tag|code|content={{tag|nowiki|content=<nowiki>{{Anytemplate|arg1=23|size=250px|</nowiki><var>other parameters...</var><nowiki>}}</nowiki>}}}}. | ||
| + | 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 {{tag|pre}}. | ||
| + | |||
| + | ===Parameters=== | ||
| + | * If the only parameter supplied is {{param|1}}, i.e. a template's name, {{tl|tlx}}'s output is the same as {{tl|tl}} i.e. a link within [[wpen:Braces (punctuation)|braces]] but in a [[wpen:monospaced font|monospaced font]]: | ||
| + | ** {{tc|tl|tl}} produces: {{tl|tl}} | ||
| + | ** {{tc|tlx|tl}} produces: {{tlx{{\sandbox}}|tl}} | ||
| + | : {{tl|tl}} will also not take nor display additional parameters. | ||
| + | |||
| + | ; Named parameters | ||
| + | {{para|subst}} | ||
| + | : Setting this parameter to any non-blank value will prefix the string <code>subst:</code> linked to [[wpen:Help:Substitution|Help:Substitution]]. This is useful to indicate when a template should be substituted. For example, {{tlx{{\sandbox}}|tlx|draft|3=subst=Y}} produces: {{tlx{{\sandbox}}|draft|subst=Y}}. | ||
| + | {{para|SISTER}} | ||
| + | : For an interwiki link to other sister projects facilitating interwiki template documentation and/or discussion. | ||
| + | {{para|LANG}} | ||
| + | : For a link to other languages facilitating cross-language template documentation and/or discussion. | ||
| + | |||
| + | == Documentation == | ||
| + | |||
| + | {{tlpad|Tlx}} is a generalization of {{tl|tl|x}}, {{tl|tlp|x|y}} etc, with output that is arguably more legible. This depends on the browser, but narrow gaps between characters such as "{{thinsp|'''{'''}}", "{{thinsp|'''|'''}}", "{{thinsp|'''}'''}}" and links can be hard to read when not monospaced. | ||
| + | |||
| + | ===Usage=== | ||
| + | :<code>{{tlx{{!}}Templatename}}</code> | ||
| + | :<code>{{tlx{{!}}Templatename{{!}}param}}</code> | ||
| + | :<code>{{tlx{{!}}Templatename{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10}}</code> | ||
| + | :<code>{{tlx{{!}}Templatename{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10&#124;more}}</code> | ||
| + | :<code>{{tlx{{!}}Templatename{{!}}param&#61;value}}</code> | ||
| + | There are up to 10 placeholders for parameters of the specified template. | ||
| + | |||
| + | ===Examples=== | ||
| + | {{#switch:{{SITENAME}} |Wikipedia|Meta= | | ||
| + | ; 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. | ||
| + | }} | ||
| + | |||
| + | {{Aligned table |cols=3 | ||
| + | |class=wikitable |style=border:1;cellpadding:4; | ||
| + | |row1style=background:whitesmoke;font-weight:bold; | ||
| + | | Code | Result | Remarks | ||
| + | | {{tlx|tlx|x0}} | {{tlc{{\sandbox}}|x0}} |   | ||
| + | | {{tlx|tlx|Abc}} | {{tlc{{\sandbox}}|Abc}} |   | ||
| + | | {{tlx|tlx|ABC}} | {{tlc{{\sandbox}}|ABC}} |   | ||
| + | | {{tlx|tlx|AbC}} | {{tlc{{\sandbox}}|AbC}} |   | ||
| + | | {{tlx|tlx|x1|one}} | {{tlc{{\sandbox}}|x1|one}} |   | ||
| + | | {{tlx|tlx|x2|one|two}} | {{tlc{{\sandbox}}|x2|one|two}} |   | ||
| + | <!--(Parameter number:)--> | ||
| + | | {{tlx|tlx|x3|1|2|3|4|5|6|7|8|9|10}} | {{tlc{{\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}} | {{tlc{{\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}} | {{tlc{{\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}} | {{tlc{{\sandbox}}|x1|x=u}} | the straightforward equals-sign won't work... | ||
| + | | {{tlx|tlx|x1|x&#61;u}} | {{tlc{{\sandbox}}|x1|x=u}} | {{align|right|...but <code>&#61;</code> is okay}} | ||
| + | | {{tlx|tlx|x1|x<nowiki>{{=}}</nowiki>u}} | {{tlc{{\sandbox}}|x1|x{{=}}u}} | {{align|right|...and <code><nowiki>{{=}}</nowiki></code> is okay}} | ||
| + | | {{tlx|tlx|x1|<nowiki>x=u</nowiki>}} | {{tlc{{\sandbox}}|x1|<nowiki>x=u</nowiki>}} | {{align|right|sticky nowiki also okay}} | ||
| + | <!--(Empty/space/pipe:)--> | ||
| + | | {{tlx|tlx|x2| |two}} | {{tlc{{\sandbox}}|x2| |two}} | empty won't work... | ||
| + | | {{tlx|tlx|x2|&#32;|two}} | {{tlc{{\sandbox}}|x2| |two}} | {{align|right|...but <code>&#32;</code> is okay}} | ||
| + | | {{tlx|tlx|x2|&nbsp;|two}} | {{tlc{{\sandbox}}|x2| |two}} | {{align|right|...<code>&nbsp;</code> is also okay}} | ||
| + | | {{tlx|tlx|x2|{{tag|nowiki|s}}|two}} | {{tlc{{\sandbox}}|x2|<nowiki/>|two}} | {{align|right|{{tag|nowiki|s}} handles the space}} | ||
| + | | {{tlx|tlx|x2| &#124; two}} | {{tlc{{\sandbox}}|x2| | two}} | {{align|right|<code>&#124;</code> is okay}} | ||
| + | | {{tlx|tlx|x2| {{!}} two}} | {{tlc{{\sandbox}}|x2 | {{!}} two}} | {{align|right|<nowiki>{{!}}</nowiki> is dubious}} | ||
| + | |||
| + | | {{tlx|tlx|x2|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}} | {{tlc{{\sandbox}}|x2|2=|3=two}} | empty really doesn't work | ||
| + | |||
| + | | {{tlx|tlx|x2|<nowiki>2=one</nowiki>|two}} | {{tlc{{\sandbox}}|x2|2=one|two}} | "two" overrides "2{{=}}one" | ||
| + | |||
| + | | {{tlx|tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}} | {{tlc{{\sandbox}}|x2|3=two|2=one}} | {{align|right|irregular parameter order is okay}} | ||
| + | }} | ||
| + | ; Unlimited parameters as one {{tag|nowiki}} string | ||
| + | : {{tlx{{\sandbox}}|tlx|convert|<nowiki><nowiki>14|m|ftin|abbr=out|sp=us</nowiki></nowiki>}} | ||
| + | |||
| + | == See also == | ||
| + | |||
| + | * {{tl|para}}, for the presentation of template parameters and values (e.g. {{para|paraname|val}}, {{para|another}}, etc). | ||
| + | * {{tl|tli}}, for linking modules via #invoke. | ||
| + | |||
| + | == Template-linking templates == | ||
| + | {{Template-linking templates}} | ||
| + | |||
| + | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |{{#ifeq:{{BASEPAGENAME}}|Tlx | | ||
| + | [[Category:Internal link templates]] | ||
| + | |||
| + | }} }}</includeonly> | ||
Aktuelle Version vom 10. Oktober 2022, 08:49 Uhr
| This is a documentation subpage for Vorlage:Tlx. It contains usage information, categories and other content that is not part of the original vorlage page. |
Basic use[Quelltext bearbeiten]
(Note: In the following examples, ellipses (groups of three dots) indicate where parameters have been omitted.)
{{tlx|tl|first parameter|second parameter|third|…|tenth}}produces:{{tl|first parameter|second parameter|third|…|tenth}}
Where parameters might contain one or more equals-signs ("="), replace each equals-sign with {{}}:
{{tlx|tlx|first{{=}}something|second|third{{=}}something|...|tenth}}produces:{{tlx|first=something|second|third=something|...|tenth}}
For more than ten parameters, possibly also containing equals-signs, use <nowiki>...</nowiki> thus:
{{tlx|tlx|<nowiki>''first''|''second''|''third=something''|...|''999th''</nowiki>}}produces:{{tlx|first|second|third=something|...|999th}}
Purpose and naming[Quelltext bearbeiten]
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[Quelltext bearbeiten]
- 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|draft|subst=Y}}produces:{{subst:draft}}.
|SISTER=
- For an interwiki link to other sister projects facilitating interwiki template documentation and/or discussion.
|LANG=
- For a link to other languages facilitating cross-language template documentation and/or discussion.
Documentation[Quelltext bearbeiten]
{{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.
Usage[Quelltext bearbeiten]
{{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[Quelltext bearbeiten]
- 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}} | |
{{tlx|x4|1|2|3|4|5|6|7|8|9|10|11}} | {{x4|1|2|3|4|5|6|7|8}} | 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}} | ...
| for more |
{{tlx|x1|x=u}} | {{x1}} | the straightforward equals-sign won't work... |
{{tlx|x1|x=u}} | {{x1|x=u}} | ...but
= is okay |
{{tlx|x1|x{{=}}u}} | {{x1|x=u}} | ...and
{{=}} is okay |
{{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
  is okay |
{{tlx|x2| |two}} | {{x2| |two}} | ...
is also okay |
{{tlx|x2| | {{x2||two}} | <nowiki /> handles the space |
{{tlx|x2| | two}} | {{x2| | two}} | | is okay |
{{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[Quelltext bearbeiten]
- {{para}}, for the presentation of template parameters and values (e.g.
|paraname=val,|another=, etc). - {{tli}}, for linking modules via #invoke.
Template-linking templates[Quelltext bearbeiten]
| Link style → | Linked | Unlinked | Linked with alternative text | |
|---|---|---|---|---|
| Text style ↓ | ↓ {{tlg}} options1 →
|
N/A | sample text
|
sample textsample text
|
| Normal | N/A | {{tlg}}1, 2{{tl}}{{tlp}}2
|
{{tlf}}2
|
{{tla}}
|
Code
|
sample text orsample text
|
{{tlx}}
|
{{tlc}}2{{tld}}2{{tnull}}
|
N/A |
- 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>.