Template:Tlx/doc: Difference between revisions
Jump to navigation
Jump to search
(Merge Interwiki doc page pattern into merged commons/Meta usage and create /doc pages) |
m (typo) |
||
Line 1: | Line 1: | ||
< | <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, Tlxm, Tlxw)'' [<span class="plainlinks">[{{fullurl:Template:Tlx/doc |action=edit}} edit]</span>].{{#ifeq:{{SITENAME}}|Meta| |[[M:template:{{PAGENAMEE}}|Masterpage]] | <small>''This '{{Tlx|Tlx}}' template documentation is [[w:Wikipedia:Template doc page pattern|transcluded]] for all ''Tlx family templates (Tlx, 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}} | }}</small></includeonly><noinclude> | ||
{{template doc page viewed directly|yes}} | |||
{{-}} | {{-}} | ||
<!-- 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 ---> | ||
Line 25: | Line 26: | ||
<!-- EDIT/ADD TEMPLATE Interwiki's BELOW THIS LINE --> | <!-- EDIT/ADD TEMPLATE Interwiki's BELOW THIS LINE --> | ||
{{interwikitmp-grp|V=6|cat=Typing-aid templates |CATS=[[Category:Internal link templates|Tlx]][[Category:Interwiki link templates|Tlx]]}} </includeonly> | {{interwikitmp-grp|V=6|cat=Typing-aid templates |CATS=[[Category:Internal link templates|Tlx]][[Category:Interwiki link templates|Tlx]]}} | ||
</includeonly> | |||
;This usage also applies to interwiki capable template variations: 'Tlxm' and 'Tlxw'<br> | ;This usage also applies to interwiki capable template variations: 'Tlxm' and 'Tlxw'<br> | ||
Revision as of 16:25, 12 February 2007
Template:Template doc page viewed directly
- As of creation of 'Tlx/doc', two interwiki defauted versions also share this usage page
Since these are the two repositories of templates for exports to sister projects.
// FrankB 16:23, 12 February 2007 (UTC)
Template:Interwikitmp-grp
- This usage also applies to interwiki capable template variations
- 'Tlxm' and 'Tlxw'
{{tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}}
→ (becomes) →
{{template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}}
- Purpose
- Mnemonically 'Template list expanded'... after {{tl}} 'Template list' Template:I2This template takes another template-name and some associated pipe-tricked (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.
- Up to five pass parameters (numbered) for the specified template are displayed as 'placeholders', and more parameters are shown as "|...", for details see the this talk page.
- 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 preferred for mere listing and referencing in long pages involving a lot of template expansions1.
- 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 {{Tlxw}} and {{Tlxm}} are typing-aid templates available at Meta for automatic substitution in discussions about templates on Wikipedia or Meta.
Documentation
{{Tlx/doc}} is a generalization of Template:Tlxw, Template:Tlxw, 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/doc|template name}}
- {{Tlx/doc|template name|param}}
- {{Tlx/doc|template name|1|2|3}}
- {{Tlx/doc|template name|1|2|3|more}}
- {{Tlx/doc|template name|param=value}}
Up to three 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|x1|one}} | {{{{x1|one}} | |
{{{{Tlx|x2|one|two}} | {{{{x2|one|two}} | |
{{{{Tlx|x3|1|2|3}} | {{{{x3|1|2|3}} | |
{{{{Tlx|x4|1|2|3|4}} | {{{{x4|1|2|3|4}} | up to 3 parameters |
{{{{Tlx|x4|1|2|3|4}} | {{{{x4|1|2|3|4}} | | for more |
{{{{Tlx|x1|x=u}} | {{{{x1}} | = won't work |
{{{{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 |