Difference between revisions of "Template:Tlx/doc"
From Xen
Lars.kurth (talk | contribs) m |
|||
(3 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
+ | {{documentation subpage}} |
||
− | <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, Tlxc, Tlxw, Tlxb)'' [<span class="plainlinks">[{{fullurl:Template:Tlx/doc |action=edit}} edit]</span>].{{#ifeq:{{SITENAME}}|Meta| |[[M:template:{{PAGENAMEE}}|Masterpage]] |
||
− | }}</small></includeonly><noinclude> |
||
− | {{Documentation subpage}} |
||
− | {{-}} |
||
− | </noinclude> |
||
+ | ==Usage== |
||
− | <!-- Parent template(s) usage begins: ---> |
||
+ | Code: |
||
+ | <pre> |
||
+ | * {{tlx|example|parameter1|parameter2...}} |
||
+ | * {{tlx|SISTER=wikipedia:|example|parameter1|parameter2...}} |
||
+ | </pre> |
||
+ | Result: |
||
+ | * {{tlx|example|parameter1|parameter2...}} |
||
+ | * {{tlx|SISTER=wikipedia:|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. |
||
− | : {{Tlx|Tlx|Template|first parameter|second|third|...|tenth}} → {{Tlx|Template|first parameter|second|third|...|tenth}} |
||
− | : {{Tlx|Tlx|Template|2=first parameter|3=second|4=third|...|11=tenth}} → {{Tlx|Template|first parameter|second|third|...|tenth}} if they might contain "=" signs. |
||
− | : {{Tlx|Tlx|Template|<nowiki>first|second|...|999th</nowiki>}} → {{Tlx|Template|<nowiki>first|second|...|999th</nowiki>}} (for more than 10 parameters) |
||
− | |||
− | == Purpose and naming == |
||
− | [[Wikt: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 [[Help:Pipe trick|pipe-tricked]] [[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. |
||
− | * '''''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 "<small>&#124;</small>''...''"). A keyword parameter can be used with equals code &#61; or <nowiki>{{=}}</nowiki> or in nowiki-text: "<nowiki>size=10</nowiki>" or all parameters as a string in <nowiki>"<nowiki>"</nowiki> tags; see ''[[#Examples|Examples]]'' at bottom. For more details, see [[{{TALKPAGENAME}}|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 {{nobr|<code><nowiki><code><nowiki></nowiki></code>}}, for example: {{nobr|<code><nowiki><code><nowiki>{{Anytemplate|arg1=23|size=250px|</nowiki><var>other parameters...</var><nowiki>}}</nowiki></code></nowiki></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 {{nobr|<code><nowiki><pre>...</pre></nowiki></code>}}. |
||
− | |||
− | ---- |
||
− | |||
− | * 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 [[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|Tl|Tl}} display compared to {{Tlx|Tlx|Tl}}: (Tl: {{Tl|Tl}} versus Tlx: {{Tlx|Tl}}) |
||
− | |||
− | * 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 [[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}}. |
||
− | |||
− | * 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 == |
||
− | |||
− | {{[[Template:{{BASEPAGENAME}}|{{BASEPAGENAME}}]]}} |
||
− | is a generalization of {{Tl|Tl|x}}, {{Tl|Tlp|x|y}}, |
||
− | 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 === |
||
− | |||
− | :<tt>{{{{BASEPAGENAME}}{{!}}template name}}</tt> |
||
− | :<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}param}}</tt> |
||
− | :<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10}}</tt> |
||
− | :<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10&#124;more}}</tt> |
||
− | :<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}param&#61;value}}</tt> |
||
− | ''Up to 10 placeholders for parameters of the specified template'' |
||
− | |||
− | === Examples === |
||
− | {{#ifeq:{{SITENAME}}|Wikipedia|<!-- Skip message--->| |
||
− | {{#ifeq:{{SITENAME}}|Meta|<!-- No note needed --->|<!-- Other Sisters Note: ---> |
||
− | ;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. |
||
− | }}}} |
||
+ | ===Examples=== |
||
{| border="1" cellpadding="4" class="wikitable" |
{| border="1" cellpadding="4" class="wikitable" |
||
! Code |
! Code |
||
Line 60: | Line 19: | ||
! Remark |
! Remark |
||
|- |
|- |
||
− | |{{Tlx|Tlx|x0}} |
+ | |{{Tlx|SISTER=wikipedia:|Tlx|x0}} |
− | |{{Tlx|x0}} |
+ | |{{Tlx|SISTER=wikipedia:|x0}} |
||  |
||  |
||
|- |
|- |
||
− | |{{Tlx|Tlx| |
+ | |{{Tlx|SISTER=wikipedia:|Tlx|x1|one}} |
− | |{{Tlx| |
+ | |{{Tlx|SISTER=wikipedia:|x1|one}} |
||  |
||  |
||
|- |
|- |
||
− | |{{Tlx|Tlx| |
+ | |{{Tlx|SISTER=wikipedia:|Tlx|x2|one|two}} |
− | |{{Tlx| |
+ | |{{Tlx|SISTER=wikipedia:|x2|one|two}} |
||  |
||  |
||
|- |
|- |
||
+ | |{{Tlx|SISTER=wikipedia:|Tlx|x3|1<tt>|</tt>2<tt>|</tt>3}} |
||
− | |{{Tlx|Tlx|AbC}} |
||
− | |{{Tlx| |
+ | |{{Tlx|SISTER=wikipedia:|x3|1|2|3}} |
||  |
||  |
||
|- |
|- |
||
+ | |{{Tlx|SISTER=wikipedia:|Tlx|x4|1<tt>|</tt>2<tt>|</tt>3|4}} |
||
− | |{{Tlx|Tlx|x1|one}} |
||
− | |{{Tlx| |
+ | |{{Tlx|SISTER=wikipedia:|x4|1|2|3|4}} |
+ | |up to 7 parameters, then ... |
||
− | ||  |
||
|- |
|- |
||
+ | |{{Tlx|SISTER=wikipedia:|Tlx|x4|1<tt>|</tt>2<tt>|</tt>3&#124;4}} |
||
− | |{{Tlx|Tlx|x2|one|two}} |
||
− | |{{Tlx| |
+ | |{{Tlx|SISTER=wikipedia:|x4|1|2|3|4}} |
− | ||  |
||
− | |- |
||
− | |{{Tlx|Tlx|x3|1|2|3|4|5|6|7|8|9|10}} |
||
− | |{{Tlx|x3|1|2|3|4|5|6|7|8|9|10}} |
||
− | ||  |
||
− | |- |
||
− | |{{Tlx|Tlx|x4|1|2|3|4|5|6|7|8|9|10|11}} |
||
− | |{{Tlx|x4|1|2|3|4|5|6|7|8|9|10|11}} |
||
− | |up to 10 parameters, then ... |
||
− | |- |
||
− | |{{Tlx|Tlx|x5|1|2|3|4|5|6|7|8|9|10&#124;11}} |
||
− | |{{Tlx|x5|1|2|3|4|5|6|7|8|9|10|11}} |
||
|align="right"|<tt>&#124;</tt> for more |
|align="right"|<tt>&#124;</tt> for more |
||
|- |
|- |
||
+ | |{{Tlx|SISTER=wikipedia:|Tlx|x1|x=u}} |
||
− | |colspan=2| {{Tlx|Tlx|convert|<nowiki><nowiki>14|m|ftin|abbr=out|sp=us</nowiki></nowiki>}} |
||
+ | |{{Tlx|SISTER=wikipedia:|x1|x=u}} |
||
− | |unlimited parameters as one nowiki string |
||
− | |- |
||
− | |{{Tlx|Tlx|x1|x=u}} |
||
− | |{{Tlx|x1|x=u}} |
||
|'''=''' won't work |
|'''=''' won't work |
||
|- |
|- |
||
− | |{{Tlx|Tlx|x1|x&#61;u}} |
+ | |{{Tlx|SISTER=wikipedia:|Tlx|x1|x&#61;u}} |
− | |{{Tlx|x1|x=u}} |
+ | |{{Tlx|SISTER=wikipedia:|x1|x=u}} |
|align="right"|<tt>&#61;</tt> is okay |
|align="right"|<tt>&#61;</tt> is okay |
||
|- |
|- |
||
− | |{{Tlx|Tlx|x1| |
+ | |{{Tlx|SISTER=wikipedia:|Tlx|x1|<nowiki>x=u</nowiki>}} |
− | |{{Tlx|x1|x |
+ | |{{Tlx|SISTER=wikipedia:|x1|<nowiki>x=u</nowiki>}} |
− | |align="right"|<tt><nowiki>{{=}}</nowiki></tt> is okay |
||
− | |- |
||
− | |{{Tlx|Tlx|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=wikipedia:|Tlx|x2| |two}} |
− | |{{Tlx|x2| |two}} |
+ | |{{Tlx|SISTER=wikipedia:|x2| |two}} |
|empty won't work |
|empty won't work |
||
|- |
|- |
||
− | |{{Tlx|Tlx|x2|&#32;|two}} |
+ | |{{Tlx|SISTER=wikipedia:|Tlx|x2|&#32;|two}} |
− | |{{Tlx|x2| |two}} |
+ | |{{Tlx|SISTER=wikipedia:|x2| |two}} |
|align="right"|<tt>&#32;</tt> is okay |
|align="right"|<tt>&#32;</tt> is okay |
||
|- |
|- |
||
− | |{{Tlx|Tlx|x2|&nbsp;|two}} |
+ | |{{Tlx|SISTER=wikipedia:|Tlx|x2|&nbsp;|two}} |
− | |{{Tlx|x2| |two}} |
+ | |{{Tlx|SISTER=wikipedia:|x2| |two}} |
|align="right"|<tt>&nbsp;</tt> is okay |
|align="right"|<tt>&nbsp;</tt> is okay |
||
|- |
|- |
||
− | |{{Tlx|Tlx|x2| &#124; two}} |
+ | |{{Tlx|SISTER=wikipedia:|Tlx|x2| &#124; two}} |
− | |{{Tlx|x2| | two}} |
+ | |{{Tlx|SISTER=wikipedia:|x2| | two}} |
|align="right"|<tt>&#124;</tt> is okay |
|align="right"|<tt>&#124;</tt> is okay |
||
|- |
|- |
||
− | || {{Tlx|Tlx|x2| {{!}} two}} |
+ | || {{Tlx|SISTER=wikipedia:|Tlx|x2| {{!}} two}} |
− | || {{Tlx|x2| {{!}} two}} |
+ | || {{Tlx|SISTER=wikipedia:|x2| {{!}} two}} |
− | |align="right"|{{Tlx|!}} is dubious |
+ | |align="right"|{{Tlx|SISTER=wikipedia:|!}} is dubious |
|- |
|- |
||
− | || {{Tlx|Tlx|x2|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}} |
+ | || {{Tlx|SISTER=wikipedia:|Tlx|x2|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}} |
− | || {{Tlx|x2|2=|3=two}} |
+ | || {{Tlx|SISTER=wikipedia:|x2|2=|3=two}} |
|empty really doesn't work |
|empty really doesn't work |
||
|- |
|- |
||
− | || {{Tlx|Tlx|x2|<nowiki>2=one</nowiki>|two}} |
+ | || {{Tlx|SISTER=wikipedia:|Tlx|x2|<nowiki>2=one</nowiki>|two}} |
− | || {{Tlx|x2|2=one|two}} |
+ | || {{Tlx|SISTER=wikipedia:|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=wikipedia:|Tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}} |
− | || {{Tlx|x2|3=two|2=one}} |
+ | || {{Tlx|SISTER=wikipedia:|x2|3=two|2=one}} |
|align="right"|right to left okay |
|align="right"|right to left okay |
||
|} |
|} |
||
+ | ==Technical documentation== |
||
− | == See also == |
||
+ | ===Naming=== |
||
− | * [[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). [[Template:Tlb]] is the same, except it uses regular text instead of a monospaced non-proportional font. |
||
+ | The name is derived from "'''T'''emplate '''l'''ist e'''x'''panded". |
||
− | * [[Template:Temt]], – same as {{tl|Tlx}}, but handles template names with the Template: prefix and templates not in the [[Wikipedia:Namespace|Template: namespace]] <nowiki>{{ns:10}}</nowiki>. |
||
− | * [[Template:Para]] – for giving examples of template parameters and values only, instead of entire templates with parameters. |
||
− | {{tl-nav}} |
||
− | |||
− | <!--- 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 ---> |
||
+ | ===Behaviour=== |
||
− | <includeonly> |
||
+ | * 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 [[wikipedia:Talk:Tlx/doc|the Wikipedia talk page]]. |
||
− | <!-- EDIT IN (calling) TEMPLATE CATEGORIES BELOW THIS LINE --> |
||
+ | |||
− | [[Category:Typing-aid templates |{{PAGENAME}}]] |
||
+ | * 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]]}}). |
||
− | [[Category:Internal link templates |{{PAGENAME}}]] |
||
− | [[Category:Interwiki link templates |{{PAGENAME}}]] |
||
− | <!-- |
+ | <!-- template categories and interwiki links --> |
+ | <includeonly> |
||
− | [[as:Template:Tlx]] |
||
− | [[cy:Nodyn:Tlx]] |
||
− | [[de:Vorlage:Vorlage]] |
||
− | [[fr:Modèle:Lmp]] |
||
− | [[fa:الگو:الگوب]] |
||
− | [[hsb:Předłoha:Tlx]] |
||
− | [[hy:Կաղապար:Tlx]] |
||
− | [[ko:틀:Tlx]] |
||
− | [[ia:Patrono:Tlx]] |
||
− | [[os:Шаблон:Tlp]] |
||
− | [[mk:Шаблон:Швп]] |
||
− | [[ja:Template:Tlx]] |
||
− | [[no:Mal:Tlx]] |
||
− | [[pt:Predefinição:Tlx]] |
||
− | [[ro:Format:Tlx]] |
||
− | [[ru:Template:Tlx]] |
||
− | [[simple:Template:Tlx]] |
||
− | [[sr:Šablon:Tlx]] |
||
− | [[th:แม่แบบ:Tlx]] |
||
− | [[tl:Suleras:Tlx]] |
||
− | [[uk:Шаблон:Tlx]] |
||
− | [[ur:سانچہ:Tlx]] |
||
− | [[zh:Template:Tlx]] |
||
</includeonly> |
</includeonly> |
Latest revision as of 12:32, 5 December 2011
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=wikipedia:|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}}).