Difference between revisions of "Template:Tlx/doc"

From Final Fantasy XIV Online Wiki
Jump to navigation Jump to search
(Created page with "<includeonly>{{small |1=Note: This documentation for {{tlx|tlx}} is also transcluded by its derivatives {{tlx|tlxb}}, {{tlx|tlxc}}, {...")
 
m
 
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}}, {{tlx|tlxU}} (<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>{{#ifeq:{{BASEPAGENAME}}|Tlx |{{High-risk|1,070,000+}} }}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.)'': {{tlx{{\sandbox}}|tlx|Template|''first parameter''|''second parameter''|''third''|…|''tenth''}} produces: {{tlx{{\sandbox}}|Template|''first parameter''|''second parameter''|''third''|…|''tenth''}}Where parameters might contain one or more equals-signs ("="), replace each equals-sign with {{tlf|{{=}}}}:: {{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:: {{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>}}== Purpose and naming ==[[Wikt:mnemonic|Mnemonically]], "['''t''']emplate ['''l''']ink e['''x''']panded" (after {{tl|tl}}, "['''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.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.; ExceptionsIf 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}}&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.== 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|'''&#124;'''}}", "{{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).===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.===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 |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}} | {{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>}}== 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}}, etc).== Template-linking templates =={{Template-linking templates}}<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |{{#ifeq:{{BASEPAGENAME}}|Tlx |[[Category:Internal template-link templates]][[Category:Interwiki link templates]][[Category:Typing-aid templates]]}} }}</includeonly>
<noinclude>{{documentation subpage}}</noinclude>
{{tlx|tlx}} is used to show an example of a template's usage accompanied by one or more parameters, without also causing the template to be called.
 
'''Syntax'''
<pre>
    {&#123;tlx|Templatename|param1|...&#125;}
</pre>
Takes both ''named'' and ''unnamed'' parameters:
: ;Unnamed
: There are up to 10 placeholders for parameters of the specified template.
:: <pre>{&#123;tlx|Templatename|1|2|3|4|5|6|7|8|9|10&#125;}</pre>
: ;Named
: Where named fields are set to values, replace the equals-sign with <nowiki>#61;</nowiki>
:: <pre>{&#123;tlx|Templatename|param&amp;#61;value&#125;}</pre>
 
<includeonly>
<!-- Categories below this line, please -->
[[Category:Templates]]
[[Category:Template documentation pages]]
</includeonly>

Latest revision as of 20:50, 5 December 2015

Template:Mbox {{tlx}} is used to show an example of a template's usage accompanied by one or more parameters, without also causing the template to be called.

Syntax 

    {{tlx|Templatename|param1|...}}

Takes both named and unnamed parameters:

;Unnamed
There are up to 10 placeholders for parameters of the specified template. 
{{tlx|Templatename|1|2|3|4|5|6|7|8|9|10}}
;Named
Where named fields are set to values, replace the equals-sign with #61; 
{{tlx|Templatename|param&#61;value}}

Retrieved from "https://ffxiv.consolegameswiki.com/mediawiki/index.php?title=Template:Tlx/doc&oldid=80487"