On November 27th, 2022, the 8,000th article was added to the SuccuWiki!
Template:Tlx/doc: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
(2 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<includeonly><!-----------------Interwiki Doc page pattern-------------------> | <includeonly><!-----------------Interwiki Doc page pattern-------------------> | ||
<small>''This '{{Tlx|Tlx}}' template documentation is | <small>''This '{{Tlx|Tlx}}' template documentation is 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}}|Masterpage]] | ||
}}</small></includeonly><noinclude> | }}</small></includeonly><noinclude> | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
Line 18: | Line 18: | ||
== Purpose and naming == | == Purpose and naming == | ||
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 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. | * This template takes another ''template-name'' and some associated 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. | ||
Line 26: | Line 26: | ||
---- | ---- | ||
* If given no additional parameters except ''<code> 'template name' (<nowiki>{{{1}}}</nowiki>), </code>'' it presents the same as the similar {{tl|Tl}} macro template -- a blue link nested in | * If given no additional parameters except ''<code> 'template name' (<nowiki>{{{1}}}</nowiki>), </code>'' it presents the same as the similar {{tl|Tl}} 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. | ||
:* {{Tlx|Tl|Tl}} display compared to {{Tlx|Tlx|Tl}}: (Tl: {{Tl|Tl}} versus Tlx: {{Tlx|Tl}}) | :* {{Tlx|Tl|Tl}} display compared to {{Tlx|Tlx|Tl}}: (Tl: {{Tl|Tl}} versus Tlx: {{Tlx|Tl}}) | ||
Line 32: | Line 32: | ||
* 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. | * 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. This is useful to indicate when a template should be substituted | * {{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. This is useful to indicate when a template should be substituted. | ||
* 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. | * 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. |
Latest revision as of 08:59, 1 July 2013
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. |
Basically:
{{Tlx|Template|first parameter|second|third|...|tenth}}
→{{Template|first parameter|second|third|...|tenth}}
Where parameters might contain "=" characters, use {{=}}
instead
{{Tlx|Template|first parameter{{=}}anything|second|third{{=}}something|...|tenth}}
→{{Template|first parameter=anything|second|third=something|...|tenth}}
For more than 10 parameters, possibly also containing "=", use
{{Tlx|Template|<nowiki>first|second|third=something|...|999th</nowiki>}}
→{{Template|first|second|third=something|...|999th}}
The three dots in the examples represent a number of arguments that have been omitted and are not an actual argument.
Purpose and naming
Mnemonically 'Template link expanded'. After {{Tl}}
'Template link'.
- This template takes another template-name and some associated 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. 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>
. 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}} 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. This is useful to indicate when a template should be substituted.
- 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
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:Para – for giving examples of template parameters and values only, instead of entire templates with parameters.
{{Template linking templates}}