Editing Template:Tlx/doc
From MINR.ORG WIKI
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
− | <includeonly>{{small |1= | + | <includeonly><!-- |
+ | ---------- /doc page model (for interwiki use) ----------- | ||
+ | -->{{small | ||
+ | |1= ''This {{tlx|tlx}} template documentation is [[w:Wikipedia:Template doc page pattern|transcluded]] for all ''tlx family templates (tlx, tlxc, tlxw, tlxb)'' [<span class="plainlinks">[{{fullurl:Template:Tlx/doc |action=edit}} edit]</span>].<!-- | ||
+ | -->{{#ifeq:{{SITENAME}}|Meta | |[[M:template:{{PAGENAMEE}}|master page]] }}<!-- | ||
+ | -->}}</includeonly><!-- | ||
− | --><noinclude>{{Documentation subpage}}{{clear}}</noinclude> | + | --><noinclude>{{Documentation subpage}}<br/><hr/><br/>{{clear}}</noinclude> |
− | {{ | + | {{high-use|850,000+}} |
− | |||
== Basic use == | == Basic use == | ||
− | ''(Note: In the following examples, [[Ellipsis| | + | ''(Note: In the following examples, [[Ellipsis|three dots]] indicate where parameters have been omitted.)'' |
− | : {{tlx | + | : {{tlx |tlx|Template|''first parameter''|''second parameter''|''third''|...|''tenth''}} <!-- |
+ | -->{{bigger|→}} {{tlx |Template|''first parameter''|''second parameter''|''third''|...|''tenth''}} | ||
− | Where parameters might contain one or more equals-signs ("="), replace each equals-sign with {{ | + | Where parameters might contain one or more equals-signs ("="), replace each equals-sign with {{tlx|{{=}}}}: |
− | : {{tlx | + | : {{tlx |tlx|Template|''first<nowiki>{{=}}</nowiki>something''|''second''|''third<nowiki>{{=}}</nowiki>something''|...|tenth}} <!-- |
+ | -->{{bigger|→}} {{tlx |Template|''first{{=}}something''|''second''|''third{{=}}something''|...|tenth}} | ||
− | For more than ten parameters, possibly also containing equals-signs, use | + | For more than ten parameters, possibly also containing equals-signs, use: |
− | : {{tlx | + | : {{tlx |tlx|Template|<nowiki><nowiki>''first''|''second''|''third=something''|...|''999th''</nowiki></nowiki>}} <!-- |
+ | -->{{bigger|→}} {{Tlx|Template|<nowiki>first|second|third=something|...|999th</nowiki>}} | ||
== Purpose and naming == | == Purpose and naming == | ||
− | [[Wikt:mnemonic|Mnemonically]], "['''t''']emplate ['''l''']ink e['''x''']panded" (after {{ | + | [[Wikt:mnemonic|Mnemonically]], "['''t''']emplate ['''l''']ink e['''x''']panded" (after <code>{{tlx|tl}}</code>, "['''t''']emplate ['''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. | 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 " | + | 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;</small>''...''"). 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. |
− | + | * '''''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}}. | |
− | |||
− | 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}} | ||
− | : {{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=== | ===Parameters=== | ||
− | * If | + | * If given no additional parameters except ''<code> 'template name' (<nowiki>{{{1}}}</nowiki>), </code>'' it presents the same as the similar {{tl|Tl}} [[Macro (computer science)|macro]] template -- a blue link nested in [[brackets|curly-braces]]-- the same as a user would apply the template without parameters, but with a noticeably clearer font and spacing on most modern browsers. |
− | ** {{ | + | ** {{Tlx|Tl|Tl}} display compared to {{Tlx|Tlx|Tl}}: (Tl: {{Tl|Tl}} versus Tlx: {{Tlx|Tl}}) |
− | + | * 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. | |
− | + | * {{tlx|Tlx}} has a named parameter {{para|subst}}. Setting this parameter to any non-blank value will place the string "<code>subst:</code>" before the template name, linked to [[Help:Substitution]]. This is useful to indicate when a template should be substituted. For example {{tlx|Tlx|Welcome|3=subst=Y}} will display {{Tlx|Welcome|subst=Y}}. This is similar to the action of the {{tlx|tlxs}} template: {{tlx|Tlxs|Welcome}} will display {{Tlxs|Welcome}}. | |
− | + | * Additionally, Tlx will take a named parameter {{para|SISTER}} to link interwiki to [[H:IW|other sister projects]] such as one of these examples: {{para|SISTER|M:}} ([[m:|Meta]]), {{para|SISTER|Q:}} ([[q:|WikiQuote]]), {{para|SISTER|S:}} ([[s:|WikiSource]]), etc. allowing documentation or discourse about a template across interwiki boundaries. | |
− | + | * Tlx will also take a named parameter {{para|LANG}} to link to [[H:ILL|other language Wikipedias]], such as one of these examples: {{para|LANG|de:}} ([[:de:|German]]), {{para|LANG|sv:}} ([[:sv:|Swedish]]), etc. allowing documentation or discourse about a template across language boundaries. | |
− | {{para|subst}} | ||
− | |||
− | {{para|SISTER}} | ||
− | |||
− | {{para|LANG}} | ||
− | |||
== Documentation == | == Documentation == | ||
− | + | {{tlx|Tlx}} | |
− | {{ | + | is a generalization of {{Tl|Tl|x}}, {{Tl|Tlp|x|y}}, |
+ | etc., with arguably better-readable | ||
+ | output. This depends on the browser, but too-narrow | ||
+ | uses of "'''{'''", "'''|'''", "'''}'''" in conjunction | ||
+ | with links can be hard to read when not monospaced (and hard to click on; for uses like <code><nowiki>{{!}}</nowiki></code>, see {{tlx|tln}}, which makes the click target bigger). | ||
===Usage=== | ===Usage=== | ||
− | :<code>{{tlx{{!}} | + | :<code>{{tlx{{!}}template name}}</code> |
− | :<code>{{tlx{{!}} | + | :<code>{{tlx{{!}}template name{{!}}param}}</code> |
− | :<code>{{tlx{{!}} | + | :<code>{{tlx{{!}}template name{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10}}</code> |
− | :<code>{{tlx{{!}} | + | :<code>{{tlx{{!}}template name{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10&#124;more}}</code> |
− | :<code>{{tlx{{!}} | + | :<code>{{tlx{{!}}template name{{!}}param&#61;value}}</code> |
− | + | ''Up to 10 placeholders for parameters of the specified template'' | |
===Examples=== | ===Examples=== | ||
Line 63: | Line 64: | ||
|class=wikitable |style=border:1;cellpadding:4; | |class=wikitable |style=border:1;cellpadding:4; | ||
|row1style=background:whitesmoke;font-weight:bold; | |row1style=background:whitesmoke;font-weight:bold; | ||
− | | Code | Result | + | | Code | Result | Remarks |
− | | {{tlx|tlx|x0}} | {{tlx | + | | {{tlx|tlx|x0}} | {{tlx|x0}} |   |
− | | {{tlx|tlx|Abc}} | {{tlx | + | | {{tlx|tlx|Abc}} | {{tlx|Abc}} |   |
− | | {{tlx|tlx|ABC}} | {{tlx | + | | {{tlx|tlx|ABC}} | {{tlx|ABC}} |   |
− | | {{tlx|tlx|AbC}} | {{tlx | + | | {{tlx|tlx|AbC}} | {{tlx|AbC}} |   |
− | | {{tlx|tlx|x1|one}} | {{tlx | + | | {{tlx|tlx|x1|one}} | {{tlx|x1|one}} |   |
− | | {{tlx|tlx|x2|one|two}} | {{tlx | + | | {{tlx|tlx|x2|one|two}} | {{tlx|x2|one|two}} |   |
<!--(Parameter number:)--> | <!--(Parameter number:)--> | ||
− | | {{tlx|tlx|x3|1|2|3|4|5|6|7|8|9|10}} | {{tlx | + | | {{tlx|tlx|x3|1|2|3|4|5|6|7|8|9|10}} | {{tlx|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 | + | | {{tlx|tlx|x4|1|2|3|4|5|6|7|8|9|10|11}} | {{tlx|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 | + | | {{tlx|tlx|x5|1|2|3|4|5|6|7|8|9|10&#124;11}} | {{tlx|x5|1|2|3|4|5|6|7|8|9|10|11}} | {{align|right|...<code>&#124;</code> for more}} |
<!--(Equals-sign:)--> | <!--(Equals-sign:)--> | ||
− | | {{tlx|tlx|x1|x=u}} | {{tlx | + | | {{tlx|tlx|x1|x=u}} | {{tlx|x1|x=u}} | the straightforward equals-sign won't work... |
− | | {{tlx|tlx|x1|x&#61;u}} | {{tlx | + | | {{tlx|tlx|x1|x&#61;u}} | {{tlx|x1|x=u}} | {{align|right|...but <code>&#61;</code> is okay}} |
− | | {{tlx|tlx|x1|x<nowiki>{{=}}</nowiki>u}} | {{tlx | + | | {{tlx|tlx|x1|x<nowiki>{{=}}</nowiki>u}} | {{tlx|x1|x{{=}}u}} | {{align|right|...and <code><nowiki>{{=}}</nowiki></code> is okay}} |
− | | {{tlx|tlx|x1|<nowiki>x=u</nowiki>}} | {{tlx | + | | {{tlx|tlx|x1|<nowiki>x=u</nowiki>}} | {{tlx|x1|<nowiki>x=u</nowiki>}} | {{align|right|sticky nowiki also okay}} |
<!--(Empty/space/pipe:)--> | <!--(Empty/space/pipe:)--> | ||
− | | {{tlx|tlx|x2| |two}} | {{tlx | + | | {{tlx|tlx|x2| |two}} | {{tlx|x2| |two}} | empty won't work... |
− | | {{tlx|tlx|x2|&#32;|two}} | {{tlx | + | | {{tlx|tlx|x2|&#32;|two}} | {{tlx|x2| |two}} | {{align|right|...but <code>&#32;</code> is okay}} |
− | | {{tlx|tlx|x2|&nbsp;|two}} | {{tlx | + | | {{tlx|tlx|x2|&nbsp;|two}} | {{tlx|x2| |two}} | {{align|right|...<code>&nbsp;</code> is also okay}} |
− | | {{tlx|tlx|x2|{{tag|nowiki|s}}|two}} | {{tlx | + | | {{tlx|tlx|x2|{{tag|nowiki|s}}|two}} | {{tlx|x2|<nowiki/>|two}} | {{align|right|{{tag|nowiki|s}} handles the space}} |
− | | {{tlx|tlx|x2| &#124; two}} | {{tlx | + | | {{tlx|tlx|x2| &#124; two}} | {{tlx|x2| | two}} | {{align|right|<code>&#124;</code> is okay}} |
− | | {{tlx|tlx|x2| {{!}} two}} | {{tlx | + | | {{tlx|tlx|x2| {{!}} 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=</nowiki>|<nowiki>3=two</nowiki>}} | {{tlx | + | | {{tlx|tlx|x2|<nowiki>2=one</nowiki>|two}} | {{tlx|x2|2=one|two}} | "two" overrides "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}} | |
− | | {{tlx|tlx|x2|<nowiki>2=one</nowiki>|two}} | {{tlx | ||
− | |||
− | | {{tlx|tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}} | {{tlx | ||
}} | }} | ||
; Unlimited parameters as one {{tag|nowiki}} string | ; Unlimited parameters as one {{tag|nowiki}} string | ||
− | : {{tlx | + | : {{tlx|tlx|convert|<nowiki><nowiki>14|m|ftin|abbr=out|sp=us</nowiki></nowiki>}} |
== See also == | == See also == | ||
− | * | + | * [[Template:Tlxb]], a version of {{tlspc|tlx}} where the template name is shown in bold. |
− | *: | + | *: [[Template:Tlb]], a version of {{tlspc|tl}} where the template name is shown in bold. |
− | * | + | * [[Template:Temt]], a version of {{tlspc|tlx}} that handles templates whose names include "Template:" and pages outside the Template: [[Wikipedia:Namespace|namespace]] that are treated as templates. |
− | * | + | * [[Template:Para]], for the presentation of template parameters and values (e.g. {{para|paraname|val}}, {{para|another}}, etc). |
− | |||
{{Template-linking templates}} | {{Template-linking templates}} | ||
− | <includeonly> | + | <!--- 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 ---> | ||
+ | |||
+ | <includeonly> | ||
+ | <!-- EDIT IN (calling) TEMPLATE CATEGORIES BELOW THIS LINE --> | ||
[[Category:Internal template-link templates]] | [[Category:Internal template-link templates]] | ||
[[Category:Interwiki link templates]] | [[Category:Interwiki link templates]] | ||
− | [[Category:Typing-aid templates]] | + | [[Category:Typing-aid templates]] |
− | + | [[de:Vorlage:Vorlage]] | |
− | + | </includeonly> | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | </ | ||
− |