|
|
| 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, Tlxc, 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}}
| |
| - | {{-}}
| |
| - | {{interwikitmp-grp
| |
| - | |V=D
| |
| - | |cats=
| |
| - | |inhib=yes
| |
| - | |wdy=|wqt=|wsr=|wnw=
| |
| - | |{{PAGENAME}}|{{PAGENAME}}}}</noinclude>
| |
| | | | |
| - | <!-- Parent template(s) usage Begins: --->
| |
| - | <includeonly>{{interwikitmp-grp|V=6|cat=Typing-aid templates |CATS=[[Category:Internal link templates|Tlx]][[Category:Interwiki link templates|Tlx]]}}</includeonly>
| |
| - |
| |
| - | {{tlx|tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}} → {{tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}}
| |
| - |
| |
| - | ==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 [[w:pipe-trick|pipe-tricked]] [http://meta.wikimedia.org/wiki/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 five pass parameters (numbered or nowiki-keywords) for the specified template are displayed as 'placeholders', and over 5 parameters can be displayed using a coded vertical-bar (as in "<small>&#124;</small>''...''"). A keyword parameter can be used, when tagged as a nowiki-keyword: <nowiki>"<nowiki>siz=10<\nowiki>"</nowiki> with each keyword parameter surrounded by <nowiki>"<nowiki>"</nowiki> tags; see ''[[#Examples|Examples]]'' at bottom. For more details, see the [[w:{{TALKPAGENAME}}|this talk]] page.
| |
| - | * '''''Exceptions:''''' If the intended template lists numerous/keyword parameters, then perhaps this template should really ''not'' be used, and just hardcode the usage with <code><nowiki><code><nowiki></code>, for example: <code><nowiki><code><nowiki>{{Anytemplate|arg1=23|siz=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 <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}} [[W:macro|macro]] template -- a blue link nested in [[W: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. Small 'front end' Shell or convience templates {{Tlx|Tlxw}} and {{tlx|Tlxm}} are typing-aid templates available at Meta for automatic substitution in discussions about templates on Wikipedia or Meta.
| |
| - |
| |
| - | ----
| |
| - |
| |
| - | ;This usage also applies to interwiki capable template variations:
| |
| - | # {{Tl|Tlxc}} -- which links to templates on Wikimedia Commons (The Commons).
| |
| - | # {{Tl|Tlxm}} -- which links to templates on Meta
| |
| - | # {{Tl|Tlxw}} -- which links to templates on Wikipedia
| |
| - |
| |
| - | ----
| |
| - |
| |
| - | ==Documentation==
| |
| - |
| |
| - | {{[[Template:{{PAGENAME}}|{{PAGENAME}}]]}}
| |
| - | is a generalization of {{Tlxw|Tl|x}}, {{Tlxw|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>{{{{PAGENAME}}{{!}}template name}}</tt>
| |
| - | :<tt>{{{{PAGENAME}}{{!}}template name{{!}}param}}</tt>
| |
| - | :<tt>{{{{PAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3}}</tt>
| |
| - | :<tt>{{{{PAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3&#124;more}}</tt>
| |
| - | :<tt>{{{{PAGENAME}}{{!}}template name{{!}}param&#61;value}}</tt>
| |
| - | ''Up to three 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.
| |
| - | }}}}
| |
| - |
| |
| - | {| border="1" cellpadding="4" class="wikitable"
| |
| - | ! Code
| |
| - | ! Result
| |
| - | ! Remark
| |
| - | |-
| |
| - | |{{Tlx|SISTER=W:|Tlx|x0}}
| |
| - | |{{Tlx|SISTER=W:|x0}}
| |
| - | || 
| |
| - | |-
| |
| - | |{{Tlx|SISTER=W:|Tlx|Abc}}
| |
| - | |{{Tlx|SISTER=W:|Abc}}
| |
| - | || 
| |
| - | |-
| |
| - | |{{Tlx|SISTER=W:|Tlx|ABC}}
| |
| - | |{{Tlx|SISTER=W:|ABC}}
| |
| - | || 
| |
| - | |-
| |
| - | |{{Tlx|SISTER=W:|Tlx|AbC}}
| |
| - | |{{Tlx|SISTER=W:|AbC}}
| |
| - | || 
| |
| - | |-
| |
| - | |{{Tlx|SISTER=W:|Tlx|x1|one}}
| |
| - | |{{Tlx|SISTER=W:|x1|one}}
| |
| - | || 
| |
| - | |-
| |
| - | |{{Tlx|SISTER=W:|Tlx|x2|one|two}}
| |
| - | |{{Tlx|SISTER=W:|x2|one|two}}
| |
| - | || 
| |
| - | |-
| |
| - | |{{Tlx|SISTER=W:|Tlx|x3|1<tt>|</tt>2<tt>|</tt>3}}
| |
| - | |{{Tlx|SISTER=W:|x3|1|2|3}}
| |
| - | || 
| |
| - | |-
| |
| - | |{{Tlx|SISTER=W:|Tlx|x4|1<tt>|</tt>2<tt>|</tt>3|4}}
| |
| - | |{{Tlx|SISTER=W:|x4|1|2|3|4}}
| |
| - | |up to 5 parameters, then ...
| |
| - | |-
| |
| - | |{{Tlx|SISTER=W:|Tlx|x4|1<tt>|</tt>2<tt>|</tt>3&#124;4}}
| |
| - | |{{Tlx|SISTER=W:|x4|1|2|3|4}}
| |
| - | |align="right"|<tt>&#124;</tt> for more
| |
| - | |-
| |
| - | |{{Tlx|SISTER=W:|Tlx|x1|x=u}}
| |
| - | |{{Tlx|SISTER=W:|x1|x=u}}
| |
| - | |'''=''' won't work
| |
| - | |-
| |
| - | |{{Tlx|SISTER=W:|Tlx|x1|x&#61;u}}
| |
| - | |{{Tlx|SISTER=W:|x1|x=u}}
| |
| - | |align="right"|<tt>&#61;</tt> is okay
| |
| - | |-
| |
| - | |{{Tlx|SISTER=W:|Tlx|x1|x<nowiki>{{=}}</nowiki>u}}
| |
| - | |{{Tlx|SISTER=W:|x1|x{{=}}u}}
| |
| - | |align="right"|<tt><nowiki>{{=}}</nowiki></tt> is okay
| |
| - | |-
| |
| - | |{{Tlx|SISTER=W:|Tlx|x1|<nowiki>x=u</nowiki>}}
| |
| - | |{{Tlx|SISTER=W:|x1|<nowiki>x=u</nowiki>}}
| |
| - | |align="right"|sticky nowiki is okay
| |
| - | |-
| |
| - | |{{Tlx|SISTER=W:|Tlx|x2| |two}}
| |
| - | |{{Tlx|SISTER=W:|x2| |two}}
| |
| - | |empty won't work
| |
| - | |-
| |
| - | |{{Tlx|SISTER=W:|Tlx|x2|&#32;|two}}
| |
| - | |{{Tlx|SISTER=W:|x2| |two}}
| |
| - | |align="right"|<tt>&#32;</tt> is okay
| |
| - | |-
| |
| - | |{{Tlx|SISTER=W:|Tlx|x2|&nbsp;|two}}
| |
| - | |{{Tlx|SISTER=W:|x2| |two}}
| |
| - | |align="right"|<tt>&nbsp;</tt> is okay
| |
| - | |-
| |
| - | |{{Tlx|SISTER=W:|Tlx|x2| &#124; two}}
| |
| - | |{{Tlx|SISTER=W:|x2| | two}}
| |
| - | |align="right"|<tt>&#124;</tt> is okay
| |
| - | |-
| |
| - | || {{Tlx|SISTER=W:|Tlx|x2| {{!}} two}}
| |
| - | || {{Tlx|SISTER=W:|x2| {{!}} two}}
| |
| - | |align="right"|{{Tlx|SISTER=W:|!}} is dubious
| |
| - | |-
| |
| - | || {{Tlx|SISTER=W:|Tlx|x2|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}}
| |
| - | || {{Tlx|SISTER=W:|x2|2=|3=two}}
| |
| - | |empty really doesn't work
| |
| - | |-
| |
| - | || {{Tlx|SISTER=W:|Tlx|x2|<nowiki>2=one</nowiki>|two}}
| |
| - | || {{Tlx|SISTER=W:|x2|2=one|two}}
| |
| - | |'''two''' clobbers '''2=one'''
| |
| - | |-
| |
| - | || {{Tlx|SISTER=W:|Tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}}
| |
| - | || {{Tlx|SISTER=W:|x2|3=two|2=one}}
| |
| - | |align="right"|right to left okay
| |
| - | |}
| |
| - |
| |
| - | ==See also==
| |
| - | [[w: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 --->
| |
| - |
| |
| - |
| |
| - | <!-- Add the Categories for this doc or usage page (only-- not for the calling template) BELOW THIS LINE --->
| |
| - | <noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
| |
| - |
| |
| - | <includeonly>
| |
| - | <!-- EDIT IN (calling) TEMPLATE CATEGORIES BELOW THIS LINE -->
| |
| - | [[Category:Typing-aid templates |{{PAGENAME}}]]
| |
| - | [[Category:Internal link templates |{{PAGENAME}}]]
| |
| - | [[Category:Interwiki link templates |{{PAGENAME}}]]
| |
| - |
| |
| - |
| |
| - | <!-- EDIT/ADD TEMPLATE Interwiki's BELOW THIS LINE -->
| |
| - | [[de:Vorlage:Vorlage]]
| |
| - | [[hsb:Předłoha:Tlx]]
| |
| - | [[ko:틀:Tlx]]
| |
| - | [[ia:Patrono:Tlx]]
| |
| - | [[ja:Template:Tlx]]
| |
| - | [[no:Mal:Tlx]]
| |
| - | [[ro:Format:Tlx]]
| |
| - | [[ru:Template:Tlx]]
| |
| - | [[simple:Template:Tlx]]
| |
| - | [[th:แม่แบบ:Tlx]]
| |
| - | [[uk:Шаблон:Tlx]]
| |
| - | </includeonly>
| |
Template:Tlx
