Template:Tlx/doc

From Wikipedia, the free encyclopedia

This is the template documentation page yes This page is not necessarily intended to be viewed directly. If it uses variables, some links may appear broken. Do not replace these variables with hardcoded page names or URLs.

---

Similar templates at English sister projects [edit]
	mta	Meta-wiki	Tlx/doc
	wpd	Wikipedia	Tlx/doc
	cms	Commons	Tlx/doc
	wbk	Wikibooks	Tlx/doc
	wsp	Wikispecies	Tlx/doc
	wvy	Wikiversity	Tlx/doc
This project under construction ... Pardon our appearance whist we remodel, pull the engine, and change the tires.

{{tlx|template|first parameter|second|third|...}} → {{template|first parameter|second|third|fourth|...}}

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 aggregates them into an 'example demonstration' of how the template-name template might be used. It's primary use is in instruction and documentation such as this passage.

• Up to five pass parameters (numbered) for the specified template are displayed as 'placeholders', and more parameters are shown as "|...", for details see the this talk page.

---

• If given no additional parameters except  'template name' ({{{1}}}),  it presents the same as the similar {{Tl}} macro 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.

• {{tl|Tl}} display compared to {{tlx|Tl}}: (Tl: {{Tlx}} versus Tlx: {{tl}})

• 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 expansions1.

• 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 {{tlxw}} and {{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

1. {{Tlxc}} -- which links to templates on Wikimedia Commons (The Commons).
2. {{Tlxm}} -- which links to templates on Meta
3. {{Tlxw}} -- which links to templates on Wikipedia

---

[edit] Documentation

{{Tlx/doc}} is a generalization of {{tl|x}}, {{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.

[edit] Examples

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|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|&#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