Template:Tlx/doc

{{#if: |

40px	This is the template documentation page for Template:Tlx.
	This page may not be intended to be viewed directly. Links using variables may appear broken; do not replace these with hardcoded page names or URLs.

{{#if:x||

}} |{{#ifeq: doc | doc

 | 

{{

   #ifeq: show | show
   | {{
 {{#switch:
 {{#if: 
   | 
   | {{#if: 
     | 
       {{#ifeq:|
       | talk
       |  
       }}
     | 
       {{#ifeq:template|template talk
       | talk
       | template 
       }}
     }}
   }}

| main | = ambox | talk = tmbox | user = ombox | wikipedia = ombox | file | image = imbox | mediawiki = ombox | template = ombox | help = ombox | category = cmbox | portal = ombox | book = ombox | other | #default = ombox

}} | type = notice | image = none | imageright = | class = | style = | textstyle = | text = This is a documentation subpage for Template:Tlx (see that page for the {{ #if: Template | template | article }} itself).
It contains usage information, categories and other content that is not part of the original {{ #if: Template |template page|article}}. | small = | smallimage = | smallimageright = | smalltext = | subst = | date = }}

   }}{{
   #if: 
   | 
   | [[Category:{{
     #if: Template
     | Template
     | Article
   }} documentation]]
 }}

| }} }}

{{#if: | }} {{#if: {{{wpd}}} | }} {{#if: {{{cms}}} | {{#ifeq: DARwiki|Wikimedia Commons | | }} }} {{#if: {{{wbk}}} | {{#ifeq: DARwiki|Wikibooks | | }} }} {{#if: | {{#ifeq:DARwiki|Wikiquote| | }} }} {{#if: | {{#ifeq:DARwiki|Wikisource| | }} }} {{#if: | {{#if: | }} }} {{#if: | {{#if: | }} }} {{#if: {{{wsp}}} | {{#ifeq:DARwiki|Wikispecies| | }} }} {{#if: {{{wvy}}} |

{{#ifeq:DARwiki|Wikiversity

| | }} }} {{#if: | }}

Similar templates at English sister projects [edit]
25x25px	mta	Meta-wiki	Tlx/doc
25x25px	wpd	Wikipedia	Tlx/doc
25x25px	cms	Commons	Tlx/doc	Tlx/doc
25x25px	wbk	Wikibooks	Tlx/doc	Tlx/doc
25x25px	wqt	Wikiquote	[[Template:|]]	[[q:Template:|]]
25x25px	wsr	Wikisource	[[Template:|]]	[[s:Template:|]]
25x25px	wdy	Wiktionary	[[wikt:Template:|]]
25x25px	wnw	Wikinews	[[n:Template:|]]
25x25px	wsp	Wikispecies	Tlx/doc	Tlx/doc
25x25px	wvy	Wikiversity	Tlx/doc	Tlx/doc
25x25px	mdw	Mediawiki	Tlx/doc

{{{{#if:|subst:}}tlx{{#if:template| |template }}{{#if:first parameter| |first parameter }}{{#if:second| |second }}{{#if:third| |third }}{{#if:fourth| |fourth }}{{#if:fifth| |fifth }}{{#if:sixth| |sixth }}{{#if:seventh| |seventh }}{{#if:eight| |eight }}{{#if:ninth| |ninth }}{{#if:| |... }}}} → {{{{#if:|subst:}}template{{#if:first parameter| |first parameter }}{{#if:second| |second }}{{#if:third| |third }}{{#if:fourth| |fourth }}{{#if:fifth| |fifth }}{{#if:sixth| |sixth }}{{#if:seventh| |seventh }}{{#if:eight| |eight }}{{#if:ninth| |ninth }}{{#if:| |{{{11}}} }}{{#if:| |... }}}}

Purpose and naming

Mnemonically 'Template link expanded'... after {{{{#if:|subst:}}tl{{#if:| |{{{2}}} }}{{#if:| |{{{3}}} }}{{#if:| |{{{4}}} }}{{#if:| |{{{5}}} }}{{#if:| |{{{6}}} }}{{#if:| |{{{7}}} }}{{#if:| |{{{8}}} }}{{#if:| |{{{9}}} }}{{#if:| |{{{10}}} }}{{#if:| |{{{11}}} }}{{#if:| |... }}}} Template link'

• 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 "&#124;..."). 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 with <code><nowiki></code>, for example: <code><nowiki><code><nowiki>{{Anytemplate|arg1=23|siz=250px|other parameters...}}</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 <pre>...</pre>.

---

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

• {{{{#if:|subst:}}Tl{{#if:Tl|

|Tl }}{{#if:| |{{{3}}} }}{{#if:| |{{{4}}} }}{{#if:| |{{{5}}} }}{{#if:| |{{{6}}} }}{{#if:| |{{{7}}} }}{{#if:| |{{{8}}} }}{{#if:| |{{{9}}} }}{{#if:| |{{{10}}} }}{{#if:| |{{{11}}} }}{{#if:| |... }}}} display compared to {{{{#if:|subst:}}Tlx{{#if:Tl| |Tl }}{{#if:| |{{{3}}} }}{{#if:| |{{{4}}} }}{{#if:| |{{{5}}} }}{{#if:| |{{{6}}} }}{{#if:| |{{{7}}} }}{{#if:| |{{{8}}} }}{{#if:| |{{{9}}} }}{{#if:| |{{{10}}} }}{{#if:| |{{{11}}} }}{{#if:| |... }}}}: (Tl: {{Tlx}} versus Tlx: {{{{#if:|subst:}}Tl{{#if:| |{{{2}}} }}{{#if:| |{{{3}}} }}{{#if:| |{{{4}}} }}{{#if:| |{{{5}}} }}{{#if:| |{{{6}}} }}{{#if:| |{{{7}}} }}{{#if:| |{{{8}}} }}{{#if:| |{{{9}}} }}{{#if:| |{{{10}}} }}{{#if:| |{{{11}}} }}{{#if:| |... }}}})

• Comparatively, {{{{#if:|subst:}}Tl{{#if:|

|{{{2}}} }}{{#if:| |{{{3}}} }}{{#if:| |{{{4}}} }}{{#if:| |{{{5}}} }}{{#if:| |{{{6}}} }}{{#if:| |{{{7}}} }}{{#if:| |{{{8}}} }}{{#if:| |{{{9}}} }}{{#if:| |{{{10}}} }}{{#if:| |{{{11}}} }}{{#if:| |... }}}} 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 {{{{#if:|subst:}}Tlxw{{#if:|

|{{{2}}} }}{{#if:| |{{{3}}} }}{{#if:| |{{{4}}} }}{{#if:| |{{{5}}} }}{{#if:| |{{{6}}} }}{{#if:| |{{{7}}} }}{{#if:| |{{{8}}} }}{{#if:| |{{{9}}} }}{{#if:| |{{{10}}} }}{{#if:| |{{{11}}} }}{{#if:| |... }}}} and {{{{#if:|subst:}}Tlxm{{#if:| |{{{2}}} }}{{#if:| |{{{3}}} }}{{#if:| |{{{4}}} }}{{#if:| |{{{5}}} }}{{#if:| |{{{6}}} }}{{#if:| |{{{7}}} }}{{#if:| |{{{8}}} }}{{#if:| |{{{9}}} }}{{#if:| |{{{10}}} }}{{#if:| |{{{11}}} }}{{#if:| |... }}}} 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

---

Documentation

{{Tlx/doc}} is a generalization of {{{{#if:|subst:}}Tl{{#if:x| |x }}{{#if:| | }}{{#if:| | }}{{#if:| | }}{{#if:| | }}{{#if:| | }}{{#if:| | }}{{#if:| | }}{{#if:| |{{{10}}} }}{{#if:| |{{{11}}} }}{{#if:| |... }}}}, {{{{#if:|subst:}}Tlp{{#if:x| |x }}{{#if:y| |y }}{{#if:| | }}{{#if:| | }}{{#if:| | }}{{#if:| | }}{{#if:| | }}{{#if:| | }}{{#if:| |{{{10}}} }}{{#if:| |{{{11}}} }}{{#if:| |... }}}}, 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

{{Tlx/doc|template name}}

{{Tlx/doc|template name|param}}

{{Tlx/doc|template name|1|2|3}}

{{Tlx/doc|template name|1|2|3&#124;more}}

{{Tlx/doc|template name|param&#61;value}}

Up to three placeholders for parameters of the specified template

Examples

{{#ifeq:DARwiki|Wikipedia|| {{#ifeq:DARwiki|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.

}}}}

See also

Template:Para – for giving examples of template parameters and values only, instead of entire templates with parameters.