Difference between revisions of "Template:Tlx"

From Battlestar Wiki, the free, open content Battlestar Galactica encyclopedia and episode guide
m (Template documentation)
(We already have this, it's just called differently)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<includeonly><span style="font-family:monospace;"><nowiki>{{</nowiki>[[{{{LANG|}}}{{{SISTER|}}}{{ns:Template}}:{{{1|}}}|{{#ifeq:{{lcfirst:{{{1|}}}}}|{{lc:{{{1|}}}}}|{{lcfirst:{{{1|}}}}}|{{{1}}}}}]]<!--
#REDIRECT [[Template:Tlp]]
-->{{#if:{{{2|}}}|
&#124;{{{2}}}
}}<!--
-->{{#if:{{{3|}}}|
&#124;{{{3}}}
}}<!--
-->{{#if:{{{4|}}}|
&#124;{{{4}}}
}}<!--
-->{{#if:{{{5|}}}|
&#124;{{{5}}}
}}<!--
-->{{#if:{{{6|}}}|
&#124;{{{6}}}
}}<!--
-->{{#if:{{{7|}}}|
&#124;{{{7}}}
}}<!--
-->{{#if:{{{8|}}}|
&#124;{{{8}}}
}}<!--
-->{{#if:{{{9|}}}|
&#124;{{{9}}}
}}<!--
-->{{#if:{{{10|}}}|
&#124;{{{10}}}
}}<!--
-->{{#if:{{{11|}}}|
&#124;{{{11}}}
}}<!--
-->{{#if:{{{12|}}}|
&#124;''...''
}}<nowiki>}}</nowiki></span></includeonly><noinclude>
 
<includeonly><!-----------------Interwiki Doc page pattern------------------->
 
{{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}}
 
'''<big>Purpose and naming:</big>''' [[Wikt:mnemonic|Mnemonically]] ''''T'''emplate '''l'''ist e'''x'''panded'... after <tt>{{tlx|tl}}</tt> '''T'''emplate '''l'''ist'
 
* 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>&amp;#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 in double-braces, putting only nowiki-braces <nowiki>"{{"</nowiki> to start, such as: "<nowiki><nowiki>{{</nowiki><\nowiki>Anytemplate |arg1=23 |siz=250px}}".
----
 
* If given no additional parameters except ''<code>&nbsp;'template&nbsp;name'&nbsp;(<nowiki>{{{1}}}</nowiki>), </code>''&nbsp;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|Tlx}} versus Tlx: {{Tlx|Tl}})
 
* Comparatively, {{Tlx|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 expansions[[W:WP:DPP|1]].
 
 
----
 
=== Usage ===
 
:<tt>{&#123;{{PAGENAME}}{{!}}template name&#125;}</tt>
:<tt>{&#123;{{PAGENAME}}{{!}}template name{{!}}param&#125;}</tt>
:<tt>{&#123;{{PAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3&#125;}</tt>
:<tt>{&#123;{{PAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3&amp;#124;more&#125;}</tt>
:<tt>{&#123;{{PAGENAME}}{{!}}template name{{!}}param&amp;#61;value&#125;}</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}}
||&#160;
|-
|{{Tlx|SISTER=W:|Tlx|x1|one}}
|{{Tlx|SISTER=W:|x1|one}}
||&#160;
|-
|{{Tlx|SISTER=W:|Tlx|x2|one|two}}
|{{Tlx|SISTER=W:|x2|one|two}}
||&#160;
|-
|{{Tlx|SISTER=W:|Tlx|x3|1<tt>&#124;</tt>2<tt>&#124;</tt>3}}
|{{Tlx|SISTER=W:|x3|1|2|3}}
||&#160;
|-
|{{Tlx|SISTER=W:|Tlx|x4|1<tt>&#124;</tt>2<tt>&#124;</tt>3|4}}
|{{Tlx|SISTER=W:|x4|1|2|3|4}}
|up to 5 parameters, then ...
|-
|{{Tlx|SISTER=W:|Tlx|x4|1<tt>&#124;</tt>2<tt>&#124;</tt>3&amp;#124;4}}
|{{Tlx|SISTER=W:|x4|1|2|3&#124;4}}
|align="right"|<tt>&amp;#124;</tt> for more
|-
|{{Tlx|SISTER=W:|Tlx|x1|x&#61;u}}
|{{Tlx|SISTER=W:|x1|x=u}}
|'''=''' won't work
|-
|{{Tlx|SISTER=W:|Tlx|x1|x&amp;#61;u}}
|{{Tlx|SISTER=W:|x1|x&#61;u}}
|align="right"|<tt>&amp;#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|&lt;nowiki&gt;x&#61;u&lt;/nowiki&gt;}}
|{{Tlx|SISTER=W:|x1|<nowiki>x=u</nowiki>}}
|align="right"|sticky nowiki is okay
|-
|{{Tlx|SISTER=W:|Tlx|x2|&#160;|two}}
|{{Tlx|SISTER=W:|x2| |two}}
|empty won't work
|-
|{{Tlx|SISTER=W:|Tlx|x2|&amp;#32;|two}}
|{{Tlx|SISTER=W:|x2|&#32;|two}}
|align="right"|<tt>&amp;#32;</tt> is okay
|-
|{{Tlx|SISTER=W:|Tlx|x2|&amp;nbsp;|two}}
|{{Tlx|SISTER=W:|x2|&nbsp;|two}}
|align="right"|<tt>&amp;nbsp;</tt> is okay
|-
|{{Tlx|SISTER=W:|Tlx|x2| &amp;#124; two}}
|{{Tlx|SISTER=W:|x2| &#124; two}}
|align="right"|<tt>&amp;#124;</tt> is okay
|-
|| {{Tlx|SISTER=W:|Tlx|x2| {&#123;!&#125;} 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
|}
 
==Source credit==
This template and it's documentation are based on [[w:Template:Tlx]] from Wikipedia, licensed under the GNU Public Documentation License.
 
[[Category: Internal link templates]]
 
 
</noinclude>

Latest revision as of 18:32, 8 February 2008

Redirect to: