SirRandomage: /* Purpose and naming */

2010-05-10T15:16:08Z

Purpose and naming

← Older revision		Revision as of 15:16, 10 May 2010
Line 26:		Line 26:

	* {{tlx\|Tlx}} has a named parameter ''subst''. Setting this parameter to any string of length 1 or greater will place the string "subst:" before the template name, linked to [[Help:Substitution]]. This is useful to indicate when a template should be substituted. For example {{tlx\|Tlx\|Welcome\|<nowiki>subst=Y</nowiki>}} will display {{Tlx\|Welcome\|subst=Y}}.		* {{tlx\|Tlx}} has a named parameter ''subst''. Setting this parameter to any string of length 1 or greater will place the string "subst:" before the template name, linked to [[Help:Substitution]]. This is useful to indicate when a template should be substituted. For example {{tlx\|Tlx\|Welcome\|<nowiki>subst=Y</nowiki>}} will display {{Tlx\|Welcome\|subst=Y}}.

	* Additionally, Tlx will take a 'named' parameter 'SISTER' to link interwiki to other sister projects such as one of these examples: '\|SISTER=W:', 'Tlx\|SISTER=M:', 'Tlx\|SISTER=Q:', 'Tlx\|SISTER=S:', allowing documentation or discourse about a template across interwiki boundaries. Small 'front end' Shell or convience templates {{Tlx\|Tlxw}} and {{tlx\|Tlxm}} are typing-aid templates available at Meta for automatic substitution in discussions about templates on Wikipedia or Meta.

	~~----~~

	~~;This usage also applies to interwiki capable template variations:~~
	~~# {{Tl\|Tlxc}} -- which links to templates on Wikimedia Commons (The Commons).~~
	~~# {{Tl\|Tlxm}} -- which links to templates on Meta~~
	~~# {{Tl\|Tlxw}} -- which links to templates on Wikipedia~~

	~~----~~

	== Documentation ==		== Documentation ==

SirRandomage at 14:49, 10 May 2010

2010-05-10T14:49:22Z

← Older revision		Revision as of 14:49, 10 May 2010
Line 2:		Line 2:
	<small>''This '{{Tlx\|Tlx}}' template documentation is [[w:Wikipedia:Template doc page pattern\|transcluded]] for all ''Tlx family templates (Tlx, Tlxc, Tlxm, Tlxw, Tlxb)'' [<span class="plainlinks">[{{fullurl:Template:Tlx/doc \|action=edit}} edit]</span>].{{#ifeq:{{SITENAME}}\|Meta\| \|[[M:template:{{PAGENAMEE}}\|Masterpage]]		<small>''This '{{Tlx\|Tlx}}' template documentation is [[w:Wikipedia:Template doc page pattern\|transcluded]] for all ''Tlx family templates (Tlx, Tlxc, Tlxm, Tlxw, Tlxb)'' [<span class="plainlinks">[{{fullurl:Template:Tlx/doc \|action=edit}} edit]</span>].{{#ifeq:{{SITENAME}}\|Meta\| \|[[M:template:{{PAGENAMEE}}\|Masterpage]]
	}}</small></includeonly><noinclude>		}}</small></includeonly><noinclude>
	{{Documentation subpage}}		{{Documentation subpage}}</noinclude>
	~~{{-}}~~
	~~{{interwikitmp-grp~~
	~~\|V=D~~
	~~\|cats=~~
	~~\|inhib=yes~~
	~~\|wdy=\|wqt=\|wsr=\|wnw=~~
	~~\|{{PAGENAME}}\|{{PAGENAME}}~~}}</noinclude>

	<!-- Parent template(s) usage begins: --->		<!-- Parent template(s) usage begins: --->

SirRandomage: new

2010-05-10T14:47:58Z

new

New page

