Difference between revisions of "Template:Tlx/doc"
Jump to navigation
Jump to search
m (Death to stray HTML) |
m (moved Template:tlx/doc to Template:Tlx/doc: move to Uppercase) |
||
(2 intermediate revisions by one other user not shown) | |||
Line 3: | Line 3: | ||
}}</small></includeonly><noinclude> | }}</small></includeonly><noinclude> | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
− | + | <br style="clear:both;" /> | |
</noinclude> | </noinclude> | ||
Line 13: | Line 13: | ||
== Purpose and naming == | == Purpose and naming == | ||
− | [http://en.wiktionary.org/wiki/mnemonic Mnemonically]] ''''T'''emplate '''l'''ink e'''x'''panded'. After <tt>{{tlx| | + | [http://en.wiktionary.org/wiki/mnemonic Mnemonically]] ''''T'''emplate '''l'''ink e'''x'''panded'. After <tt>{{tlx|tl}}</tt> ''''T'''emplate '''l'''ink'. |
* This template takes another ''template-name'' and some associated [http://en.wikipedia.org/wiki/Help:Pipe trick pipe-tricked] [http://en.wikipedia.org/wiki/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. | * This template takes another ''template-name'' and some associated [http://en.wikipedia.org/wiki/Help:Pipe trick pipe-tricked] [http://en.wikipedia.org/wiki/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. | ||
Line 21: | Line 21: | ||
---- | ---- | ||
− | * If given no additional parameters except ''<code> 'template name' (<nowiki>{{{1}}}</nowiki>), </code>'' it presents the same as the similar {{tl| | + | * If given no additional parameters except ''<code> 'template name' (<nowiki>{{{1}}}</nowiki>), </code>'' it presents the same as the similar {{tl|tl}} [http://en.wikipedia.org/wiki/Macro (computer science) macro] template -- a blue link nested in [http://en.wikipedia.org/wiki/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. |
− | :* {{tlx| | + | :* {{tlx|tl|tl}} display compared to {{tlx|tlx|tl}}: (tl: {{tl|tl}} versus tlx: {{tlx|tl}}) |
− | * Comparatively, {{tlx| | + | * 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 ''subst''. Setting this parameter to any string of length 1 or greater will place the string "subst:" before the template name, linked to [http://en.wikipedia.org/wiki/Help:Substitution 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}}. | * {{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 [http://en.wikipedia.org/wiki/Help:Substitution 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}}. | ||
Line 34: | Line 34: | ||
{{[http://en.wikipedia.org/wiki/Template:{{BASEPAGENAME}} {{BASEPAGENAME}}]}} | {{[http://en.wikipedia.org/wiki/Template:{{BASEPAGENAME}} {{BASEPAGENAME}}]}} | ||
− | is a generalization of {{ | + | is a generalization of {{tl|tl|x}}, {{tl|tlp|x|y}}, |
etcetera with arguably better readable | etcetera with arguably better readable | ||
output. This depends on the browser, but too narrow | output. This depends on the browser, but too narrow | ||
Line 149: | Line 149: | ||
== See also == | == See also == | ||
− | * [http://en.wikipedia.org/wiki/Template:tlxb Template:tlxb] – 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). [http://en.wikipedia.org/wiki/Template: | + | * [http://en.wikipedia.org/wiki/Template:tlxb Template:tlxb] – 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). [http://en.wikipedia.org/wiki/Template:tlb Template:tlb] is the same, except it uses regular text instead of a monospaced non-proportional font. |
* [http://en.wikipedia.org/wiki/Template:Temt Template:Temt], – same as {{tl|tlx}}, but handles template names with the Template: prefix and templates not in the [http://en.wikipedia.org/wiki/Wikipedia:Namespace Template: namespace] <nowiki>{{ns:10}}</nowiki>. | * [http://en.wikipedia.org/wiki/Template:Temt Template:Temt], – same as {{tl|tlx}}, but handles template names with the Template: prefix and templates not in the [http://en.wikipedia.org/wiki/Wikipedia:Namespace Template: namespace] <nowiki>{{ns:10}}</nowiki>. | ||
* [http://en.wikipedia.org/wiki/Template:Para Template:Para] – for giving examples of template parameters and values only, instead of entire templates with parameters. | * [http://en.wikipedia.org/wiki/Template:Para Template:Para] – for giving examples of template parameters and values only, instead of entire templates with parameters. | ||
− | |||
<!--- Categories applied to both /doc style Documentation page and to the parent templates ---> | <!--- 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 ---> | <!-- Add the Categories for this doc or usage page (only-- not for the calling template) BELOW THIS LINE ---> |
Latest revision as of 14:52, 18 September 2012
This is a documentation subpage for Template:Tlx. It contains usage information, categories, interlanguage links and other content that is not part of the original template page. |
- {{tlx|Template|first parameter|second|third|...|tenth}} → {{Template|first parameter|second|third|...|tenth}}
- {{tlx|Template|2=first parameter|3=second|4=third|5=...|11=tenth}} → {{Template|first parameter|second|third|...|tenth}} if they might contain "=" signs.
- {{tlx|Template|<nowiki>first|second|...|999th</nowiki>}} → {{Template|first|second|...|999th}} (for more than 10 parameters)
Purpose and naming
Mnemonically] 'Template link expanded'. After {{tl}} 'Template link'.
- This template takes another template-name and some associated trick pipe-tricked (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.
- Specifics: Up to 10 pass parameters (numbered or nowiki-keywords) for the specified template are displayed as 'placeholders', and 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. - 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>
. 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<nowiki>{{Anytemplate|arg1=23|size=250px|other parameters...}}</nowiki>
</code><pre>...</pre>
.
- If given no additional parameters except
'template name' ({{{1}}}),
it presents the same as the similar {{tl}} (computer science) macro template -- a blue link nested in 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.
- Comparatively, {{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}} 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|Welcome|subst=Y}} will display {{subst:Welcome}}.
- 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.
Documentation
{{Tlx}} is a generalization of {{tl}}, {{tlp}}, etcetera with arguably better readable output. This depends on the browser, but too narrow uses of "{", "|", "}" in conjunction with links can be hard to read.
Usage
- {{Tlx|template name}}
- {{Tlx|template name|param}}
- {{Tlx|template name|1|2|3|4|5|6|7|8|9|10}}
- {{Tlx|template name|1|2|3|4|5|6|7|8|9|10|more}}
- {{Tlx|template name|param=value}}
Up to 10 placeholders for parameters of the specified template
Examples
- 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.
Code | Result | Remark |
---|---|---|
{{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, then ... |
{{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|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}} | unlimited parameters as one nowiki string | |
{{tlx|x1|x=u}} | {{x1}} | = won't work |
{{tlx|x1|x=u}} | {{x1|x=u}} | = is okay |
{{tlx|x1|x{{=}}u}} | {{x1|x=u}} | {{=}} is okay |
{{tlx|x1|<nowiki>x=u</nowiki>}} | {{x1|x=u}} | sticky nowiki is okay |
{{tlx|x2| |two}} | {{x2|two}} | empty won't work |
{{tlx|x2| |two}} | {{x2| |two}} |   is okay |
{{tlx|x2| |two}} | {{x2| |two}} | is okay |
{{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 clobbers 2=one |
{{tlx|x2|3=two|2=one}} | {{x2|one|two}} | right to left okay |
See also
- Template:tlxb – same as {{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.
- Template:Temt, – same as {{tlx}}, but handles template names with the Template: prefix and templates not in the Template: namespace {{ns:10}}.
- Template:Para – for giving examples of template parameters and values only, instead of entire templates with parameters.