Template:Template link expanded/doc: Difference between revisions

Revision as of 02:16, 30 September 2022

This template is used to show example template usage without expanding the template itself.

Basic use

(Note: In the following examples, ellipses (groups of three dots) indicate where parameters have been omitted.)

{{[[Template:|]]|tlx|Template|first parameter|second parameter|third parameter|...|tenth parameter}} produces: {{Template|first parameter|second parameter|third parameter|...|tenth parameter}}

When you want to indicate setting a value to one or more parameters, you would normally use the equals-sign ("="). This doesn't work here; instead use {{=}}, like so:

{{tlx|Template|first{{=}}first value|second|third{{=}}third value}} produces: {{tlx{|Template|firstfirst value|second|third=third value}}

For more than ten parameters – with or without equals-signs – instead wrap the entire list of parameters and their values in <nowiki> tags. When you do, you don't need to replace equals-signs. For instance:

{{tlx|Template|<nowiki>''first''|''second''|''third=value''|...|''999th''</nowiki>}} produces: {{Template|first|second|third=value|...|999th}}

Purpose and naming

Mnemonically, template link expanded (after template link).

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 20 of the template's parameters (numbered or nowiki-keywords) may be displayed as placeholders, while more than over 20 parameters can be displayed using a coded vertical bar (pipe) symbol, as in |. A keyword parameter can be used with equals code = or {{=}} or in nowiki-text: <nowiki>content=size=10" or all parameters as a string in <nowiki> tags. If you use 21 or more parameters, all after the 20th will be replaced with a single |... at the end of the parameter list.

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&ht;{{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>

Parameters

If the only parameter supplied is the template's name, {{tlx}}'s output is the same as {{tl}} – i.e. a link within braces – but in a monospaced font:
- {{tl|tl}} produces: {{tl}}
- {{tlx|tl}} produces: {{tl}}

{{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}}.

|SISTER=

For an interwiki link to other sister projects, such as: SISTER=M: (Meta), facilitating interwiki template documentation and/or discussion.

Documentation

{{Tlx}} is a generalization of {{tl}} 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

{{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.

TemplateData

Show example template usage without expanding the template itself. {{tnull}} is similar without linking the template.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Template name	`1`	Name of the template to link. Example Tlx	Template	required
1st parameter	`2`	no description	String	optional
2nd parameter	`3`	no description	String	optional
3rd parameter	`4`	no description	String	optional
4th parameter	`5`	no description	String	optional
5th parameter	`6`	no description	String	optional
6th parameter	`7`	no description	String	optional
7th parameter	`8`	no description	String	optional
8th parameter	`9`	no description	String	optional
9th parameter	`10`	no description	String	optional
10th parameter	`11`	no description	String	optional
11th parameter	`12`	no description	String	optional
12th parameter	`13`	no description	String	optional
13th parameter	`14`	no description	String	optional
14th parameter	`15`	no description	String	optional
15th parameter	`16`	no description	String	optional
16th parameter	`17`	no description	String	optional
17th parameter	`18`	no description	String	optional
18th parameter	`19`	no description	String	optional
19th parameter	`20`	no description	String	optional
20th parameter	`21`	no description	String	optional
Show subst:	`subst`	Set to any value to show "subst:" before the template name Example true	Boolean	optional
Language	`LANG`	The prefix for a link to Wikipedias in other languages. Example de:	Line	optional
Sister project	`SISTER`	The prefix for an interwiki link to other sister projects Example M:	Line	optional

@@ Line 1: / Line 1: @@
-<includeonly>{{small |1=Note: This documentation for {{tlx|tlx}} is also [[Wikipedia:Template doc page pattern|transcluded]] by its derivatives {{tlx|tlxb}}, {{tlx|tlxc}} (<span class="plainlinks">[{{fullurl:Template:Tlx/doc |action=edit}} edit]</span>{{#ifeq:{{SITENAME}}|Meta |). |{{dot}}[[M:template:{{PAGENAMEE}}|master page]]).}}<!--(end small:)-->}}</includeonly><noinclude>{{Documentation subpage}}{{clear}}</noinclude>
+{{Documentation subpage}}
-{{#ifeq:{{BASEPAGENAME}}|Tlx |{{High-risk|2325910+}} {{Used in system}} }}
 This template is used to show example template usage without expanding the template itself.
 ==Basic use==
-''(Note: In the following examples, [[Ellipsis|ellipses (groups of three dots)]] indicate where parameters have been omitted.)''
+''(Note: In the following examples, [[w:Ellipsis|ellipses (groups of three dots)]] indicate where parameters have been omitted.)''
-: {{tlx{{\sandbox}}|tlx|Template|''first parameter''|''second parameter''|''third parameter''|...|''tenth parameter''}} produces: {{tlx{{\sandbox}}|Template|''first parameter''|''second parameter''|''third parameter''|...|''tenth parameter''}}
+: {{tlx||tlx|Template|''first parameter''|''second parameter''|''third parameter''|...|''tenth parameter''}} produces: {{tlx|Template|''first parameter''|''second parameter''|''third parameter''|...|''tenth parameter''}}
-When you want to indicate setting a value to one or more parameters, you would normally use the equals-sign ("="). This doesn't work here; instead use {{tlf|{{=}}}}, like so:
+When you want to indicate setting a value to one or more parameters, you would normally use the equals-sign ("="). This doesn't work here; instead use {{tlx|{{=}}}}, like so:
-: {{tlx{{\sandbox}}|tlx|Template|''first''<nowiki>{{=}}</nowiki>''first value''|''second''|''third''<nowiki>{{=}}</nowiki>''third value''}} produces: {{tlx{{\sandbox}}|Template|''first{{=}}first value''|''second''|''third{{=}}third value''}}
+: {{tlx|tlx|Template|''first''<nowiki>{{=}}</nowiki>''first value''|''second''|''third''<nowiki>{{=}}</nowiki>''third value''}} produces: {{tlx{|Template|''firstfirst value''|''second''|''third{{=}}third value''}}
-For more than ten parameters – with or without equals-signs – instead wrap the entire list of parameters and their values in {{tag|nowiki}} tags. When you do, you don't need to replace equals-signs. For instance:
+For more than ten parameters – with or without equals-signs – instead wrap the entire list of parameters and their values in &lt;nowiki&gt; tags. When you do, you don't need to replace equals-signs. For instance:
-: {{tlx{{\sandbox}}|tlx|Template|&lt;nowiki><nowiki>''first''|''second''|''third=value''|...|''999th''</nowiki>&lt;/nowiki>}} produces: {{tlx{{\sandbox}}|Template|<nowiki>first|second|third=value|...|999th</nowiki>}}
+: {{tlx|tlx|Template|&lt;nowiki><nowiki>''first''|''second''|''third=value''|...|''999th''</nowiki>&lt;/nowiki>}} produces: {{tlx|Template|<nowiki>first|second|third=value|...|999th</nowiki>}}
 ==Purpose and naming==
 Mnemonically, ''template link expanded'' (after ''[[Template:tl|template link]]'').
-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.
+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 20 of the template's parameters (numbered or nowiki-keywords) may be displayed as placeholders, while more than over 20 parameters can be displayed using a coded vertical bar (pipe) symbol, as in <code>&amp;#124;</code>. A keyword parameter can be used with equals code &amp;#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. If you use 21 or more parameters, all after the 20th will be replaced with a single {{para||...}} at the end of the parameter list.
+Up to 20 of the template's parameters (numbered or nowiki-keywords) may be displayed as placeholders, while more than over 20 parameters can be displayed using a coded vertical bar (pipe) symbol, as in <code>&amp;#124;</code>. A keyword parameter can be used with equals code &amp;#61; or <nowiki>{{=}}</nowiki> or in nowiki-text: <code>&lt;nowiki&gt;content=size=10</code>" or all parameters as a string in &lt;nowiki&gt; tags. If you use 21 or more parameters, all after the 20th will be replaced with a single <code><nowiki>|...</nowiki></code> at the end of the parameter list.
 ; Exceptions
-If the intended template lists numerous parameters, then perhaps this template should really {{em|not}} be used, and just hardcode the usage with {{tag|code|o}}{{tag|nowiki|o}}. For example:
+If the intended template lists numerous parameters, then perhaps this template should really not be used, and just hardcode the usage with &lt;code&gt;&lt;nowiki&gt;. For example:
-: {{tag|code|content={{tag|nowiki|content=<nowiki>{{Anytemplate|arg1=23|size=250px|</nowiki><var>other parameters...</var><nowiki>}}</nowiki>}}}}.
+: <code>&lt;code&gt;&lt;nowiki&ht;<nowiki>{{Anytemplate|arg1=23|size=250px|</nowiki><var>other parameters...</var><nowiki>}}</nowiki>&lt;/nowiki&gt;&lt;/code&gt;</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 {{tag|pre}}.
+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 &lt;pre&gt;
 ===Parameters===
-*If the only parameter supplied is {{param|1}}, i.e. a template's name, {{tlx|tlx}}'s output is the same as {{tlx|tl}}&nbsp;&ndash; i.e. a link within [[Braces (punctuation)|braces]]&nbsp;&ndash; but in a [[monospaced font]]:
+*If the only parameter supplied is the template's name, {{tlx|tlx}}'s output is the same as {{tlx|tl}}&nbsp;&ndash; i.e. a link within [[w:Braces (punctuation)|braces]]&nbsp;&ndash; but in a [[w:monospaced font|monospaced font]]:
-**{{tc|tl|tl}} produces: {{tl|tl}}
+**{{tlx|tl|tl}} produces: {{tl|tl}}
-**{{tc|tlx|tl}} produces: {{tlx{{\sandbox}}|tl}}
+**{{tlx|tlx|tl}} produces: {{tlx|tl}}
 : {{tlx|tl}} will also not take nor display additional parameters.
 ; Named parameters
-{{para|subst}}
+<nowiki>|subst=</nowiki>
-: 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}}.
+: 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|tlx|Welcome|3=subst=Y}} produces: {{tlx|Welcome|subst=Y}}.
-{{para|SISTER}}
-: 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.
+<nowiki>|SISTER=</nowiki>
-{{para|LANG}}
+: For an interwiki link to [[w:H:IW|other sister projects]], such as: <code><nowiki>SISTER=M:</nowiki></code> ([[m:|Meta]]), facilitating interwiki template documentation and/or discussion.
-: 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.
 ==Documentation==
-{{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 "{{thin space}}'''{'''{{thin space}}", "{{thin space}}'''&#124;'''{{thin space}}", "{{thin space}}'''}'''{{thin space}}" 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).
+{{tl|Tlx}} is a generalization of {{tl|tl|x}} with output that is arguably more legible. This depends on the browser, but narrow gaps between characters such as "'''{'''", "''&#124;'''", "'''}'''" and links can be hard to read when not monospaced.
 ===Usage===
@@ Line 51: / Line 49: @@
 :<code>{&#123;tlx{{!}}Templatename{{!}}param&amp;#61;value&#125;}</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,&nbsp;... 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
- |row1style=background:whitesmoke;font-weight:bold;
- | Code                           | Result                             | Remarks
- | {{tlx|tlx|x0}}                 | {{tlx{{\sandbox}}|x0}}             | &#160;
- | {{tlx|tlx|Abc}}                | {{tlx{{\sandbox}}|Abc}}            | &#160;
- | {{tlx|tlx|ABC}}                | {{tlx{{\sandbox}}|ABC}}            | &#160;
- | {{tlx|tlx|AbC}}                | {{tlx{{\sandbox}}|AbC}}            | &#160;
- | {{tlx|tlx|x1|one}}             | {{tlx{{\sandbox}}|x1|one}}         | &#160;
- | {{tlx|tlx|x2|one|two}}         | {{tlx{{\sandbox}}|x2|one|two}}     | &#160;
- <!--(Parameter number:)-->
- | {{tlx|tlx|x3|1|2|3|4|5|6|7|8|9&#124;10}}             | {{tlx{{\sandbox}}|x3|1|2|3|4|5|6|7|8|9|10}}         | &#160;
- | {{tlx|tlx|x4|1|2|3|4|5|6|7|8|9&#124;10&#124;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&#124;10&amp;#124;11}} | {{tlx{{\sandbox}}|x5|1|2|3|4|5|6|7|8|9|10&#124;11}} | {{align|right|...<code>&amp;#124;</code> for more}}
- <!--(Equals-sign:)-->
- | {{tlx|tlx|x1|x&#61;u}}              | {{tlx{{\sandbox}}|x1|x=u}}         | the straightforward equals-sign won't work...
- | {{tlx|tlx|x1|x&amp;#61;u}}          | {{tlx{{\sandbox}}|x1|x&#61;u}}     | {{align|right|...but <code>&amp;#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|&lt;nowiki&gt;x&#61;u&lt;/nowiki&gt;}} | {{tlx{{\sandbox}}|x1|<nowiki>x=u</nowiki>}} | {{align|right|sticky nowiki also okay}}
- <!--(Empty/space/pipe:)-->
- | {{tlx|tlx|x2|&#160;|two}}           | {{tlx{{\sandbox}}|x2| |two}}         | empty won't work...
- | {{tlx|tlx|x2|&amp;#32;|two}}        | {{tlx{{\sandbox}}|x2|&#32;|two}}     | {{align|right|...but <code>&amp;#32;</code> is okay}}
- | {{tlx|tlx|x2|&amp;nbsp;|two}}       | {{tlx{{\sandbox}}|x2|&nbsp;|two}}    | {{align|right|...<code>&amp;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| &amp;#124; two}}      | {{tlx{{\sandbox}}|x2| &#124; two}}   | {{align|right|<code>&amp;#124;</code> is okay}}
- | {{tlx|tlx|x2| {&#123;!&#125;} 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
-: {{tlx{{\sandbox}}|tlx|convert|<nowiki>&lt;nowiki>14|m|ftin|abbr=out|sp=us&lt;/nowiki></nowiki>}}
 ==TemplateData==
-{{collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
-{{TemplateData header|noheader=1}}
 <templatedata>
 {
@@ Line 235: / Line 190: @@
 }
 </templatedata>
-{{collapse bottom}}
-==See also==
-*{{tl|tlxb}}, a version of {{tlf|tlx}} where the template name is shown in bold.
-*{{tl|tlb}}, a version of {{tlf|tl}} where the template name is shown in bold.
-*{{tl|temt}}, a version of {{tlf|tlx}} that handles templates whose names include "Template:" and pages outside the Template: [[Wikipedia:Namespace|namespace]] that are treated as templates.
-*{{tl|para}}, for the presentation of template parameters and values (e.g. {{para|paraname|val}}, {{para|another}}).
-*{{tl|tnull}}, like {{tnull|tlx}} without linking the template.
-{{Template-linking templates}}
-<includeonly>{{Sandbox other||{{#ifeq:{{BASEPAGENAME}}|Tlx |
-[[Category:Internal template-link templates]]
-[[Category:Interwiki link templates]]
-[[Category:Wikitext typing-aid templates]]
-}}}}</includeonly>

Search

Menu

Navigation

Profile

Profile

Messages

Page tools

Template:Template link expanded/doc: Difference between revisions

Sections

Revision as of 02:16, 30 September 2022

Contents

Basic use

Purpose and naming

Parameters

Documentation

Usage

TemplateData

Page info

Extra page tools

Last {{PLURAL:7|day|7 days}} (Top 10)