Difference between revisions of "Template:Tlx/doc"

From MINR.ORG WIKI
m (151 revisions imported: Import Template Tlx and subtemplates)
 
(89 intermediate revisions by 50 users not shown)
Line 1: Line 1:
−
<includeonly><!-----------------Interwiki Doc page pattern------------------->
+
<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><!--
−
<small>''This '{{Tlx|Tlx}}' template documentation is [[w:Wikipedia:Template doc page pattern|transcluded]] for all ''Tlx family templates (Tlx, Tlxc, Tlxm, Tlxw, Tlxb)'' [<span class="plainlinks">[{{fullurl:Template:Tlx/doc |action=edit}} edit]</span>].{{#ifeq:{{SITENAME}}|Meta|&nbsp;|[[M:template:{{PAGENAMEE}}|Masterpage]]
 
−
&nbsp;}}</small></includeonly><noinclude>
 
−
{{Documentation subpage}}
 
−
{{-}}
 
−
{{interwikitmp-grp
 
−
|V=D
 
−
|cats=
 
−
|inhib=yes
 
−
|wdy=|wqt=|wsr=|wnw=
 
−
|{{PAGENAME}}|{{PAGENAME}}}}</noinclude>
 
  
−
<!-- Parent template(s) usage begins: --->
+
--><noinclude>{{Documentation subpage}}{{clear}}</noinclude>
 +
{{#ifeq:{{BASEPAGENAME}}|Tlx |{{High-risk|1,070,000+}} {{Used in system}} }}
 +
This template is used to show example template usage without expanding the template itself.
  
−
: {{tlx|Tlx|Template|first parameter|second|third| ...|tenth|11th}} → {{Tlx|Template|first parameter|second|third|...|tenth|11th}}
+
== Basic use ==
−
: {{tlx|Tlx|Template|&lt;nowiki>first|second|...|999th&lt;/nowiki>}}
+
''(Note: In the following examples, [[Ellipsis|ellipses (groups of three dots)]] indicate where parameters have been omitted.)''
  
 +
: {{tlx{{\sandbox}}|tlx|Template|''first parameter''|''second parameter''|''third''|...|''tenth''}} produces: {{tlx{{\sandbox}}|Template|''first parameter''|''second parameter''|''third''|...|''tenth''}}
  
−
== Purpose and naming ==
+
Where parameters might contain one or more equals-signs ("="), replace each equals-sign with {{tlf|{{=}}}}:
−
[[Wikt:mnemonic|Mnemonically]] ''''T'''emplate '''l'''ink e'''x'''panded'. After <tt>{{tlx|Tl}}</tt> '''T'''emplate '''l'''ink'.
+
: {{tlx{{\sandbox}}|tlx|Template|''first''<nowiki>{{=}}</nowiki>''something''|''second''|''third''<nowiki>{{=}}</nowiki>''something''|...|tenth}} produces: {{tlx{{\sandbox}}|Template|''first{{=}}something''|''second''|''third{{=}}something''|...|''tenth''}}
  
−
* This template takes another ''template-name'' and some associated [[Help:Pipe trick|pipe-tricked]] [[m:Parameter#Parameters|(numbered) parameters]] (or 'pass parameters'), and displays them as an 'example demonstration' of how the ''template-name'' template could be coded, literally. Its primary use is in instruction and documentation.
+
For more than ten parameters, possibly also containing equals-signs, use {{tag|nowiki}} thus:
−
* '''''Specifics:''''' Up to 11 pass parameters (numbered or nowiki-keywords) for the specified template are displayed as 'placeholders', and over 11 parameters can be displayed using a coded vertical-bar (as in "<small>&amp;#124;</small>''...''"). A keyword parameter can be used with equals code &amp;#61; or <nowiki>{{=}}</nowiki> or in nowiki-text: "&lt;nowiki>size=10&lt;/nowiki>" or all parameters as a string in <nowiki>"<nowiki>"</nowiki> tags; see ''[[#Examples|Examples]]'' at bottom. For more details, see [[{{TALKPAGENAME}}|this talk]] page.
+
: {{tlx{{\sandbox}}|tlx|Template|&lt;nowiki><nowiki>''first''|''second''|''third=something''|...|''999th''</nowiki>&lt;/nowiki>}} produces: {{tlx{{\sandbox}}|Template|<nowiki>first|second|third=something|...|999th</nowiki>}}
−
* '''''Exceptions:''''' If the intended template lists numerous/keyword parameters, then perhaps this template should really ''not'' be used, and just hardcode the usage with <code><nowiki>&lt;code&gt;&lt;nowiki&gt;</nowiki></code>, for example: <code><nowiki>&lt;code&gt;&lt;nowiki&gt;{{Anytemplate|arg1=23|size=250px|</nowiki><var>other parameters...</var><nowiki>}}&lt;/nowiki&gt;&lt;/code&gt;</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 <code><nowiki><pre>...</pre></nowiki></code>.
 
  
−
----
+
== Purpose and naming ==
  
−
* If given no additional parameters except ''<code>&nbsp;'template&nbsp;name'&nbsp;(<nowiki>{{{1}}}</nowiki>), </code>''&nbsp;it presents the same as the similar {{tl|Tl}} [[macro]] template -- a blue link nested in [[brackets|curly-braces]]-- the same as a user would apply the template without parameters, but with a noticably clearer font and spacing on most modern browsers.  
+
[[Wikt:mnemonic|Mnemonically]], "['''t''']emplate ['''l''']ink e['''x''']panded" (after {{tl|tl}}, "['''t''']emplate ['''l''']ink").
  
−
:* {{Tlx|Tl|Tl}} display compared to {{Tlx|Tlx|Tl}}: (Tl: {{Tl|Tl}} versus Tlx: {{Tlx|Tl}})  
+
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.
  
−
* Comparatively, {{Tlx|Tl}} will not take or display additional parameters, and for minor technical reasons, may be preferred for mere listing and referencing in long pages involving a lot of template expansions.
+
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|&amp;#124;}}..."). 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.
  
−
* {{tlx|Tlx}} has a named parameter ''subst''. Setting this parameter to any string of length 1 or greater will place the string "subst:" before the template name, linked to [[Help:Substitution]]. This is useful to indicate when a template should be substituted. For example {{tlx|Tlx|Welcome|<nowiki>subst=Y</nowiki>}} will display {{Tlx|Welcome|subst=Y}}.
+
; 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}}.
  
−
* Additionally, Tlx will take a 'named' parameter 'SISTER' to link interwiki to other sister projects such as one of these examples: '|SISTER=W:', 'Tlx|SISTER=M:', 'Tlx|SISTER=Q:', 'Tlx|SISTER=S:', allowing documentation or discourse about a template across interwiki boundaries. Small 'front end' Shell or convience templates {{Tlx|Tlxw}} and {{tlx|Tlxm}} are typing-aid templates available at Meta for automatic substitution in discussions about templates on Wikipedia or Meta.
+
===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}}&nbsp;&ndash; i.e. a link within [[Braces (punctuation)|braces]]&nbsp;&ndash; but in a [[monospaced font]]:
 +
** {{tc|tl|tl}} produces: {{tl|tl}}
 +
** {{tc|tlx|tl}} produces: {{tlx{{\sandbox}}|tl}}
 +
: {{tlf|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 [[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}}
 +
: 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.
 +
{{para|LANG}}
 +
: 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.
  
−
;This usage also applies to interwiki capable template variations:
+
== Documentation ==
−
# {{Tl|Tlxc}} -- which links to templates on Wikimedia Commons (The Commons).
 
−
# {{Tl|Tlxm}} -- which links to templates on Meta
 
−
# {{Tl|Tlxw}} -- which links to templates on Wikipedia
 
  
−
----
+
{{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}}'''&#124;'''{{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).
  
−
== Documentation ==
+
===Usage===
 +
:<code>{&#123;tlx{{!}}Templatename&#125;}</code>
 +
:<code>{&#123;tlx{{!}}Templatename{{!}}param&#125;}</code>
 +
:<code>{&#123;tlx{{!}}Templatename{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10&#125;}</code>
 +
:<code>{&#123;tlx{{!}}Templatename{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10&amp;#124;more&#125;}</code>
 +
:<code>{&#123;tlx{{!}}Templatename{{!}}param&amp;#61;value&#125;}</code>
 +
There are up to 10 placeholders for parameters of the specified template.
  
−
{&#123;[[Template:{{BASEPAGENAME}}|{{BASEPAGENAME}}]]&#125;}
+
===Examples===
−
is a generalization of {{Tl|Tl|x}}, {{Tl|Tlp|x|y}},
+
{{#switch:{{SITENAME}} |Wikipedia|Meta= |
−
etcetera with arguably better readable
+
; 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.
−
output. This depends on the browser, but too narrow
+
}}
−
uses of "'''{'''", "'''|'''", "'''}'''" in conjunction
 
−
with links can be hard to read.
 
  
−
=== Usage ===
+
{{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}}            | &#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}}
  
−
:<tt>{&#123;{{BASEPAGENAME}}{{!}}template name&#125;}</tt>
+
| {{tlx|tlx|x2|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}} | {{tlx{{\sandbox}}|x2|2=|3=two}} | empty really doesn't work
−
:<tt>{&#123;{{BASEPAGENAME}}{{!}}template name{{!}}param&#125;}</tt>
+
−
:<tt>{&#123;{{BASEPAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3&#125;}</tt>
+
| {{tlx|tlx|x2|<nowiki>2=one</nowiki>|two}} | {{tlx{{\sandbox}}|x2|two}} | "two" overrides "2{{=}}one"
−
:<tt>{&#123;{{BASEPAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3&amp;#124;more&#125;}</tt>
 
−
:<tt>{&#123;{{BASEPAGENAME}}{{!}}template name{{!}}param&amp;#61;value&#125;}</tt>
 
−
''Up to three placeholders for parameters of the specified template''
 
  
−
=== Examples ===
+
| {{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}}
−
{{#ifeq:{{SITENAME}}|Wikipedia|<!-- Skip message--->|
+
}}
−
{{#ifeq:{{SITENAME}}|Meta|<!-- No note needed --->|<!-- Other Sisters Note: --->
+
; Unlimited parameters as one {{tag|nowiki}} string
−
;Note: On the source sister projects, en.wikipedia and Meta, '''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{{\sandbox}}|tlx|convert|<nowiki>&lt;nowiki>14|m|ftin|abbr=out|sp=us&lt;/nowiki></nowiki>}}
−
}}}}
 
−
 
 
−
{| border="1" cellpadding="4" class="wikitable"
 
−
! Code
 
−
! Result
 
−
! Remark
 
−
|-
 
−
|{{Tlx|Tlx|x0}}
 
−
|{{Tlx|x0}}
 
−
||&#160;
 
−
|-
 
−
|{{Tlx|Tlx|Abc}}
 
−
|{{Tlx|Abc}}
 
−
||&#160;
 
−
|-
 
−
|{{Tlx|Tlx|ABC}}
 
−
|{{Tlx|ABC}}
 
−
||&#160;
 
−
|-
 
−
|{{Tlx|Tlx|AbC}}
 
−
|{{Tlx|AbC}}
 
−
||&#160;
 
−
|-
 
−
|{{Tlx|Tlx|x1|one}}
 
−
|{{Tlx|x1|one}}
 
−
||&#160;
 
−
|-
 
−
|{{Tlx|Tlx|x2|one|two}}
 
−
|{{Tlx|x2|one|two}}
 
−
||&#160;
 
−
|-
 
−
|{{Tlx|Tlx|x3|1<tt>&#124;</tt>2<tt>&#124;</tt>3}}
 
−
|{{Tlx|x3|1|2|3}}
 
−
||&#160;
 
−
|-
 
−
|{{Tlx|Tlx|x4|1<tt>&#124;</tt>2<tt>&#124;</tt>3|4}}
 
−
|{{Tlx|x4|1|2|3|4}}
 
−
|up to 5 parameters, then ...
 
−
|-
 
−
|{{Tlx|Tlx|x4|1<tt>&#124;</tt>2<tt>&#124;</tt>3&amp;#124;4}}
 
−
|{{Tlx|x4|1|2|3&#124;4}}
 
−
|align="right"|<tt>&amp;#124;</tt> for more
 
−
|-
 
−
|{{Tlx|Tlx|x1|x&#61;u}}
 
−
|{{Tlx|x1|x=u}}
 
−
|'''=''' won't work
 
−
|-
 
−
|{{Tlx|Tlx|x1|x&amp;#61;u}}
 
−
|{{Tlx|x1|x&#61;u}}
 
−
|align="right"|<tt>&amp;#61;</tt> is okay
 
−
|-
 
−
|{{Tlx|Tlx|x1|x<nowiki>{{=}}</nowiki>u}}
 
−
|{{Tlx|x1|x{{=}}u}}
 
−
|align="right"|<tt><nowiki>{{=}}</nowiki></tt> is okay
 
−
|-
 
−
|{{Tlx|Tlx|x1|&lt;nowiki&gt;x&#61;u&lt;/nowiki&gt;}}
 
−
|{{Tlx|x1|<nowiki>x=u</nowiki>}}
 
−
|align="right"|sticky nowiki is okay
 
−
|-
 
−
|{{Tlx|Tlx|x2|&#160;|two}}
 
−
|{{Tlx|x2| |two}}
 
−
|empty won't work
 
−
|-
 
−
|{{Tlx|Tlx|x2|&amp;#32;|two}}
 
−
|{{Tlx|x2|&#32;|two}}
 
−
|align="right"|<tt>&amp;#32;</tt> is okay
 
−
|-
 
−
|{{Tlx|Tlx|x2|&amp;nbsp;|two}}
 
−
|{{Tlx|x2|&nbsp;|two}}
 
−
|align="right"|<tt>&amp;nbsp;</tt> is okay
 
−
|-
 
−
|{{Tlx|Tlx|x2| &amp;#124; two}}
 
−
|{{Tlx|x2| &#124; two}}
 
−
|align="right"|<tt>&amp;#124;</tt> is okay
 
−
|-
 
−
|| {{Tlx|Tlx|x2| {&#123;!&#125;} two}}
 
−
|| {{Tlx|x2| {{!}} two}}
 
−
|align="right"|{{Tlx|!}} is dubious
 
−
|-
 
−
|| {{Tlx|Tlx|x2|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}}
 
−
|| {{Tlx|x2|2=|3=two}}
 
−
|empty really doesn't work
 
−
|-
 
−
|| {{Tlx|Tlx|x2|<nowiki>2=one</nowiki>|two}}
 
−
|| {{Tlx|x2|2=one|two}}
 
−
|'''two''' clobbers '''2=one'''
 
−
|-
 
−
|| {{Tlx|Tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}}
 
−
|| {{Tlx|x2|3=two|2=one}}
 
−
|align="right"|right to left okay
 
−
|-
 
−
|colspan=2| <tt><nowiki>{{Tlx</nowiki></tt>|convert|&lt;nowiki>14|m|ftin|abbr=out|sp=us&lt;/nowiki><tt><nowiki>}}</nowiki></tt>
 
−
|unlimited parameters as one nowiki string
 
−
|}
 
  
 
== See also ==
 
== See also ==
−
<includeonly>{{interwikitmp-grp|V=6|cat=Typing-aid templates |CATS=[[Category:Internal link templates|Tlx]][[Category:Interwiki link templates|Tlx]]}}</includeonly>
+
* {{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.
−
* [[Template:Tlxb]] &ndash; same as {{tl|Tlx}}, but gives the template name in boldface type (this can be useful when stressing the difference between two similarly named templates). [[Template:Tlb]] is the same, except it uses regular text instead of a monospaced non-proportional font.
+
* {{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.
−
* [[Template:Para]] &ndash; for giving examples of template parameters and values only, instead of entire templates with parameters.
+
* {{tl|para}}, for the presentation of template parameters and values (e.g. {{para|paraname|val}}, {{para|another}}).
−
 
 
−
<!--- Categories applied to both /doc style Documentation page and to the parent templates --->
 
  
−
<!-- Add the Categories for this doc or usage page (only-- not for the calling template) BELOW THIS LINE --->
+
== Template-linking templates ==
−
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
+
{{Template-linking templates}}
  
−
<includeonly>  
+
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |{{#ifeq:{{BASEPAGENAME}}|Tlx |
−
<!-- EDIT IN (calling) TEMPLATE CATEGORIES BELOW THIS LINE -->
+
[[Category:Internal template-link templates]]
−
[[Category:Typing-aid templates |{{PAGENAME}}]]  
+
[[Category:Interwiki link templates]]
−
[[Category:Internal link templates |{{PAGENAME}}]]
+
[[Category:Typing-aid templates]]
−
[[Category:Interwiki link templates |{{PAGENAME}}]]
 
  
−
<!-- EDIT/ADD TEMPLATE Interwiki's BELOW THIS LINE -->
+
}} }}</includeonly>
−
[[cy:Nodyn:Tlx]]
+
{{collapse top|Template data}}
−
[[de:Vorlage:Vorlage]]
+
<templatedata>
−
[[hsb:Předłoha:Tlx]]
+
{
−
[[hy:Կաղապար:Tlx]]
+
"params": {
−
[[ko:틀:Tlx]]
+
"1": {
−
[[ia:Patrono:Tlx]]
+
"label": "Template name",
−
[[os:Шаблон:Tlp]]
+
"description": "Name of the template to link",
−
[[ja:Template:Tlx]]
+
"example": "Tlx",
−
[[no:Mal:Tlx]]
+
"type": "wiki-template-name",
−
[[pt:Predefinição:Tlx]]
+
"required": true
−
[[ro:Format:Tlx]]
+
},
−
[[ru:Template:Tlx]]
+
"2": {
−
[[simple:Template:Tlx]]
+
"label": "1st parameter",
−
[[th:แม่แบบ:Tlx]]
+
"type": "string"
−
[[uk:Шаблон:Tlx]]
+
},
−
[[zh:Template:Tlx]]
+
"3": {
−
</includeonly>
+
"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>
 +
{{collapse bottom}}

Latest revision as of 20:28, 11 August 2017

Template:Mbox

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 {{Template:=}}:

{{tlx|Template|first{{=}}something|second|third{{=}}something|...|tenth}} produces: {{Template|firstTemplate:=something|second|thirdTemplate:=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 "&#124;..."). A keyword parameter can be used with equals code &#61; 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|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}}. 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&#124;more}}
{{tlx|Templatename|param&#61;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.

Template:Aligned table

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:Navbar

General-purpose formatting[edit]

Comparison of template-linking templates according to their style
Link style → Linked Unlinked Linked with subst Linked including braces Linked with alternative text
Text style ↓ ↓ {{tlg}} options1 → Template:N/a Template:Code Template:Code Template:Code Template:Code
Template:Code
normal Template:N/a {{tlg}}1
{{tl}}
{{tlp}}2
{{tlu}}3 		{{tlf}}2 {{tls}}
{{tlsp}} 		{{tn}} {{tla}}
code Template:Code
Template:Code4 		{{tl2}}
{{tlx}} 		{{tlc}}2
{{tld}}2
{{tnull}} 		{{tlxs}} colspan="2" Template:N/a
kbd
monospace 		Template:Code {{tltt}}5
{{tltt2}}5 		Template:N/a {{tltts}}5
{{tltts3}}5
{{tltss}}6 		colspan="2" Template:N/a
bold Template:Code {{tlb}} rowspan="3" colspan="4" Template:N/a
bold+code Template:Code {{tlxb}}
italic+code Template:Code {{tlxi}}

Other formatting templates[edit]

Code example Effect Notes
{{tl2|Hatnote|lang=fr}} {{hatnote}} Supports linking to sister projects (e.g., fr:Hatnote)
{{tlu|User:Ahunt/SSHFS}} {{User:Ahunt/SSHFS}} Supports linking to any namespace
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}} Template:Demo Shows code and example
{{xpd|Hatnote|Some hatnote text}} Template:If Shows code, example and a link to expand the template code
{{para|title|<var>book title</var>}} |title=book title Formats template parameters for display, with or without values
{{elc|Template:Hatnote}}
{{elc|Template:Hatnote|Hatnote}}		 Template:Elc
Template:Elc		 Formats wikilink, with optional piped link text and blended suffix

With utility links[edit]

Code example Effect
{{lts|Hatnote}} Template:Lts
{{t links|Hatnote}} Hatnote (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test) · Module:hatnote
{{tfd links|Hatnote}} Template:Hatnote (edit · talk · history · links · logs · subpages · delete)
{{tiw|Hatnote}} Template:hatnote (backlinks edit)
{{tltt|Hatnote}} {{Hatnote}}
{{tetl|Hatnote}} {{Hatnote}}
links talk view
{{tsetl|Hatnote}} {{subst:Hatnote}}
 links talk view
{{ti|Hatnote}} Template:Hatnote (talk⧼dot-separator⧽links⧼dot-separator⧽edit)
{{tic|Hatnote}} Template:Hatnote (talk links edit)
{{tiw|Hatnote}} Template:Hatnote (backlinks edit)
{{tlt|Hatnote}} {{Hatnote}} (talk)
{{ttl|Hatnote}} Template:Main other{{Hatnote}} (t/l)
{{twlh|Hatnote}} Template:Hatnote (links, talk)


Template:Collapse top <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> Template:Collapse bottom

Retrieved from "https://wiki.minr.org/index.php?title=Template:Tlx/doc&oldid=4148"