<includeonly>
''This '{{Tlx|Tlx}}' template documentation is [[w:Wikipedia:Template doc page pattern|transcluded]] for all ''Tlx family templates (Tlx, Tlxc, Tlxm, Tlxw, Tlxb)'' [[{{fullurl:Template:Tlx/doc |action=edit}} edit]].{{#ifeq:{{SITENAME}}|Meta| |[[M:template:{{PAGENAMEE}}|Masterpage]]
 }}</includeonly><noinclude>
{{Documentation subpage}}
{{-}}
{{interwikitmp-grp
|V=D
|cats=
|inhib=yes
|wdy=|wqt=|wsr=|wnw=
|{{PAGENAME}}|{{PAGENAME}}}}</noinclude>



: {{tlx|Tlx|Template|first parameter|second|third| ...|tenth|11th}} → {{Tlx|Template|first parameter|second|third|...|tenth|11th}}
: {{tlx|Tlx|Template|<nowiki>first|second|...|999th</nowiki>}}

== Purpose and naming ==
[[Wikt:mnemonic|Mnemonically]] ''''T'''emplate '''l'''ink e'''x'''panded'. After <tt>{{tlx|Tl}}</tt> '''T'''emplate '''l'''ink'.

* This template takes another ''template-name'' and some associated [[Help:Pipe trick|pipe-tricked]] [[m: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 11 pass parameters (numbered or nowiki-keywords) for the specified template are displayed as 'placeholders', and over 11 parameters can be displayed using a coded vertical-bar (as in "&#124;''...''"). A keyword parameter can be used with equals code &#61; or <nowiki>{{=}}</nowiki> or in nowiki-text: "<nowiki>size=10</nowiki>" or all parameters as a string in <nowiki>"<nowiki>"</nowiki> tags; see ''[[#Examples|Examples]]'' at bottom. For more details, see [[{{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 with <code><nowiki><code><nowiki></nowiki></code>, for example: <code><nowiki><code><nowiki>{{Anytemplate|arg1=23|size=250px|</nowiki><var>other parameters...</var><nowiki>}}</nowiki></code></nowiki></code>. If a vertical display, with parameters on their own lines, is desired, this can also be laid out manually in this manner, or more rapidly done with <code><nowiki><pre>...</pre></nowiki></code>.

----

* If given no additional parameters except ''<code> 'template name' (<nowiki>{{{1}}}</nowiki>), </code>'' it presents the same as the similar {{tl|Tl}} [[macro]] template -- a blue link nested in [[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|Tl}} 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.

* {{tlx|Tlx}} has a named parameter ''subst''. Setting this parameter to any string of length 1 or greater will place the string "subst:" before the template name, linked to [[Help:Substitution]]. This is useful to indicate when a template should be substituted. For example {{tlx|Tlx|Welcome|<nowiki>subst=Y</nowiki>}} will display {{Tlx|Welcome|subst=Y}}.

* Additionally, Tlx will take a 'named' parameter 'SISTER' to link interwiki to other sister projects such as one of these examples: '|SISTER=W:', 'Tlx|SISTER=M:', 'Tlx|SISTER=Q:', 'Tlx|SISTER=S:', allowing documentation or discourse about a template across interwiki boundaries. Small 'front end' Shell or convience templates {{Tlx|Tlxw}} and {{tlx|Tlxm}} are typing-aid templates available at Meta for automatic substitution in discussions about templates on Wikipedia or Meta.

----

;This usage also applies to interwiki capable template variations:
# {{Tl|Tlxc}} -- which links to templates on Wikimedia Commons (The Commons).
# {{Tl|Tlxm}} -- which links to templates on Meta
# {{Tl|Tlxw}} -- which links to templates on Wikipedia

----

== Documentation ==

{{[[Template:{{BASEPAGENAME}}|{{BASEPAGENAME}}]]}}
is a generalization of {{Tl|Tl|x}}, {{Tl|Tlp|x|y}},
etcetera with arguably better readable
output. This depends on the browser, but too narrow
uses of "'''{'''", "'''|'''", "'''}'''" in conjunction
with links can be hard to read.

=== Usage ===

:<tt>{{{{BASEPAGENAME}}{{!}}template name}}</tt>
:<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}param}}</tt>
:<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3}}</tt>
:<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3&#124;more}}</tt>
:<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}param&#61;value}}</tt>
''Up to three placeholders for parameters of the specified template''

=== Examples ===
{{#ifeq:{{SITENAME}}|Wikipedia||
{{#ifeq:{{SITENAME}}|Meta||
;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|Tlx|x0}}
|{{Tlx|x0}}
|| 
|-
|{{Tlx|Tlx|Abc}}
|{{Tlx|Abc}}
|| 
|-
|{{Tlx|Tlx|ABC}}
|{{Tlx|ABC}}
|| 
|-
|{{Tlx|Tlx|AbC}}
|{{Tlx|AbC}}
|| 
|-
|{{Tlx|Tlx|x1|one}}
|{{Tlx|x1|one}}
|| 
|-
|{{Tlx|Tlx|x2|one|two}}
|{{Tlx|x2|one|two}}
|| 
|-
|{{Tlx|Tlx|x3|1<tt>|</tt>2<tt>|</tt>3}}
|{{Tlx|x3|1|2|3}}
|| 
|-
|{{Tlx|Tlx|x4|1<tt>|</tt>2<tt>|</tt>3|4}}
|{{Tlx|x4|1|2|3|4}}
|up to 5 parameters, then ...
|-
|{{Tlx|Tlx|x4|1<tt>|</tt>2<tt>|</tt>3&#124;4}}
|{{Tlx|x4|1|2|3|4}}
|align="right"|<tt>&#124;</tt> for more
|-
|{{Tlx|Tlx|x1|x=u}}
|{{Tlx|x1|x=u}}
|'''=''' won't work
|-
|{{Tlx|Tlx|x1|x&#61;u}}
|{{Tlx|x1|x=u}}
|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|x1|<nowiki>x=u</nowiki>}}
|{{Tlx|x1|<nowiki>x=u</nowiki>}}
|align="right"|sticky nowiki is okay
|-
|{{Tlx|Tlx|x2| |two}}
|{{Tlx|x2| |two}}
|empty won't work
|-
|{{Tlx|Tlx|x2|&#32;|two}}
|{{Tlx|x2| |two}}
|align="right"|<tt>&#32;</tt> is okay
|-
|{{Tlx|Tlx|x2|&nbsp;|two}}
|{{Tlx|x2| |two}}
|align="right"|<tt>&nbsp;</tt> is okay
|-
|{{Tlx|Tlx|x2| &#124; two}}
|{{Tlx|x2| | two}}
|align="right"|<tt>&#124;</tt> is okay
|-
|| {{Tlx|Tlx|x2| {{!}} two}}
|| {{Tlx|x2| {{!}} two}}
|align="right"|{{Tlx|!}} is dubious
|-
|| {{Tlx|Tlx|x2|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}}
|| {{Tlx|x2|2=|3=two}}
|empty really doesn't work
|-
|| {{Tlx|Tlx|x2|<nowiki>2=one</nowiki>|two}}
|| {{Tlx|x2|2=one|two}}
|'''two''' clobbers '''2=one'''
|-
|| {{Tlx|Tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}}
|| {{Tlx|x2|3=two|2=one}}
|align="right"|right to left okay
|-
|colspan=2| <tt><nowiki>{{Tlx</nowiki></tt>|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki><tt><nowiki>}}</nowiki></tt>
|unlimited parameters as one nowiki string
|}

== See also ==
<includeonly>{{interwikitmp-grp|V=6|cat=Typing-aid templates |CATS=[[Category:Internal link templates|Tlx]][[Category:Interwiki link templates|Tlx]]}}</includeonly>

* [[Template:Tlxb]] – same as {{tl|Tlx}}, but gives the template name in boldface type (this can be useful when stressing the difference between two similarly named templates). [[Template:Tlb]] is the same, except it uses regular text instead of a monospaced non-proportional font.
* [[Template:Para]] – for giving examples of template parameters and values only, instead of entire templates with parameters.




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

<includeonly>

</includeonly>

Template:Tlx/doc - Revision history

SirRandomage: /* Purpose and naming */

SirRandomage at 14:49, 10 May 2010

SirRandomage: new