Difference between revisions of "Template:Tlx/doc"
From Slicer Wiki
(remove cat) |
(Created page with '{{documentation subpage}} ==Usage== Code: <pre> * {{tlx|example|parameter1|parameter2...}} * {{tlx|SISTER=W:|example|parameter1|parameter2...}} </pre> Result: * {{tlx|example|pa…') |
||
Line 1: | Line 1: | ||
− | + | {{documentation subpage}} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | < | + | ==Usage== |
+ | Code: | ||
+ | <pre> | ||
+ | * {{tlx|example|parameter1|parameter2...}} | ||
+ | * {{tlx|SISTER=W:|example|parameter1|parameter2...}} | ||
+ | </pre> | ||
+ | Result: | ||
+ | * {{tlx|example|parameter1|parameter2...}} | ||
+ | * {{tlx|SISTER=W:|example|parameter1|parameter2...}} | ||
− | + | This template creates example usage syntax for a template, and links the name to the template page. The "SISTER" parameter specifies an interwiki prefix to link to another wiki. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
+ | ===Examples=== | ||
{| border="1" cellpadding="4" class="wikitable" | {| border="1" cellpadding="4" class="wikitable" | ||
! Code | ! Code | ||
Line 60: | Line 19: | ||
! Remark | ! Remark | ||
|- | |- | ||
− | |{{Tlx| | + | |{{Tlx|SISTER=W:|Tlx|x0}} |
− | | | + | |{{Tlx|SISTER=W:|x0}} |
− | |||
− | |||
− | |{{Tlx| | ||
− | |||
||  | ||  | ||
|- | |- | ||
− | |{{Tlx|Tlx| | + | |{{Tlx|SISTER=W:|Tlx|x1|one}} |
− | |{{Tlx| | + | |{{Tlx|SISTER=W:|x1|one}} |
||  | ||  | ||
|- | |- | ||
− | |{{Tlx|Tlx| | + | |{{Tlx|SISTER=W:|Tlx|x2|one|two}} |
− | |{{Tlx| | + | |{{Tlx|SISTER=W:|x2|one|two}} |
||  | ||  | ||
|- | |- | ||
− | |{{Tlx|Tlx| | + | |{{Tlx|SISTER=W:|Tlx|x3|1<tt>|</tt>2<tt>|</tt>3}} |
− | |{{Tlx| | + | |{{Tlx|SISTER=W:|x3|1|2|3}} |
||  | ||  | ||
|- | |- | ||
− | |{{Tlx|Tlx| | + | |{{Tlx|SISTER=W:|Tlx|x4|1<tt>|</tt>2<tt>|</tt>3|4}} |
− | |{{Tlx| | + | |{{Tlx|SISTER=W:|x4|1|2|3|4}} |
− | | | + | |up to 7 parameters, then ... |
|- | |- | ||
− | |{{Tlx|Tlx| | + | |{{Tlx|SISTER=W:|Tlx|x4|1<tt>|</tt>2<tt>|</tt>3&#124;4}} |
− | + | |{{Tlx|SISTER=W:|x4|1|2|3|4}} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |{{Tlx| | ||
− | |||
|align="right"|<tt>&#124;</tt> for more | |align="right"|<tt>&#124;</tt> for more | ||
|- | |- | ||
− | + | |{{Tlx|SISTER=W:|Tlx|x1|x=u}} | |
− | + | |{{Tlx|SISTER=W:|x1|x=u}} | |
− | |||
− | |||
− | |{{Tlx|x1|x=u}} | ||
|'''=''' won't work | |'''=''' won't work | ||
|- | |- | ||
− | |{{Tlx|Tlx|x1|x&#61;u}} | + | |{{Tlx|SISTER=W:|Tlx|x1|x&#61;u}} |
− | |{{Tlx|x1|x=u}} | + | |{{Tlx|SISTER=W:|x1|x=u}} |
|align="right"|<tt>&#61;</tt> is okay | |align="right"|<tt>&#61;</tt> is okay | ||
|- | |- | ||
− | |{{Tlx| | + | |{{Tlx|SISTER=W:|Tlx|x1|<nowiki>x=u</nowiki>}} |
− | + | |{{Tlx|SISTER=W:|x1|<nowiki>x=u</nowiki>}} | |
− | |||
− | |||
− | |||
− | |{{Tlx|x1|<nowiki>x=u</nowiki>}} | ||
|align="right"|sticky nowiki is okay | |align="right"|sticky nowiki is okay | ||
|- | |- | ||
− | |{{Tlx|Tlx|x2| |two}} | + | |{{Tlx|SISTER=W:|Tlx|x2| |two}} |
− | |{{Tlx|x2| |two}} | + | |{{Tlx|SISTER=W:|x2| |two}} |
|empty won't work | |empty won't work | ||
|- | |- | ||
− | |{{Tlx|Tlx|x2|&#32;|two}} | + | |{{Tlx|SISTER=W:|Tlx|x2|&#32;|two}} |
− | |{{Tlx|x2| |two}} | + | |{{Tlx|SISTER=W:|x2| |two}} |
|align="right"|<tt>&#32;</tt> is okay | |align="right"|<tt>&#32;</tt> is okay | ||
|- | |- | ||
− | |{{Tlx|Tlx|x2|&nbsp;|two}} | + | |{{Tlx|SISTER=W:|Tlx|x2|&nbsp;|two}} |
− | |{{Tlx|x2| |two}} | + | |{{Tlx|SISTER=W:|x2| |two}} |
|align="right"|<tt>&nbsp;</tt> is okay | |align="right"|<tt>&nbsp;</tt> is okay | ||
|- | |- | ||
− | |{{Tlx|Tlx|x2| &#124; two}} | + | |{{Tlx|SISTER=W:|Tlx|x2| &#124; two}} |
− | |{{Tlx|x2| | two}} | + | |{{Tlx|SISTER=W:|x2| | two}} |
|align="right"|<tt>&#124;</tt> is okay | |align="right"|<tt>&#124;</tt> is okay | ||
|- | |- | ||
− | || {{Tlx|Tlx|x2| {{!}} two}} | + | || {{Tlx|SISTER=W:|Tlx|x2| {{!}} two}} |
− | || {{Tlx|x2| {{!}} two}} | + | || {{Tlx|SISTER=W:|x2| {{!}} two}} |
− | |align="right"|{{Tlx|!}} is dubious | + | |align="right"|{{Tlx|SISTER=W:|!}} is dubious |
|- | |- | ||
− | || {{Tlx|Tlx|x2|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}} | + | || {{Tlx|SISTER=W:|Tlx|x2|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}} |
− | || {{Tlx|x2|2=|3=two}} | + | || {{Tlx|SISTER=W:|x2|2=|3=two}} |
|empty really doesn't work | |empty really doesn't work | ||
|- | |- | ||
− | || {{Tlx|Tlx|x2|<nowiki>2=one</nowiki>|two}} | + | || {{Tlx|SISTER=W:|Tlx|x2|<nowiki>2=one</nowiki>|two}} |
− | || {{Tlx|x2|2=one|two}} | + | || {{Tlx|SISTER=W:|x2|2=one|two}} |
|'''two''' clobbers '''2=one''' | |'''two''' clobbers '''2=one''' | ||
|- | |- | ||
− | || {{Tlx|Tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}} | + | || {{Tlx|SISTER=W:|Tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}} |
− | || {{Tlx|x2|3=two|2=one}} | + | || {{Tlx|SISTER=W:|x2|3=two|2=one}} |
|align="right"|right to left okay | |align="right"|right to left okay | ||
|} | |} | ||
− | == | + | ==Technical documentation== |
− | + | ===Naming=== | |
− | + | The name is derived from "'''T'''emplate '''l'''ist e'''x'''panded". | |
− | |||
− | |||
− | |||
− | |||
− | < | + | ===Behaviour=== |
+ | * Up to 7 pass parameters (numbered) for the specified template are displayed as 'placeholders', and more parameters are shown as "<tt>|</tt>''...''", for details see the [[w:Talk:Tlx/doc|the Wikipedia talk page]]. | ||
+ | |||
+ | * If given no additional parameters except ''<code>'template name' (<nowiki>{{{1}}}</nowiki>),</code>'' it displays a simple link wrapped in braces (similar to {{[[template:tl|tl]]}}). | ||
− | + | <!-- template categories and interwiki links --> | |
− | <!-- | + | <includeonly> |
− | [[Category:Typing-aid templates | | + | [[Category:Typing-aid templates|Tlx]] |
− | [[Category:Internal link templates | | + | [[Category:Internal link templates|Tlx]] |
− | [[Category:Interwiki link templates | | + | [[Category:Interwiki link templates|Tlx]] |
− | + | [[en:Template:Tlx]] | |
− | [[ | ||
− | |||
− | |||
− | |||
− | |||
− | |||
[[ko:틀:Tlx]] | [[ko:틀:Tlx]] | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
[[ru:Template:Tlx]] | [[ru:Template:Tlx]] | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</includeonly> | </includeonly> |
Revision as of 20:55, 21 October 2011
Home < Template:Tlx < doc40px | 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. |
Usage
Code:
* {{tlx|example|parameter1|parameter2...}} * {{tlx|SISTER=W:|example|parameter1|parameter2...}}
Result:
This template creates example usage syntax for a template, and links the name to the template page. The "SISTER" parameter specifies an interwiki prefix to link to another wiki.
Examples
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 7 parameters, then ... |
{{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 |
Technical documentation
Naming
The name is derived from "Template list expanded".
Behaviour
- Up to 7 pass parameters (numbered) for the specified template are displayed as 'placeholders', and more parameters are shown as "|...", for details see the the Wikipedia talk page.
- If given no additional parameters except
'template name' ({{{1}}}),
it displays a simple link wrapped in braces (similar to {{tl}}).