Template

Tlx/doc

From Joomla! Documentation

< Template:Tlx
Revision as of 11:24, 17 January 2008 by CirTap (talk | contribs) (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...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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. For more details, see the this talk page.

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|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 5 parameters, then ...
{{tlx|x4|1|2|3&#124;4}} {{x4|1|2|3|4}} &#124; for more
{{tlx|x1|x=u}} {{x1}} = won't work
{{tlx|x1|x&#61;u}} {{x1|x=u}} &#61; 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|&#32;|two}} {{x2| |two}} &#32; is okay
{{tlx|x2|&nbsp;|two}} {{x2| |two}} &nbsp; is okay
{{tlx|x2| &#124; two}} {{x2| | two}} &#124; 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


Related[edit]