Template:Tlx/doc - Revision history

Prophecy at 23:35, 3 June 2008

2008-06-03T23:35:43Z

← Older revision		Revision as of 23:35, 3 June 2008
Line 1:		Line 1:
	{{documentation subpage}}		{{documentation subpage}}
	<!-- Parent template(s) usage Begins: --->		<!-- Parent template(s) usage Begins: --->
	{{tlx\|tlx\|~~template~~\|first parameter\|second\|third\|fourth\|fifth\|sixth\|seventh\|eight\|ninth}} →<br /> {{tlx\|~~template~~\|first parameter\|second\|third\|fourth\|fifth\|sixth\|seventh\|eight\|ninth}}		{{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~~\|SISTER=W:~~\|Tlx\|x0}}		\|{{Tlx\|Tlx\|x0}}
	\|{{Tlx~~\|SISTER=W:~~\|x0}}		\|{{Tlx\|x0}}
	\|\|		\|\|
	\|-		\|-
	\|{{Tlx~~\|SISTER=W:~~\|Tlx\|Abc}}		\|{{Tlx\|Tlx\|Abc}}
	\|{{Tlx~~\|SISTER=W:~~\|Abc}}		\|{{Tlx\|Abc}}
	\|\|		\|\|
	\|-		\|-
	\|{{Tlx~~\|SISTER=W:~~\|Tlx\|ABC}}		\|{{Tlx\|Tlx\|ABC}}
	\|{{Tlx~~\|SISTER=W:~~\|ABC}}		\|{{Tlx\|ABC}}
	\|\|		\|\|
	\|-		\|-
	\|{{Tlx~~\|SISTER=W:~~\|Tlx\|AbC}}		\|{{Tlx\|Tlx\|AbC}}
	\|{{Tlx~~\|SISTER=W:~~\|AbC}}		\|{{Tlx\|AbC}}
	\|\|		\|\|
	\|-		\|-
	\|{{Tlx~~\|SISTER=W:~~\|Tlx\|x1\|one}}		\|{{Tlx\|Tlx\|x1\|one}}
	\|{{Tlx~~\|SISTER=W:~~\|x1\|one}}		\|{{Tlx\|x1\|one}}
	\|\|		\|\|
	\|-		\|-
	\|{{Tlx~~\|SISTER=W:~~\|Tlx\|x2\|one\|two}}		\|{{Tlx\|Tlx\|x2\|one\|two}}
	\|{{Tlx~~\|SISTER=W:~~\|x2\|one\|two}}		\|{{Tlx\|x2\|one\|two}}
	\|\|		\|\|
	\|-		\|-
	\|{{Tlx~~\|SISTER=W:~~\|Tlx\|x3\|1<tt>\|</tt>2<tt>\|</tt>3}}		\|{{Tlx\|Tlx\|x3\|1<tt>\|</tt>2<tt>\|</tt>3}}
	\|{{Tlx~~\|SISTER=W:~~\|x3\|1\|2\|3}}		\|{{Tlx\|x3\|1\|2\|3}}
	\|\|		\|\|
	\|-		\|-
	\|{{Tlx~~\|SISTER=W:~~\|Tlx\|x4\|1<tt>\|</tt>2<tt>\|</tt>3\|4}}		\|{{Tlx\|Tlx\|x4\|1<tt>\|</tt>2<tt>\|</tt>3\|4}}
	\|{{Tlx~~\|SISTER=W:~~\|x4\|1\|2\|3\|4}}		\|{{Tlx\|x4\|1\|2\|3\|4}}
	\|up to 5 parameters, then ...		\|up to 5 parameters, then ...
	\|-		\|-
	\|{{Tlx~~\|SISTER=W:~~\|Tlx\|x4\|1<tt>\|</tt>2<tt>\|</tt>3&#124;4}}		\|{{Tlx\|Tlx\|x4\|1<tt>\|</tt>2<tt>\|</tt>3&#124;4}}
	\|{{Tlx~~\|SISTER=W:~~\|x4\|1\|2\|3\|4}}		\|{{Tlx\|x4\|1\|2\|3\|4}}
	\|align="right"\|<tt>&#124;</tt> for more		\|align="right"\|<tt>&#124;</tt> for more
	\|-		\|-
	\|{{Tlx~~\|SISTER=W:~~\|Tlx\|x1\|x=u}}		\|{{Tlx\|Tlx\|x1\|x=u}}
	\|{{Tlx~~\|SISTER=W:~~\|x1\|x=u}}		\|{{Tlx\|x1\|x=u}}
	\|'''=''' won't work		\|'''=''' won't work
	\|-		\|-
	\|{{Tlx~~\|SISTER=W:~~\|Tlx\|x1\|x&#61;u}}		\|{{Tlx\|Tlx\|x1\|x&#61;u}}
	\|{{Tlx~~\|SISTER=W:~~\|x1\|x=u}}		\|{{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~~\|SISTER=W:\|Tlx\|x1\|x<nowiki>{{=}}</nowiki>u}}~~		\|{{Tlx\|Tlx\|x1\|<nowiki>x=u</nowiki>}}
	~~\|{{Tlx\|SISTER=W:\|x1\|x{{=}}u}}~~		\|{{Tlx\|x1\|<nowiki>x=u</nowiki>}}
	~~\|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		\|align="right"\|sticky nowiki is okay
	\|-		\|-
	\|{{Tlx~~\|SISTER=W:~~\|Tlx\|x2\| \|two}}		\|{{Tlx\|Tlx\|x2\| \|two}}
	\|{{Tlx~~\|SISTER=W:~~\|x2\| \|two}}		\|{{Tlx\|x2\| \|two}}
	\|empty won't work		\|empty won't work
	\|-		\|-
	\|{{Tlx~~\|SISTER=W:~~\|Tlx\|x2\|&#32;\|two}}		\|{{Tlx\|Tlx\|x2\|&#32;\|two}}
	\|{{Tlx~~\|SISTER=W:~~\|x2\| \|two}}		\|{{Tlx\|x2\| \|two}}
	\|align="right"\|<tt>&#32;</tt> is okay		\|align="right"\|<tt>&#32;</tt> is okay
	\|-		\|-
	\|{{Tlx~~\|SISTER=W:~~\|Tlx\|x2\|&nbsp;\|two}}		\|{{Tlx\|Tlx\|x2\|&nbsp;\|two}}
	\|{{Tlx~~\|SISTER=W:~~\|x2\| \|two}}		\|{{Tlx\|x2\| \|two}}
	\|align="right"\|<tt>&nbsp;</tt> is okay		\|align="right"\|<tt>&nbsp;</tt> is okay
	\|-		\|-
	\|{{Tlx~~\|SISTER=W:~~\|Tlx\|x2\| &#124; two}}		\|{{Tlx\|Tlx\|x2\| &#124; two}}
	\|{{Tlx~~\|SISTER=W:~~\|x2\| \| two}}		\|{{Tlx\|x2\| \| two}}
	\|align="right"\|<tt>&#124;</tt> is okay		\|align="right"\|<tt>&#124;</tt> is okay
	\|-		\|-
	\|\| {{Tlx~~\|SISTER=W:~~\|Tlx\|x2\| {{!}} two}}		\|\| {{Tlx\|Tlx\|x2\| {{!}} two}}
	\|\| {{Tlx~~\|SISTER=W:~~\|x2\| {{!}} two}}		\|\| {{Tlx\|x2\| {{!}} two}}
	\|align="right"\|{{Tlx~~\|SISTER=W:~~\|!}} is dubious		\|align="right"\|{{Tlx\|!}} is dubious
	\|-		\|-
	\|\| {{Tlx~~\|SISTER=W:~~\|Tlx\|x2\|<nowiki>2=</nowiki>\|<nowiki>3=two</nowiki>}}		\|\| {{Tlx\|Tlx\|x2\|<nowiki>2=</nowiki>\|<nowiki>3=two</nowiki>}}
	\|\| {{Tlx~~\|SISTER=W:~~\|x2\|2=\|3=two}}		\|\| {{Tlx\|x2\|2=\|3=two}}
	\|empty really doesn't work		\|empty really doesn't work
	\|-		\|-
	\|\| {{Tlx~~\|SISTER=W:~~\|Tlx\|x2\|<nowiki>2=one</nowiki>\|two}}		\|\| {{Tlx\|Tlx\|x2\|<nowiki>2=one</nowiki>\|two}}
	\|\| {{Tlx~~\|SISTER=W:~~\|x2\|2=one\|two}}		\|\| {{Tlx\|x2\|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\|Tlx\|x2\|<nowiki>3=two</nowiki>\|<nowiki>2=one</nowiki>}}
	\|\| {{Tlx~~\|SISTER=W:~~\|x2\|3=two\|2=one}}		\|\| {{Tlx\|x2\|3=two\|2=one}}
	\|align="right"\|right to left okay		\|align="right"\|right to left okay
	\|}		\|}

	~~<!--- Categories applied to both /doc style Documentation page and to the parent templates --->~~
	~~[[Category:Templates using ParserFunctions\|{{{PAGENAME}}}]]~~

	<!-- 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 --->

Prophecy: New page: {{documentation subpage}} {{tlx|tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}} →
{{tlx|template|first...

2008-06-03T23:27:47Z

New page: {{documentation subpage}}  {{tlx|tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}} →<br /> {{tlx|template|first...

New page

{{documentation subpage}}

{{tlx|tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}} →<br /> {{tlx|template|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'

* 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 "<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 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> 'template name' (<nowiki>{{{1}}}</nowiki>), </code>'' it presents the same as the similar {{tl|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.

:* {{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 be preferred for mere listing and referencing in long pages involving a lot of template expansions.


==Documentation==

{{[[Template:{{PAGENAME}}|{{PAGENAME}}]]}}
is a generalization of {{Tlx|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 ===
{| 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
|}


[[Category:Templates using ParserFunctions|{{{PAGENAME}}}]]


<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

<includeonly>

[[Category:Typing-aid templates |{{PAGENAME}}]]
[[Category:Internal link templates |{{PAGENAME}}]]



</includeonly>

Template:Tlx/doc - Revision history

Prophecy at 23:35, 3 June 2008

Prophecy: New page: {{documentation subpage}} {{tlx|tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}} → {{tlx|template|first...

Prophecy: New page: {{documentation subpage}} {{tlx|tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}} →
{{tlx|template|first...