Template:Tlx/doc: Difference between revisions
Boobpedia - Encyclopedia of big boobs
Jump to navigationJump to search
(New page: {{documentation subpage}} <!-- Parent template(s) usage Begins: ---> {{tlx|tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}} →<br /> {{tlx|template|first...) |
No edit summary |
||
| Line 1: | Line 1: | ||
{{documentation subpage}} | {{documentation subpage}} | ||
<!-- Parent template(s) usage Begins: ---> | <!-- Parent template(s) usage Begins: ---> | ||
{{tlx|tlx| | {{tlx|tlx|example|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}} →<br /> {{tlx|example|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}} | ||
'''<big>Purpose and naming:</big>''' Mnemonically ''''T'''emplate '''l'''ist e'''x'''panded'... after <tt>{{tlx|tl}}</tt> '''T'''emplate '''l'''ist' | '''<big>Purpose and naming:</big>''' Mnemonically ''''T'''emplate '''l'''ist e'''x'''panded'... after <tt>{{tlx|tl}}</tt> '''T'''emplate '''l'''ist' | ||
| Line 44: | Line 44: | ||
! Remark | ! Remark | ||
|- | |- | ||
|{{Tlx | |{{Tlx|Tlx|x0}} | ||
|{{Tlx | |{{Tlx|x0}} | ||
||  | ||  | ||
|- | |- | ||
|{{Tlx | |{{Tlx|Tlx|Abc}} | ||
|{{Tlx | |{{Tlx|Abc}} | ||
||  | ||  | ||
|- | |- | ||
|{{Tlx | |{{Tlx|Tlx|ABC}} | ||
|{{Tlx | |{{Tlx|ABC}} | ||
||  | ||  | ||
|- | |- | ||
|{{Tlx | |{{Tlx|Tlx|AbC}} | ||
|{{Tlx | |{{Tlx|AbC}} | ||
||  | ||  | ||
|- | |- | ||
|{{Tlx | |{{Tlx|Tlx|x1|one}} | ||
|{{Tlx | |{{Tlx|x1|one}} | ||
||  | ||  | ||
|- | |- | ||
|{{Tlx | |{{Tlx|Tlx|x2|one|two}} | ||
|{{Tlx | |{{Tlx|x2|one|two}} | ||
||  | ||  | ||
|- | |- | ||
|{{Tlx | |{{Tlx|Tlx|x3|1<tt>|</tt>2<tt>|</tt>3}} | ||
|{{Tlx | |{{Tlx|x3|1|2|3}} | ||
||  | ||  | ||
|- | |- | ||
|{{Tlx | |{{Tlx|Tlx|x4|1<tt>|</tt>2<tt>|</tt>3|4}} | ||
|{{Tlx | |{{Tlx|x4|1|2|3|4}} | ||
|up to 5 parameters, then ... | |up to 5 parameters, then ... | ||
|- | |- | ||
|{{Tlx | |{{Tlx|Tlx|x4|1<tt>|</tt>2<tt>|</tt>3&#124;4}} | ||
|{{Tlx | |{{Tlx|x4|1|2|3|4}} | ||
|align="right"|<tt>&#124;</tt> for more | |align="right"|<tt>&#124;</tt> for more | ||
|- | |- | ||
|{{Tlx | |{{Tlx|Tlx|x1|x=u}} | ||
|{{Tlx | |{{Tlx|x1|x=u}} | ||
|'''=''' won't work | |'''=''' won't work | ||
|- | |- | ||
|{{Tlx | |{{Tlx|Tlx|x1|x&#61;u}} | ||
|{{Tlx | |{{Tlx|x1|x=u}} | ||
|align="right"|<tt>&#61;</tt> is okay | |align="right"|<tt>&#61;</tt> is okay | ||
<!--|- | |||
|{{Tlx|Tlx|x1|x<nowiki>{{=}}</nowiki>u}} | |||
|{{Tlx|x1|x{{=}}u}} | |||
|align="right"|<tt><nowiki>{{=}}</nowiki></tt> is okay--> | |||
|- | |- | ||
|{{Tlx | |{{Tlx|Tlx|x1|<nowiki>x=u</nowiki>}} | ||
|{{Tlx|x1|<nowiki>x=u</nowiki>}} | |||
|{{Tlx | |||
|align="right"|sticky nowiki is okay | |align="right"|sticky nowiki is okay | ||
|- | |- | ||
|{{Tlx | |{{Tlx|Tlx|x2| |two}} | ||
|{{Tlx | |{{Tlx|x2| |two}} | ||
|empty won't work | |empty won't work | ||
|- | |- | ||
|{{Tlx | |{{Tlx|Tlx|x2|&#32;|two}} | ||
|{{Tlx | |{{Tlx|x2| |two}} | ||
|align="right"|<tt>&#32;</tt> is okay | |align="right"|<tt>&#32;</tt> is okay | ||
|- | |- | ||
|{{Tlx | |{{Tlx|Tlx|x2|&nbsp;|two}} | ||
|{{Tlx | |{{Tlx|x2| |two}} | ||
|align="right"|<tt>&nbsp;</tt> is okay | |align="right"|<tt>&nbsp;</tt> is okay | ||
|- | |- | ||
|{{Tlx | |{{Tlx|Tlx|x2| &#124; two}} | ||
|{{Tlx | |{{Tlx|x2| | two}} | ||
|align="right"|<tt>&#124;</tt> is okay | |align="right"|<tt>&#124;</tt> is okay | ||
|- | |- | ||
|| {{Tlx | || {{Tlx|Tlx|x2| {{!}} two}} | ||
|| {{Tlx | || {{Tlx|x2| {{!}} two}} | ||
|align="right"|{{Tlx | |align="right"|{{Tlx|!}} is dubious | ||
|- | |- | ||
|| {{Tlx | || {{Tlx|Tlx|x2|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}} | ||
|| {{Tlx | || {{Tlx|x2|2=|3=two}} | ||
|empty really doesn't work | |empty really doesn't work | ||
|- | |- | ||
|| {{Tlx | || {{Tlx|Tlx|x2|<nowiki>2=one</nowiki>|two}} | ||
|| {{Tlx | || {{Tlx|x2|2=one|two}} | ||
|'''two''' clobbers '''2=one''' | |'''two''' clobbers '''2=one''' | ||
|- | |- | ||
|| {{Tlx | || {{Tlx|Tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}} | ||
|| {{Tlx | || {{Tlx|x2|3=two|2=one}} | ||
|align="right"|right to left okay | |align="right"|right to left okay | ||
|} | |} | ||
<!-- Add the Categories for this doc or usage page (only-- not for the calling template) BELOW THIS LINE ---> | <!-- Add the Categories for this doc or usage page (only-- not for the calling template) BELOW THIS LINE ---> | ||
Latest revision as of 23:35, 3 June 2008
{{Tlx|example|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}} →
{{Example|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. 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 "|..."). A keyword parameter can be used, when tagged as a nowiki-keyword: "<nowiki>siz=10<\nowiki>" with each keyword parameter surrounded by "<nowiki>" tags; see Examples at bottom. For more details, see the 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 "{{" 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 {{Tl}} template - a blue link nested in 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.
- Comparatively, {{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.
Documentation
{{Tlx/doc}} is a generalization of {{Tl|x}} with arguably better readable output. This depends on the browser, but too narrow uses of "{", "|", "}" in conjunction with links can be hard to read.
Examples
| Code | Result | Remark |
|---|---|---|
| {{Tlx|x0}} | {{X0}} | |
| {{Tlx|Abc}} | {{Abc}} | |
| {{Tlx|ABC}} | {{ABC}} | |
| {{Tlx|AbC}} | {{AbC}} | |
| {{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|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 |