Munurin millum rættingarnar hjá "Fyrimynd:Tlx/doc"
s Bot: Migrating interwiki links, now provided by Wikidata on d:q5896717 |
EileenSanda (kjak | íkøst) No edit summary |
||
Linja 1: | Linja 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><!-- |
|||
<includeonly><!-----------------Interwiki Doc page pattern-------------------> |
|||
<small>''This '{{Tlx|Tlx}}' template documentation is [[w:Wikipedia:Template doc page pattern|transcluded]] for all ''Tlx family templates (Tlx, Tlxc, Tlxm, Tlxw)'' [<span class="plainlinks">[{{fullurl:Template:Tlx/doc |action=edit}} edit]</span>].{{#ifeq:{{SITENAME}}|Meta| |[[M:template:{{PAGENAMEE}}|Masterpage]] |
|||
}}</small></includeonly><noinclude> |
|||
{{template doc page viewed directly|yes}} |
|||
{{-}} |
|||
{{interwikitmp-grp |
|||
|V=D |
|||
|cats= |
|||
|inhib=yes |
|||
|wdy=|wqt=|wsr=|wnw= |
|||
|{{PAGENAME}}|{{PAGENAME}}}}</noinclude> |
|||
--><noinclude>{{Documentation subpage}}{{clear}}</noinclude> |
|||
<!-- Parent template(s) usage Begins: ---> |
|||
{{#ifeq:{{BASEPAGENAME}}|Tlx |{{High-risk|1,070,000+}} }} |
|||
<includeonly>{{interwikitmp-grp|V=6|cat=Typing-aid templates |CATS=[[Category:Internal link templates|Tlx]][[Category:Interwiki link templates|Tlx]]}}</includeonly> |
|||
This template is used to show example template usage without expanding the template itself. |
|||
== Basic use == |
|||
{{tlx|tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}} → {{tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}} |
|||
''(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''}} |
|||
'''<big>Purpose and naming:</big>''' [[Wikt:mnemonic|Mnemonically]] ''''T'''emplate '''l'''ist e'''x'''panded'... after <tt>{{tlx|tl}}</tt> '''T'''emplate '''l'''ist' |
|||
Where parameters might contain one or more equals-signs ("="), replace each equals-sign with {{tlf|{{=}}}}: |
|||
* This template takes another ''template-name'' and some associated [[w:pipe-trick|pipe-tricked]] [http://meta.wikimedia.org/wiki/Parameter#Parameters (numbered) parameters] (or 'pass parameters'), and aggregates them into an 'example demonstration' of how the ''template-name'' template might be used. It's primary use is in instruction and documentation such as this passage. |
|||
: {{tlx{{\sandbox}}|tlx|Template|''first''<nowiki>{{=}}</nowiki>''something''|''second''|''third''<nowiki>{{=}}</nowiki>''something''|...|tenth}} produces: {{tlx{{\sandbox}}|Template|''first{{=}}something''|''second''|''third{{=}}something''|...|''tenth''}} |
|||
For more than ten parameters, possibly also containing equals-signs, use {{tag|nowiki}} thus: |
|||
* Up to five pass parameters (numbered) for the specified template are displayed as 'placeholders', and more parameters are shown as "<tt>|</tt>''...''", for details see the [[w:{{TALKPAGENAME}}|this talk]] page. |
|||
: {{tlx{{\sandbox}}|tlx|Template|<nowiki><nowiki>''first''|''second''|''third=something''|...|''999th''</nowiki></nowiki>}} produces: {{tlx{{\sandbox}}|Template|<nowiki>first|second|third=something|...|999th</nowiki>}} |
|||
== Purpose and naming == |
|||
---- |
|||
[[Wikt:mnemonic|Mnemonically]], "['''t''']emplate ['''l''']ink e['''x''']panded" (after {{tl|tl}}, "['''t''']emplate ['''l''']ink"). |
|||
* If given no additional parameters except ''<code> 'template name' (<nowiki>{{{1}}}</nowiki>), </code>'' it presents the same as the similar {{tl|Tl}} [[W:macro|macro]] template -- a blue link nested in [[W: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. |
|||
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. |
|||
:* {{Tlx|Tl|Tl}} display compared to {{Tlx|Tlx|Tl}}: (Tl: {{Tl|Tlx}} versus Tlx: {{Tlx|Tl}}) |
|||
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. |
|||
* Comparatively, {{Tlx|Tl}} will not take or display additional parameters, and for minor technical reasons, may preferred for mere listing and referencing in long pages involving a lot of template expansions[[W:WP:DPP|1]]. |
|||
; Exceptions |
|||
* 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. |
|||
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, {{tlf|tlx}}'s output is the same as {{tl|tl}} – i.e. a link within [[Braces (punctuation)|braces]] – 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 |
|||
;This usage also applies to interwiki capable template variations: |
|||
{{para|subst}} |
|||
# {{Tl|Tlxc}} -- which links to templates on Wikimedia Commons (The Commons). |
|||
: 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}}. |
|||
# {{Tl|Tlxm}} -- which links to templates on Meta |
|||
{{para|SISTER}} |
|||
# {{Tl|Tlxw}} -- which links to templates on Wikipedia |
|||
: 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. |
|||
== 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 "{{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). |
|||
==Documentation== |
|||
===Usage=== |
|||
{{[[Template:{{PAGENAME}}|{{PAGENAME}}]]}} |
|||
:<code>{{tlx{{!}}Templatename}}</code> |
|||
is a generalization of {{Tlxw|Tl|x}}, {{Tlxw|Tlp|x|y}}, |
|||
:<code>{{tlx{{!}}Templatename{{!}}param}}</code> |
|||
etcetera with arguably better readable |
|||
:<code>{{tlx{{!}}Templatename{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10}}</code> |
|||
output. This depends on the browser, but too narrow |
|||
:<code>{{tlx{{!}}Templatename{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10&#124;more}}</code> |
|||
uses of "'''{'''", "'''|'''", "'''}'''" in conjunction |
|||
:<code>{{tlx{{!}}Templatename{{!}}param&#61;value}}</code> |
|||
with links can be hard to read. |
|||
There are up to 10 placeholders for parameters of the specified template. |
|||
{{#ifeq:{{PAGENAME}}|Tlx/doc|| |
|||
=== Usage === |
|||
===Examples=== |
|||
:<tt>{{{{PAGENAME}}|template name}}</tt> |
|||
{{#switch:{{SITENAME}} |Wikipedia|Meta= | |
|||
:<tt>{{{{PAGENAME}}|template name|param}}</tt> |
|||
; 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. |
|||
:<tt>{{{{PAGENAME}}|template name|1|2|3}}</tt> |
|||
}} |
|||
:<tt>{{{{PAGENAME}}|template name|1|2|3&#124;more}}</tt> |
|||
:<tt>{{{{PAGENAME}}|template name|param&#61;value}}</tt> |
|||
''Up to three placeholders for parameters of the specified template''}} |
|||
{{Aligned table |cols=3 |
|||
=== Examples === |
|||
|class=wikitable |style=border:1;cellpadding:4; |
|||
{{#ifeq:{{SITENAME}}|Wikipedia|<!-- Skip message--->| |
|||
|row1style=background:whitesmoke;font-weight:bold; |
|||
{{#ifeq:{{SITENAME}}|Meta|<!-- No note needed --->|<!-- Other Sisters Note: ---> |
|||
| Code | Result | Remarks |
|||
;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|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 |
|||
{| border="1" cellpadding="4" class="wikitable" |
|||
! Code |
|||
| {{tlx|tlx|x2|<nowiki>2=one</nowiki>|two}} | {{tlx{{\sandbox}}|x2|two}} | "two" overrides "2{{=}}one" |
|||
! Result |
|||
! Remark |
|||
|- |
|||
|{{Tlx|SISTER=W:|Tlx|x0}} |
|||
|{{Tlx|SISTER=W:|x0}} |
|||
||  |
|||
|- |
|||
|{{Tlx|SISTER=W:|Tlx|x1|one}} |
|||
|{{Tlx|SISTER=W:|x1|one}} |
|||
||  |
|||
|- |
|||
|{{Tlx|SISTER=W:|Tlx|x2|one|two}} |
|||
|{{Tlx|SISTER=W:|x2|one|two}} |
|||
||  |
|||
|- |
|||
|{{Tlx|SISTER=W:|Tlx|x3|1<tt>|</tt>2<tt>|</tt>3}} |
|||
|{{Tlx|SISTER=W:|x3|1|2|3}} |
|||
||  |
|||
|- |
|||
|{{Tlx|SISTER=W:|Tlx|x4|1<tt>|</tt>2<tt>|</tt>3|4}} |
|||
|{{Tlx|SISTER=W:|x4|1|2|3|4}} |
|||
|up to 5 parameters, then ... |
|||
|- |
|||
|{{Tlx|SISTER=W:|Tlx|x4|1<tt>|</tt>2<tt>|</tt>3&#124;4}} |
|||
|{{Tlx|SISTER=W:|x4|1|2|3|4}} |
|||
|align="right"|<tt>&#124;</tt> for more |
|||
|- |
|||
|{{Tlx|SISTER=W:|Tlx|x1|x=u}} |
|||
|{{Tlx|SISTER=W:|x1|x=u}} |
|||
|'''=''' won't work |
|||
|- |
|||
|{{Tlx|SISTER=W:|Tlx|x1|x&#61;u}} |
|||
|{{Tlx|SISTER=W:|x1|x=u}} |
|||
|align="right"|<tt>&#61;</tt> is okay |
|||
|- |
|||
|{{Tlx|SISTER=W:|Tlx|x1|<nowiki>x=u</nowiki>}} |
|||
|{{Tlx|SISTER=W:|x1|<nowiki>x=u</nowiki>}} |
|||
|align="right"|sticky nowiki is okay |
|||
|- |
|||
|{{Tlx|SISTER=W:|Tlx|x2| |two}} |
|||
|{{Tlx|SISTER=W:|x2| |two}} |
|||
|empty won't work |
|||
|- |
|||
|{{Tlx|SISTER=W:|Tlx|x2|&#32;|two}} |
|||
|{{Tlx|SISTER=W:|x2| |two}} |
|||
|align="right"|<tt>&#32;</tt> is okay |
|||
|- |
|||
|{{Tlx|SISTER=W:|Tlx|x2|&nbsp;|two}} |
|||
|{{Tlx|SISTER=W:|x2| |two}} |
|||
|align="right"|<tt>&nbsp;</tt> is okay |
|||
|- |
|||
|{{Tlx|SISTER=W:|Tlx|x2| &#124; two}} |
|||
|{{Tlx|SISTER=W:|x2| | two}} |
|||
|align="right"|<tt>&#124;</tt> is okay |
|||
|- |
|||
|| {{Tlx|SISTER=W:|Tlx|x2| {{!}} two}} |
|||
|| {{Tlx|SISTER=W:|x2| {{!}} two}} |
|||
|align="right"|{{Tlx|SISTER=W:|!}} is dubious |
|||
|- |
|||
|| {{Tlx|SISTER=W:|Tlx|x2|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}} |
|||
|| {{Tlx|SISTER=W:|x2|2=|3=two}} |
|||
|empty really doesn't work |
|||
|- |
|||
|| {{Tlx|SISTER=W:|Tlx|x2|<nowiki>2=one</nowiki>|two}} |
|||
|| {{Tlx|SISTER=W:|x2|2=one|two}} |
|||
|'''two''' clobbers '''2=one''' |
|||
|- |
|||
|| {{Tlx|SISTER=W:|Tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}} |
|||
|| {{Tlx|SISTER=W:|x2|3=two|2=one}} |
|||
|align="right"|right to left okay |
|||
|} |
|||
| {{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}} |
|||
[[Bólkur:Sloðarfyrimyndir]] |
|||
}} |
|||
; Unlimited parameters as one {{tag|nowiki}} string |
|||
: {{tlx{{\sandbox}}|tlx|convert|<nowiki><nowiki>14|m|ftin|abbr=out|sp=us</nowiki></nowiki>}} |
|||
== See also == |
|||
<!--- Categories applied to both /doc style Documentation page and to the parent templates ---> |
|||
* {{tl|tlxb}}, a version of {{tlf|tlx}} where the template name is shown in bold. |
|||
[[Category:Templates using ParserFunctions|{{{PAGENAME}}}]] |
|||
*: {{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}}, etc). |
|||
== Template-linking 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> |
|||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |{{#ifeq:{{BASEPAGENAME}}|Tlx | |
|||
<includeonly> |
|||
[[Category:Internal template-link templates]] |
|||
<!-- EDIT IN (calling) TEMPLATE CATEGORIES BELOW THIS LINE --> |
|||
[[Category: |
[[Category:Interwiki link templates]] |
||
[[Category:Typing-aid templates]] |
|||
[[Bólkur:Sloðarfyrimyndir|{{PAGENAME}}]] |
|||
[[Category:Templates using ParserFunctions|{{{PAGENAME}}}]] |
|||
}} }}</includeonly> |
|||
<!-- EDIT/ADD TEMPLATE Interwiki's BELOW THIS LINE --> |
|||
[[Template:Tlx]] |
|||
[[ru:Template:Tlx]] |
|||
</includeonly> |
Endurskoðan frá 29. jul 2015 kl. 08:20
Hetta er ein dokumentatión undirsíða til Fyrimynd:Tlx. Hon inniheldur kunning um nýtsluna, bólkar og um annað innihald, ið ikki er við í uppruna fyrimynd síðuni. |
Henda fyrimynd verður nýtt á 1,070,000+ síðum. Fyri at sleppa undan stórum órógvi og óneyðugum server load, so eiga allar broytingar til hesa fyrimynd fyrst at verða royndar í /sandbox ella /testcases subpages, ella á tínum egnu brúkarasíðum. Tá ið tú hevur sæð, hvussu broytingar tínar síggja út á einari royndarsíðu, so kunnu broytingarnar goymast á hesi síðu við bert einari rætting. Vinarliga umhugsa at kjakast um ætlaðar broytingar á kjaksíðuni áðrenn tú gert broytingar her. |
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.)
{{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
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
- 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
{{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
{{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
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|9|10}} | |
{{tlx|x4|1|2|3|4|5|6|7|8|9|10|11}} | {{x4|1|2|3|4|5|6|7|8|9|10|…}} | 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|9|10|11}} | ...
| 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
- {{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=
, etc).
Template-linking templates
General-purpose formatting
Link style → | Linked | Unlinked | Linked with subst | Linked including braces | Linked with alternative text | |
---|---|---|---|---|---|---|
Text style ↓ | ↓ {{tlg}} options1 →
|
N/A |
|
|
|
|
Normal | N/A | {{tlg}} 1, 2{{tl}} {{tlp}} 2{{tlu}} 4
|
{{tlf}} 2
|
{{tls}} {{tlsp}}
|
{{tn}}
|
{{tla}}
|
Code
|
or
|
{{tlx}} {{tltt}} {{tltt2}}
|
{{tlc}} 2{{tld}} 2{{tnull}}
|
{{tlxs}} {{tltts}} {{tltts3}} {{tltss}} 3
|
N/A | |
Bold |
|
{{tlb}}
|
N/A | |||
Bold code
|
|
{{tlxb}}
| ||||
Italic code
|
|
{{tlxi}}
|
- 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>
. - 4 Allows links to templates in any namespace.
Other formatting templates
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 |
{{xpd|Hatnote|Some hatnote text}} |
"{{hatnote|Some hatnote text}}" gives "Some hatnote text " [1] |
Shows code, example and a link to expand the template code |
With utility links
Code example | Effect |
---|---|
{{lts|Hatnote}} |
Template:Hatnote(rætta kjak leinkjur søgan) |
{{t links|Hatnote}} |
Hatnote (edit · talk · history · links · /subpages · /doc · /doc edit · /sbox · /sbox diff · /test · Module:hatnote) |
{{tfd links|Hatnote}} |
Template:Hatnote (rætta⧼tpt-languages-separator⧽kjak⧼tpt-languages-separator⧽søga⧼tpt-languages-separator⧽leinkjur⧼tpt-languages-separator⧽loggar⧼tpt-languages-separator⧽undirsíðir⧼tpt-languages-separator⧽strika) |
{{tiw|Hatnote}} |
Template:hatnote (backlinks rætta) |
{{tltt|Hatnote}} |
{{Hatnote}}
|
{{tetl|Hatnote}} |
{{ Hatnote }} |
{{tsetl|Hatnote}} |
{{ subst: Hatnote }} |
{{ti|Hatnote}} |
Fyrimynd:Hatnote (kjak · links · rætta) |
{{tic|Hatnote}} |
Fyrimynd:Hatnote (kjak links rætta) |
{{tiw|Hatnote}} |
Template:Hatnote (backlinks rætta) |
{{tlt|Hatnote}} |
{{Hatnote}} (kjak) |
{{ttl|Hatnote}} |
{{Hatnote}} (t/l) |
{{twlh|Hatnote}} |
Fyrimynd:Hatnote (links, kjak) |