Template

Difference between revisions of "Tlx/doc"

From Joomla! Documentation

< Template:Tlx
(New page: {{documentation subpage}} {{tlx|tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}} → {{tlx|template|first parameter|second|third|fourth|fifth|sixth|sevent...)
 
m
Line 2: Line 2:
 
{{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}}
 
{{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'  
+
'''<big>Purpose and naming:</big>''' [[Wiktionary: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. It's primary use is in instruction and documentation.
+
This template takes another ''template-name'' and some associated [[wikipedia: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. It's primary use is in instruction and documentation.
  
 
== Specifics==
 
== 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>size=10<\nowiki>"</nowiki> with each keyword parameter surrounded by <nowiki>"<nowiki>"</nowiki> tags; see ''[[#Examples|Examples]]'' at bottom. For more details, see the [[:{{TALKPAGENAME}}|this talk]] page.
+
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>size=10<\nowiki>"</nowiki> with each keyword parameter surrounded by <nowiki>"<nowiki>"</nowiki> tags; see ''[[#Examples|Examples]]'' at bottom.  
  
 
===Exceptions===
 
===Exceptions===
Line 26: Line 26:
  
 
=== Examples ===
 
=== Examples ===
<!--  
+
<!-- This are original examples from the Wikipedia source document. Support for the SISTER parameter is suppressed in our version of {tlx} . Should sister wikis of {{SITENAME}} every become available, the paramater may be reintroduced. [[User:CirTap|CirTap]]
this are original examples from the Wikipedia source document. Support for the SISTER parameter has been removed. Should JDN sister wikis every become available, the paramater may be reintroduced
 
[[User:Cirtap]]
 
 
-->
 
-->
 
{| border="1" cellpadding="4" class="wikitable"
 
{| border="1" cellpadding="4" class="wikitable"
Line 39: Line 37:
 
||&#160;
 
||&#160;
 
|-
 
|-
|{{Tlx|SISTER=W:|Tlx|x1|one}}
+
|{{Tlx|SISTER=W:|Tlx|x0|one}}
|{{Tlx|SISTER=W:|x1|one}}
+
|{{Tlx|SISTER=W:|x0|one}}
 
||&#160;
 
||&#160;
 
|-
 
|-
|{{Tlx|SISTER=W:|Tlx|x2|one|two}}
+
|{{Tlx|SISTER=W:|Tlx|x0|one|two}}
|{{Tlx|SISTER=W:|x2|one|two}}
+
|{{Tlx|SISTER=W:|x0|one|two}}
 
||&#160;
 
||&#160;
 
|-
 
|-
|{{Tlx|SISTER=W:|Tlx|x3|1<tt>&#124;</tt>2<tt>&#124;</tt>3}}
+
|{{Tlx|SISTER=W:|Tlx|x0|1<tt>&#124;</tt>2<tt>&#124;</tt>3}}
|{{Tlx|SISTER=W:|x3|1|2|3}}
+
|{{Tlx|SISTER=W:|x0|1|2|3}}
 
||&#160;
 
||&#160;
 
|-
 
|-
|{{Tlx|SISTER=W:|Tlx|x4|1<tt>&#124;</tt>2<tt>&#124;</tt>3|4}}
+
|{{Tlx|SISTER=W:|Tlx|x0|1<tt>&#124;</tt>2<tt>&#124;</tt>3|4}}
|{{Tlx|SISTER=W:|x4|1|2|3|4}}
+
|{{Tlx|SISTER=W:|x0|1|2|3|4}}
 
|up to 5 parameters, then ...
 
|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:|Tlx|x0|1<tt>&#124;</tt>2<tt>&#124;</tt>3&amp;#124;4}}
|{{Tlx|SISTER=W:|x4|1|2|3&#124;4}}
+
|{{Tlx|SISTER=W:|x0|1|2|3&#124;4}}
 
|align="right"|<tt>&amp;#124;</tt> for more
 
|align="right"|<tt>&amp;#124;</tt> for more
 
|-
 
|-
|{{Tlx|SISTER=W:|Tlx|x1|x&#61;u}}
+
|{{Tlx|SISTER=W:|Tlx|x0|x&#61;u}}
|{{Tlx|SISTER=W:|x1|x=u}}
+
|{{Tlx|SISTER=W:|x0|x=u}}
 
|'''=''' won't work
 
|'''=''' won't work
 
|-
 
|-
|{{Tlx|SISTER=W:|Tlx|x1|x&amp;#61;u}}
+
|{{Tlx|SISTER=W:|Tlx|x0|x&amp;#61;u}}
|{{Tlx|SISTER=W:|x1|x&#61;u}}
+
|{{Tlx|SISTER=W:|x0|x&#61;u}}
 
|align="right"|<tt>&amp;#61;</tt> is okay
 
|align="right"|<tt>&amp;#61;</tt> is okay
 
|-
 
|-
|{{Tlx|SISTER=W:|Tlx|x1|&lt;nowiki&gt;x&#61;u&lt;/nowiki&gt;}}
+
|{{Tlx|SISTER=W:|Tlx|x0|&lt;nowiki&gt;x&#61;u&lt;/nowiki&gt;}}
|{{Tlx|SISTER=W:|x1|<nowiki>x=u</nowiki>}}
+
|{{Tlx|SISTER=W:|x0|<nowiki>x=u</nowiki>}}
 
|align="right"|sticky nowiki is okay
 
|align="right"|sticky nowiki is okay
 
|-
 
|-
|{{Tlx|SISTER=W:|Tlx|x2|&#160;|two}}
+
|{{Tlx|SISTER=W:|Tlx|x0|&#160;|two}}
|{{Tlx|SISTER=W:|x2| |two}}
+
|{{Tlx|SISTER=W:|x0| |two}}
 
|empty won't work
 
|empty won't work
 
|-
 
|-
|{{Tlx|SISTER=W:|Tlx|x2|&amp;#32;|two}}
+
|{{Tlx|SISTER=W:|Tlx|x0|&amp;#32;|two}}
|{{Tlx|SISTER=W:|x2|&#32;|two}}
+
|{{Tlx|SISTER=W:|x0|&#32;|two}}
 
|align="right"|<tt>&amp;#32;</tt> is okay
 
|align="right"|<tt>&amp;#32;</tt> is okay
 
|-
 
|-
|{{Tlx|SISTER=W:|Tlx|x2|&amp;nbsp;|two}}
+
|{{Tlx|SISTER=W:|Tlx|x0|&amp;nbsp;|two}}
|{{Tlx|SISTER=W:|x2|&nbsp;|two}}
+
|{{Tlx|SISTER=W:|x0|&nbsp;|two}}
 
|align="right"|<tt>&amp;nbsp;</tt> is okay
 
|align="right"|<tt>&amp;nbsp;</tt> is okay
 
|-
 
|-
|{{Tlx|SISTER=W:|Tlx|x2| &amp;#124; two}}
+
|{{Tlx|SISTER=W:|Tlx|x0| &amp;#124; two}}
|{{Tlx|SISTER=W:|x2| &#124; two}}
+
|{{Tlx|SISTER=W:|x0| &#124; two}}
 
|align="right"|<tt>&amp;#124;</tt> is okay
 
|align="right"|<tt>&amp;#124;</tt> is okay
 
|-
 
|-
|| {{Tlx|SISTER=W:|Tlx|x2| {&#123;!&#125;} two}}
+
|| {{Tlx|SISTER=W:|Tlx|x0| {&#123;!&#125;} two}}
|| {{Tlx|SISTER=W:|x2| {{!}} two}}
+
|| {{Tlx|SISTER=W:|x0| {{!}} two}}
 
|align="right"|{{Tlx|SISTER=W:|!}} is dubious
 
|align="right"|{{Tlx|SISTER=W:|!}} is dubious
 
|-
 
|-
|| {{Tlx|SISTER=W:|Tlx|x2|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}}
+
|| {{Tlx|SISTER=W:|Tlx|x0|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}}
|| {{Tlx|SISTER=W:|x2|2=|3=two}}
+
|| {{Tlx|SISTER=W:|x0|2=|3=two}}
 
|empty really doesn't work
 
|empty really doesn't work
 
|-
 
|-
|| {{Tlx|SISTER=W:|Tlx|x2|<nowiki>2=one</nowiki>|two}}
+
|| {{Tlx|SISTER=W:|Tlx|x0|<nowiki>2=one</nowiki>|two}}
|| {{Tlx|SISTER=W:|x2|2=one|two}}
+
|| {{Tlx|SISTER=W:|x0|2=one|two}}
 
|'''two''' clobbers '''2=one'''
 
|'''two''' clobbers '''2=one'''
 
|-
 
|-
|| {{Tlx|SISTER=W:|Tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}}
+
|| {{Tlx|SISTER=W:|Tlx|x0|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}}
|| {{Tlx|SISTER=W:|x2|3=two|2=one}}
+
|| {{Tlx|SISTER=W:|x0|3=two|2=one}}
 
|align="right"|right to left okay
 
|align="right"|right to left okay
 
|}
 
|}
 
<includeonly>  
 
<includeonly>  
 
<!-- EDIT IN (calling) TEMPLATE CATEGORIES BELOW THIS LINE -->
 
<!-- EDIT IN (calling) TEMPLATE CATEGORIES BELOW THIS LINE -->
[[Category:Typing-aid templates |{{PAGENAME}}]]
+
[[Category:Link templates |{{PAGENAME}}]]
 
</includeonly>
 
</includeonly>
  

Revision as of 13:35, 26 April 2008

This is a documentation subpage for Template:Tlx.
It contains usage information, categories and other content that is not part of the original template page.
To view the template page itself, see Template:Tlx.

{{tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}}{{template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}}

Purpose and naming: Mnemonically 'Template list expanded'... after {{tl}} Template list'

This template takes another template-name and some associated pipe-tricked (numbered) parameters (or 'pass parameters'), and displays them as an 'example demonstration' of how the template-name template could be coded, literally. It's primary use is in instruction and documentation.

Specifics[edit]

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 "&#124;..."). A keyword parameter can be used, when tagged as a nowiki-keyword: "<nowiki>size=10<\nowiki>" with each keyword parameter surrounded by "<nowiki>" tags; see Examples at bottom.

Exceptions[edit]

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 "{{" to start, such as: "<nowiki>{{<\nowiki>Anytemplate |arg1=23 |siz=250px}}".

If given no additional parameters except  'template name' ({{{1}}}),  it presents the same as the similar {{tlp}} macro template -- a blue link nested in curly-braces -- but better readability in modern browsers.

{{tlp|tl}} display compared to {{tlx|tl}}: (Tlp: {{tlx}} versus Tlx: {{tlx}})

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 expansions.

Usage[edit]

{{tlx|template name}}
{{tlx|template name|param}}
{{tlx|template name|1|2|3}}
{{tlx|template name|1|2|3&#124;more}}
{{tlx|template name|param&#61;value}}

Up to three placeholders for parameters of the specified template

Examples[edit]

Code Result Remark
{{tlx|x0}} {{x0}}  
{{tlx|x0|one}} {{x0|one}}  
{{tlx|x0|one|two}} {{x0|one|two}}  
{{tlx|x0|1|2|3}} {{x0|1|2|3}}  
{{tlx|x0|1|2|3|4}} {{x0|1|2|3|4}} up to 5 parameters, then ...
{{tlx|x0|1|2|3&#124;4}} {{x0|1|2|3|4}} &#124; for more
{{tlx|x0|x=u}} {{x0}} = won't work
{{tlx|x0|x&#61;u}} {{x0|x=u}} &#61; is okay
{{tlx|x0|<nowiki>x=u</nowiki>}} {{x0|x=u}} sticky nowiki is okay
{{tlx|x0| |two}} {{x0|two}} empty won't work
{{tlx|x0|&#32;|two}} {{x0| |two}} &#32; is okay
{{tlx|x0|&nbsp;|two}} {{x0| |two}} &nbsp; is okay
{{tlx|x0| &#124; two}} {{x0| | two}} &#124; is okay
{{tlx|x0| {{!}} two}} {{x0| | two}} {{!}} is dubious
{{tlx|x0|2=|3=two}} {{x0|two}} empty really doesn't work
{{tlx|x0|2=one|two}} {{x0|two}} two clobbers 2=one
{{tlx|x0|3=two|2=one}} {{x0|one|two}} right to left okay


Related[edit]