Template:Tlx/doc

{{#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 = 40px | imageright = | class = | style = | textstyle = | text = This is a documentation subpage for Template:Tlx.
It contains usage information, categories, interlanguage links and other content that is not part of the original {{ #if: | {{{text2}}} | {{ #if: | {{{text1}}} | {{ #ifeq: Template | User | template template page | {{ #if: Template |template page|article}}}}}}}}. | small = | smallimage = | smallimageright = | smalltext = | subst = | date = }}

   }}{{
   #if: 
   | 
   | {{#ifexist:Template:Tlx|[[Category:{{
     #switch: Template
     | Template  = Template
     | User      = User
     | #default  = Wikipedia
   }} documentation pages]]|}}
 }}

| }}

{{{{#if:|subst:}}Tlx{{#if:Template|

|Template }}{{#if:first parameter| |first parameter }}{{#if:second| |second }}{{#if:third| |third }}{{#if:...| |... }}{{#if:tenth| |tenth }}{{#if:| |{{{8}}} }}{{#if:| |{{{9}}} }}{{#if:| |{{{10}}} }}{{#if:| |{{{11}}} }}{{#if:| |... }}}} → {{{{#if:|subst:}}Template{{#if:first parameter| |first parameter }}{{#if:second| |second }}{{#if:third| |third }}{{#if:...| |... }}{{#if:tenth| |tenth }}{{#if:| |{{{7}}} }}{{#if:| |{{{8}}} }}{{#if:| |{{{9}}} }}{{#if:| |{{{10}}} }}{{#if:| |{{{11}}} }}{{#if:| |... }}}}

{{{{#if:|subst:}}Tlx{{#if:Template|

|Template }}{{#if:2=first parameter| |2=first parameter }}{{#if:3=second| |3=second }}{{#if:4=third| |4=third }}{{#if:5=...| |5=... }}{{#if:11=tenth| |11=tenth }}{{#if:| |{{{8}}} }}{{#if:| |{{{9}}} }}{{#if:| |{{{10}}} }}{{#if:| |{{{11}}} }}{{#if:| |... }}}} → {{{{#if:|subst:}}Template{{#if:first parameter| |first parameter }}{{#if:second| |second }}{{#if:third| |third }}{{#if:...| |... }}{{#if:| |{{{6}}} }}{{#if:| |{{{7}}} }}{{#if:| |{{{8}}} }}{{#if:| |{{{9}}} }}{{#if:| |{{{10}}} }}{{#if:tenth| |tenth }}{{#if:| |... }}}} if they might contain "=" signs.

{{{{#if:|subst:}}Tlx{{#if:Template|

|Template }}{{#if:<nowiki>first| |<nowiki>first }}{{#if:second| |second }}{{#if:...| |... }}{{#if:999th</nowiki>| |999th</nowiki> }}{{#if:| |{{{7}}} }}{{#if:| |{{{8}}} }}{{#if:| |{{{9}}} }}{{#if:| |{{{10}}} }}{{#if:| |{{{11}}} }}{{#if:| |... }}}} → {{{{#if:|subst:}}Template{{#if:first|second|...|999th| |first|second|...|999th }}{{#if:| |{{{3}}} }}{{#if:| |{{{4}}} }}{{#if:| |{{{5}}} }}{{#if:| |{{{6}}} }}{{#if:| |{{{7}}} }}{{#if:| |{{{8}}} }}{{#if:| |{{{9}}} }}{{#if:| |{{{10}}} }}{{#if:| |{{{11}}} }}{{#if:| |... }}}} (for more than 10 parameters)

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 10 pass parameters (numbered or nowiki-keywords) for the specified template are displayed as 'placeholders', and over 10 parameters can be displayed using a coded vertical-bar (as in "&#124;..."). A keyword parameter can be used with equals code &#61; or {{=}} or in nowiki-text: "{{#switch:pair

|c|close  = 
|s|single
|o|open
|p|pair   = <nowiki{{#if:| {{{params}}}}}

}}{{#switch:pair

|c|close  = size=10
|s|single =  />
|o|open   = >size=10
|p|pair   = >size=10

}}{{#switch:pair

|s|single
|o|open   = 
|c|close
|p|pair   = </nowiki>

}}" or all parameters as a string in "{{#switch:o

|c|close  = 
|s|single
|o|open
|p|pair   = <nowiki{{#if:| {{{params}}}}}

}}{{#switch:o

|c|close  = 
|s|single =  />
|o|open   = >
|p|pair   = >...

}}{{#switch:o

|s|single
|o|open   = 
|c|close
|p|pair   = </nowiki>

}}" tags; see Examples at bottom. For more details, see this talk page.

• Exceptions: If the intended template lists numerous parameters, then perhaps this template should really not be used, and just hardcode the usage with {{#switch:o

|c|close  = 
|s|single
|o|open
|p|pair   = <code{{#if:| {{{params}}}}}

}}{{#switch:o

|c|close  = 
|s|single =  />
|o|open   = >
|p|pair   = >...

}}{{#switch:o

|s|single
|o|open   = 
|c|close
|p|pair   = </code>

}}{{#switch:o

|c|close  = 
|s|single
|o|open
|p|pair   = <nowiki{{#if:| {{{params}}}}}

}}{{#switch:o

|c|close  = 
|s|single =  />
|o|open   = >
|p|pair   = >...

}}{{#switch:o

|s|single
|o|open   = 
|c|close
|p|pair   = </nowiki>

}}, for example: {{#switch:pair

|c|close  = 
|s|single
|o|open
|p|pair   = <code{{#if:| {{{params}}}}}

}}{{#switch:pair

|c|close  = {{#switch:pair
|c|close  = 
|s|single
|o|open
|p|pair   = <nowiki{{#if:| {{{params}}}}}

}}{{#switch:pair

|c|close  = {{Anytemplate|arg1=23|size=250px|other parameters...}}
|s|single =  />
|o|open   = >{{Anytemplate|arg1=23|size=250px|other parameters...}}
|p|pair   = >{{Anytemplate|arg1=23|size=250px|other parameters...}}

}}{{#switch:pair

|s|single
|o|open   = 
|c|close
|p|pair   = </nowiki>

}}

|s|single =  />
|o|open   = >{{#switch:pair
|c|close  = 
|s|single
|o|open
|p|pair   = <nowiki{{#if:| {{{params}}}}}

}}{{#switch:pair

|c|close  = {{Anytemplate|arg1=23|size=250px|other parameters...}}
|s|single =  />
|o|open   = >{{Anytemplate|arg1=23|size=250px|other parameters...}}
|p|pair   = >{{Anytemplate|arg1=23|size=250px|other parameters...}}

}}{{#switch:pair

|s|single
|o|open   = 
|c|close
|p|pair   = </nowiki>

}}

|p|pair   = >{{#switch:pair
|c|close  = 
|s|single
|o|open
|p|pair   = <nowiki{{#if:| {{{params}}}}}

}}{{#switch:pair

|c|close  = {{Anytemplate|arg1=23|size=250px|other parameters...}}
|s|single =  />
|o|open   = >{{Anytemplate|arg1=23|size=250px|other parameters...}}
|p|pair   = >{{Anytemplate|arg1=23|size=250px|other parameters...}}

}}{{#switch:pair

|s|single
|o|open   = 
|c|close
|p|pair   = </nowiki>

}} }}{{#switch:pair

|s|single
|o|open   = 
|c|close
|p|pair   = </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 {{#switch:pair

|c|close  = 
|s|single
|o|open
|p|pair   = <pre{{#if:| {{{params}}}}}

}}{{#switch:pair

|c|close  = 
|s|single =  />
|o|open   = >
|p|pair   = >...

}}{{#switch:pair

|s|single
|o|open   = 
|c|close
|p|pair   = </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: {{Tl}} 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 be preferred for mere listing and referencing in long pages involving a lot of template expansions.

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

|{{{2}}} }}{{#if:| |{{{3}}} }}{{#if:| |{{{4}}} }}{{#if:| |{{{5}}} }}{{#if:| |{{{6}}} }}{{#if:| |{{{7}}} }}{{#if:| |{{{8}}} }}{{#if:| |{{{9}}} }}{{#if:| |{{{10}}} }}{{#if:| |{{{11}}} }}{{#if:| |... }}}} 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 {{{{#if:|subst:}}Tlx{{#if:Welcome| |Welcome }}{{#if:subst=Y| |subst=Y }}{{#if:| |{{{4}}} }}{{#if:| |{{{5}}} }}{{#if:| |{{{6}}} }}{{#if:| |{{{7}}} }}{{#if:| |{{{8}}} }}{{#if:| |{{{9}}} }}{{#if:| |{{{10}}} }}{{#if:| |{{{11}}} }}{{#if:| |... }}}} will display {{{{#if:Y|subst:}}Welcome{{#if:| |{{{2}}} }}{{#if:| |{{{3}}} }}{{#if:| |{{{4}}} }}{{#if:| |{{{5}}} }}{{#if:| |{{{6}}} }}{{#if:| |{{{7}}} }}{{#if:| |{{{8}}} }}{{#if:| |{{{9}}} }}{{#if:| |{{{10}}} }}{{#if:| |{{{11}}} }}{{#if:| |... }}}}.

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

Documentation

{{Tlx}} is a generalization of {{Tl}}, {{Tlp}}, 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|template name}}

{{Tlx|template name|param}}

{{Tlx|template name|1|2|3|4|5|6|7|8|9|10}}

{{Tlx|template name|1|2|3|4|5|6|7|8|9|10&#124;more}}

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

Up to 10 placeholders for parameters of the specified template

Examples

{{#ifeq:Define Wiki|Wikipedia|| {{#ifeq:Define Wiki|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:Tlxb – same as {{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:Temt, – same as {{Tlx}}, but handles template names with the Template: prefix and templates not in the Template: namespace {{ns:10}}.
• Template:Para – for giving examples of template parameters and values only, instead of entire templates with parameters.

Template linking templates

NOTE: {{{{#if:|subst:}}tlg{{#if:|

|{{{2}}} }}{{#if:| |{{{3}}} }}{{#if:| |{{{4}}} }}{{#if:| |{{{5}}} }}{{#if:| |{{{6}}} }}{{#if:| |{{{7}}} }}{{#if:| |{{{8}}} }}{{#if:| |{{{9}}} }}{{#if:| |{{{10}}} }}{{#if:| |{{{11}}} }}{{#if:| |...

}}}} is the most general, allowing any combination of the above options.