|
|
| Line 1: |
Line 1: |
| - | <includeonly>{{small |1=Note: This documentation for {{tlx|tlx}} is also [[w:Wikipedia:Template doc page pattern|transcluded]] by its derivatives {{tlx|tlxb}}, {{tlx|tlxc}}, {{tlx|tlxw}} (<span class="plainlinks">[{{fullurl:Template:Tlx/doc |action=edit}} edit]</span>{{#ifeq:{{SITENAME}}|Meta |). |{{dot}}[[M:template:{{PAGENAMEE}}|master page]]).}}<!--(end small:)-->}}</includeonly><!--
| + | {{documentation subpage}} |
| | + | This template creates example usage syntax for a template, and links the name to the template page. The name is derived from "'''T'''emplate '''l'''ist e'''x'''panded". |
| | | | |
| - | --><noinclude>{{Documentation subpage}}{{clear}}</noinclude>
| + | Up to 7 pass parameters (numbered) for the specified template are displayed as 'placeholders', and more parameters are shown as "<tt>|</tt>''...''". An optional <tt>SISTER</tt> parameter can specify an interwiki prefix to link to another wiki. Examples: |
| - | {{#ifeq:{{BASEPAGENAME}}|Tlx |{{High-risk|1,070,000+}} }}
| + | |
| - | This template is used to show example template usage without expanding the template itself.
| + | |
| | | | |
| - | == Basic use == | + | {| border="1" cellpadding="4" class="wikitable" |
| - | ''(Note: In the following examples, [[Ellipsis|ellipses (groups of three dots)]] indicate where parameters have been omitted.)''
| + | ! Code |
| - | | + | ! Result |
| - | : {{tlx{{\sandbox}}|tlx|Template|''first parameter''|''second parameter''|''third''|…|''tenth''}} produces: {{tlx{{\sandbox}}|Template|''first parameter''|''second parameter''|''third''|…|''tenth''}}
| + | ! Remark |
| - | | + | |- |
| - | Where parameters might contain one or more equals-signs ("="), replace each equals-sign with {{tlf|{{=}}}}:
| + | |{{Tlx|SISTER=W:|Tlx|x0}} |
| - | : {{tlx{{\sandbox}}|tlx|Template|''first''<nowiki>{{=}}</nowiki>''something''|''second''|''third''<nowiki>{{=}}</nowiki>''something''|...|tenth}} produces: {{tlx{{\sandbox}}|Template|''first{{=}}something''|''second''|''third{{=}}something''|...|''tenth''}}
| + | |{{Tlx|SISTER=W:|x0}} |
| - | | + | ||  |
| - | For more than ten parameters, possibly also containing equals-signs, use {{tag|nowiki}} thus:
| + | |- |
| - | : {{tlx{{\sandbox}}|tlx|Template|<nowiki><nowiki>''first''|''second''|''third=something''|...|''999th''</nowiki></nowiki>}} produces: {{tlx{{\sandbox}}|Template|<nowiki>first|second|third=something|...|999th</nowiki>}}
| + | |{{Tlx|SISTER=W:|Tlx|x1|one}} |
| - | | + | |{{Tlx|SISTER=W:|x1|one}} |
| - | == Purpose and naming ==
| + | ||  |
| - | | + | |- |
| - | [[Wikt:mnemonic|Mnemonically]], "['''t''']emplate ['''l''']ink e['''x''']panded" (after {{tl|tl}}, "['''t''']emplate ['''l''']ink").
| + | |{{Tlx|SISTER=W:|Tlx|x2|one|two}} |
| - | | + | |{{Tlx|SISTER=W:|x2|one|two}} |
| - | 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 [[{{TALKPAGENAME}}|this talk]] page.
| + | |{{Tlx|SISTER=W:|Tlx|x3|1<tt>|</tt>2<tt>|</tt>3}} |
| - | | + | |{{Tlx|SISTER=W:|x3|1|2|3}} |
| - | ; 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>}}}}.
| + | |{{Tlx|SISTER=W:|Tlx|x4|1<tt>|</tt>2<tt>|</tt>3|4}} |
| - | 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}}.
| + | |{{Tlx|SISTER=W:|x4|1|2|3|4}} |
| - | | + | |up to 7 parameters, then ... |
| - | ===Parameters=== | + | |- |
| - | * If the only parameter supplied is {{param|1}}, i.e. a template's name, {{tlf|tlx}}'s output is the same as {{tl|tl}} – i.e. a link within [[Braces (punctuation)|braces]] – but in a [[monospaced font]]:
| + | |{{Tlx|SISTER=W:|Tlx|x4|1<tt>|</tt>2<tt>|</tt>3&#124;4}} |
| - | ** {{tc|tl|tl}} produces: {{tl|tl}}
| + | |{{Tlx|SISTER=W:|x4|1|2|3|4}} |
| - | ** {{tc|tlx|tl}} produces: {{tlx{{\sandbox}}|tl}}
| + | |align="right"|<tt>&#124;</tt> for more |
| - | : {{tlf|tl}} will also not take nor display additional parameters.
| + | |- |
| - | | + | |{{Tlx|SISTER=W:|Tlx|x1|x=u}} |
| - | ; Named parameters | + | |{{Tlx|SISTER=W:|x1|x=u}} |
| - | {{para|subst}}
| + | |'''=''' won't work |
| - | : Setting this parameter to any non-blank value will prefix the string <code>subst:</code> linked to [[Help:Substitution]]. This is useful to indicate when a template should be substituted. For example, {{tlx{{\sandbox}}|tlx|Welcome|3=subst=Y}} produces: {{tlx{{\sandbox}}|Welcome|subst=Y}}. This is similar to the action of the {{tlx{{\sandbox}}|tlxs}} template: {{tlx{{\sandbox}}|tlxs|Welcome}} produces: {{tlxs|Welcome}}.
| + | |- |
| - | {{para|SISTER}}
| + | |{{Tlx|SISTER=W:|Tlx|x1|x&#61;u}} |
| - | : For an interwiki link to [[H:IW|other sister projects]], such as: {{para|SISTER|M:}} ([[m:|Meta]]), {{para|SISTER|Q:}} ([[q:|WikiQuote]]), {{para|SISTER|S:}} ([[s:|WikiSource]]), etc, facilitating interwiki template documentation and/or discussion.
| + | |{{Tlx|SISTER=W:|x1|x=u}} |
| - | {{para|LANG}}
| + | |align="right"|<tt>&#61;</tt> is okay |
| - | : For a link to [[H:ILL|Wikipedias in other languages]], such as: {{para|LANG|de:}} ([[:de:|German]]), {{para|LANG|sv:}} ([[:sv:|Swedish]]), etc, facilitating cross-language template documentation and/or discussion.
| + | |- |
| - | | + | |{{Tlx|SISTER=W:|Tlx|x1|<nowiki>x=u</nowiki>}} |
| - | == Documentation ==
| + | |{{Tlx|SISTER=W:|x1|<nowiki>x=u</nowiki>}} |
| - | | + | |align="right"|sticky nowiki is okay |
| - | {{tl|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}}'''|'''{{thinsp}}", "{{thinsp}}'''}'''{{thinsp}}" and links can be hard to read when not monospaced (and hard to click on; for uses like <code><nowiki>{{!}}</nowiki></code>, see {{tl|tlw}}, which makes the click target bigger).
| + | |- |
| - | | + | |{{Tlx|SISTER=W:|Tlx|x2| |two}} |
| - | ===Usage===
| + | |{{Tlx|SISTER=W:|x2| |two}} |
| - | :<code>{{tlx{{!}}Templatename}}</code>
| + | |empty won't work |
| - | :<code>{{tlx{{!}}Templatename{{!}}param}}</code>
| + | |- |
| - | :<code>{{tlx{{!}}Templatename{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10}}</code>
| + | |{{Tlx|SISTER=W:|Tlx|x2|&#32;|two}} |
| - | :<code>{{tlx{{!}}Templatename{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10&#124;more}}</code>
| + | |{{Tlx|SISTER=W:|x2| |two}} |
| - | :<code>{{tlx{{!}}Templatename{{!}}param&#61;value}}</code>
| + | |align="right"|<tt>&#32;</tt> is okay |
| - | There are up to 10 placeholders for parameters of the specified template.
| + | |- |
| - | | + | |{{Tlx|SISTER=W:|Tlx|x2|&nbsp;|two}} |
| - | ===Examples===
| + | |{{Tlx|SISTER=W:|x2| |two}} |
| - | {{#switch:{{SITENAME}} |Wikipedia|Meta= | | + | |align="right"|<tt>&nbsp;</tt> is okay |
| - | ; 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|SISTER=W:|Tlx|x2| &#124; two}} |
| - | | + | |{{Tlx|SISTER=W:|x2| | two}} |
| - | {{Aligned table |cols=3
| + | |align="right"|<tt>&#124;</tt> is okay |
| - | |class=wikitable |style=border:1;cellpadding:4;
| + | |- |
| - | |row1style=background:whitesmoke;font-weight:bold;
| + | || {{Tlx|SISTER=W:|Tlx|x2| {{!}} two}} |
| - | | Code | Result | Remarks
| + | || {{Tlx|SISTER=W:|x2| {{!}} two}} |
| - | | {{tlx|tlx|x0}} | {{tlx{{\sandbox}}|x0}} |  
| + | |align="right"|{{Tlx|SISTER=W:|!}} is dubious |
| - | | {{tlx|tlx|Abc}} | {{tlx{{\sandbox}}|Abc}} |  
| + | |- |
| - | | {{tlx|tlx|ABC}} | {{tlx{{\sandbox}}|ABC}} |  
| + | || {{Tlx|SISTER=W:|Tlx|x2|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}} |
| - | | {{tlx|tlx|AbC}} | {{tlx{{\sandbox}}|AbC}} |  
| + | || {{Tlx|SISTER=W:|x2|2=|3=two}} |
| - | | {{tlx|tlx|x1|one}} | {{tlx{{\sandbox}}|x1|one}} |  
| + | |empty really doesn't work |
| - | | {{tlx|tlx|x2|one|two}} | {{tlx{{\sandbox}}|x2|one|two}} |  
| + | |- |
| - | <!--(Parameter number:)-->
| + | || {{Tlx|SISTER=W:|Tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}} |
| - | | {{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|SISTER=W:|x2|3=two|2=one}} |
| - | | {{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...
| + | |align="right"|right to left okay |
| - | | {{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}}
| + | |}<includeonly>[[Category:Internal link templates|Tlx]] |
| - | <!--(Equals-sign:)-->
| + | ---- |
| - | | {{tlx|tlx|x1|x=u}} | {{tlx{{\sandbox}}|x1|x=u}} | the straightforward equals-sign won't work...
| + | <templatedata> |
| - | | {{tlx|tlx|x1|x&#61;u}} | {{tlx{{\sandbox}}|x1|x=u}} | {{align|right|...but <code>&#61;</code> is okay}}
| + | { "description": "Template list expanded", |
| - | | {{tlx|tlx|x1|x<nowiki>{{=}}</nowiki>u}} | {{tlx{{\sandbox}}|x1|x{{=}}u}} | {{align|right|...and <code><nowiki>{{=}}</nowiki></code> is okay}}
| + | "params": { |
| - | | {{tlx|tlx|x1|<nowiki>x=u</nowiki>}} | {{tlx{{\sandbox}}|x1|<nowiki>x=u</nowiki>}} | {{align|right|sticky nowiki also okay}}
| + | "1": { |
| - | <!--(Empty/space/pipe:)-->
| + | "label": "Template", |
| - | | {{tlx|tlx|x2| |two}} | {{tlx{{\sandbox}}|x2| |two}} | empty won't work...
| + | "description": "Linked template name", |
| - | | {{tlx|tlx|x2|&#32;|two}} | {{tlx{{\sandbox}}|x2| |two}} | {{align|right|...but <code>&#32;</code> is okay}}
| + | "type": "string/wiki-page-name" |
| - | | {{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}}
| + | "2": { |
| - | | {{tlx|tlx|x2| &#124; two}} | {{tlx{{\sandbox}}|x2| | two}} | {{align|right|<code>&#124;</code> is okay}}
| + | "label": "Parameter", |
| - | | {{tlx|tlx|x2| {{!}} two}} | {{tlx{{\sandbox}}|x2 | {{!}} two}} | {{align|right|<nowiki>{{!}}</nowiki> is dubious}}
| + | "description": "Optional parameter", |
| - | | + | "type": "string" |
| - | | {{tlx|tlx|x2|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}} | {{tlx{{\sandbox}}|x2|2=|3=two}} | empty really doesn't work
| + | }, |
| - |
| + | "3": { |
| - | | {{tlx|tlx|x2|<nowiki>2=one</nowiki>|two}} | {{tlx{{\sandbox}}|x2|two}} | "two" overrides "2{{=}}one"
| + | "description": "For 2 parameters", |
| - | | + | "type": "string" |
| - | | {{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}}
| + | }, |
| - | }} | + | "4": { |
| - | ; Unlimited parameters as one {{tag|nowiki}} string
| + | "description": "For 3 parameters", |
| - | : {{tlx{{\sandbox}}|tlx|convert|<nowiki><nowiki>14|m|ftin|abbr=out|sp=us</nowiki></nowiki>}} | + | "type": "string" |
| - | | + | }, |
| - | | + | "5": { |
| - | | + | "description": "For 4 parameters", |
| - | }} }}</includeonly> | + | "type": "string" |
| | + | }, |
| | + | "6": { |
| | + | "description": "For 5 parameters", |
| | + | "type": "string" |
| | + | }, |
| | + | "7": { |
| | + | "description": "For 6 parameters", |
| | + | "type": "string" |
| | + | }, |
| | + | "8": { |
| | + | "label": "Overflow", |
| | + | "description": "Overflow shown as ...", |
| | + | "type": "string" |
| | + | }, |
| | + | "SISTER": { |
| | + | "label": "Interwiki", |
| | + | "description": "Optional InterWiki link prefix", |
| | + | "type": "string" |
| | + | } } }</templatedata></includeonly> |
Up to 7 pass parameters (numbered) for the specified template are displayed as 'placeholders', and more parameters are shown as "|...". An optional SISTER parameter can specify an interwiki prefix to link to another wiki. Examples:
