Template:Template link/doc

This template is used to show example template usage without expanding the template itself.

Basic use

(Note: In the following examples, ellipses (groups of three dots) indicate where parameters have been omitted.)

{{tlxTemplate:\sandbox|tlx|Template|first parameter|second parameter|third parameter|...|tenth parameter}} produces: {{tlxTemplate:\sandbox|Template|first parameter|second parameter|third parameter|...|tenth parameter}}

When you want to indicate setting a value to one or more parameters, you would normally use the equals-sign ("="). This doesn't work here; instead use {{}}, like so:

{{tlxTemplate:\sandbox|tlx|Template|first{{=}}first value|second|third{{=}}third value}} produces: {{tlxTemplate:\sandbox|Template|firstfirst value|second|thirdthird value}}

For more than ten parameters – with or without equals-signs – instead wrap the entire list of parameters and their values in <nowiki>...</nowiki> tags. When you do, you don't need to replace equals-signs. For instance:

{{tlxTemplate:\sandbox|tlx|Template|<nowiki>''first''|''second''|''third=value''|...|''999th''</nowiki>}} produces: {{tlxTemplate:\sandbox|Template|first|second|third=value|...|999th}}

Purpose and naming

Mnemonically, template link expanded (after template link).

This template allows an example of calling a template, accompanied by one or more parameters, to be displayed without also causing the template to be called.

Up to 20 of the template's parameters (numbered or nowiki-keywords) may be displayed as placeholders, while more than over 20 parameters can be displayed using a coded vertical bar (pipe) symbol, as in |. A keyword parameter can be used with equals code &#61; or {{=}} or in nowiki-text: " <nowiki>size=10</nowiki>" or all parameters as a string in " <nowiki>" tags; see Examples at bottom. For more details, see this talk page. If you use 21 or more parameters, all after the 20th will be replaced with a single |... at the end of the parameter list.

Exceptions

If the intended template lists numerous parameters, then perhaps this template should really not be used, and just hardcode the usage with <code> <nowiki>. For example:

<code><nowiki>{{Anytemplate|arg1=23|size=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>.

Parameters

• If the only parameter supplied is Template:Param, i.e. a template's name, {{tlx}}'s output is the same as {{tl}} – i.e. a link within braces – but in a monospaced font:
  • Template:Tc produces: {{tl}}
  • Template:Tc produces: {{tlxTemplate:\sandbox|tl}}

{{tl}} will also not take nor display additional parameters.

Named parameters

|subst=

Setting this parameter to any non-blank value will prefix the string subst: linked to Help:Substitution. This is useful to indicate when a template should be substituted. For example, {{tlxTemplate:\sandbox|tlx|Welcome|3=subst=Y}} produces: {{tlxTemplate:\sandbox|Welcome|subst=Y}}. This is similar to the action of the {{tlxTemplate:\sandbox|tlxs}} template: {{tlxTemplate:\sandbox|tlxs|Welcome}} produces: Template:Tlxs.

|SISTER=

For an interwiki link to other sister projects, such as: |SISTER=M: (Meta), |SISTER=Q: (WikiQuote), |SISTER=S: (WikiSource), etc, facilitating interwiki template documentation and/or discussion.

|LANG=

For a link to Wikipedias in other languages, such as: |LANG=de: (German), |LANG=sv: (Swedish), etc, facilitating cross-language template documentation and/or discussion.

Documentation

{{Tlx}} is a generalization of {{tl}}, {{tlp}} etc., with output that is arguably more legible. This depends on the browser, but narrow gaps between characters such as "Template:Thin space{Template:Thin space", "Template:Thin space|Template:Thin space", "Template:Thin space}Template:Thin space" and links can be hard to read when not monospaced (and hard to click on; for uses like {{!}}, see {{tlw}}, which makes the click target bigger).

Usage

{{tlx|Templatename}}

{{tlx|Templatename|param}}

{{tlx|Templatename|1|2|3|4|5|6|7|8|9|10}}

{{tlx|Templatename|1|2|3|4|5|6|7|8|9|10|more}}

{{tlx|Templatename|param=value}}

There are up to 10 placeholders for parameters of the specified template.

Examples

Note

At the en.wikipedia and Meta sites, 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.

Code	Result	Remarks
{{tlx|x0}}	{{tlxTemplate:\sandbox|x0}}
{{tlx|Abc}}	{{tlxTemplate:\sandbox|Abc}}
{{tlx|ABC}}	{{tlxTemplate:\sandbox|ABC}}
{{tlx|AbC}}	{{tlxTemplate:\sandbox|AbC}}
{{tlx|x1|one}}	{{tlxTemplate:\sandbox|x1|one}}
{{tlx|x2|one|two}}	{{tlxTemplate:\sandbox|x2|one|two}}
{{tlx|x3|1|2|3|4|5|6|7|8|9|10}}	{{tlxTemplate:\sandbox|x3|1|2|3|4|5|6|7|8|9|10}}
{{tlx|x4|1|2|3|4|5|6|7|8|9|10|11}}	{{tlxTemplate:\sandbox|x4|1|2|3|4|5|6|7|8|9|10|11}}	up to 10 parameters...
{{tlx|x5|1|2|3|4|5|6|7|8|9|10|11}}	{{tlxTemplate:\sandbox|x5|1|2|3|4|5|6|7|8|9|10|11}}	...| for more
{{tlx|x1|x=u}}	{{tlxTemplate:\sandbox|x1|x=u}}	the straightforward equals-sign won't work...
{{tlx|x1|x=u}}	{{tlxTemplate:\sandbox|x1|x=u}}	...but = is okay
{{tlx|x1|x{{=}}u}}	{{tlxTemplate:\sandbox|x1|xu}}	...and {{=}} is okay
{{tlx|x1|<nowiki>x=u</nowiki>}}	{{tlxTemplate:\sandbox|x1|x=u}}	sticky nowiki also okay
{{tlx|x2| |two}}	{{tlxTemplate:\sandbox|x2| |two}}	empty won't work...
{{tlx|x2|&#32;|two}}	{{tlxTemplate:\sandbox|x2| |two}}	...but &#32; is okay
{{tlx|x2|&nbsp;|two}}	{{tlxTemplate:\sandbox|x2| |two}}	...&nbsp; is also okay
{{tlx|x2| <nowiki />|two}}	{{tlxTemplate:\sandbox|x2||two}}	<nowiki /> handles the space
{{tlx|x2| &#124; two}}	{{tlxTemplate:\sandbox|x2| | two}}	&#124; is okay
{{tlx|x2| {{!}} two}}	{{tlxTemplate:\sandbox|x2 | | two}}	{{!}} is dubious
{{tlx|x2|2=|3=two}}	{{tlxTemplate:\sandbox|x2|2=|3=two}}	empty really doesn't work
{{tlx|x2|2=one|two}}	{{tlxTemplate:\sandbox|x2|two}}	"two" overrides "2one"
{{tlx|x2|3=two|2=one}}	{{tlxTemplate:\sandbox|x2|3=two|2=one}}	irregular parameter order is okay

Unlimited parameters as one

<nowiki>...</nowiki> string

{{tlxTemplate:\sandbox|tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}

TemplateData

TemplateData documentation used by VisualEditor and other tools

Click here to see a monthly parameter usage report for this template based on this TemplateData. TemplateData for Template link Show example template usage without expanding the template itself. {{tnull}} is similar without linking the template. Template parameters This template prefers inline formatting of parameters. Parameter Description Type Status Template name 1 Name of the template to link. Example Tlx Template required 1st parameter 2 no description String optional 2nd parameter 3 no description String optional 3rd parameter 4 no description String optional 4th parameter 5 no description String optional 5th parameter 6 no description String optional 6th parameter 7 no description String optional 7th parameter 8 no description String optional 8th parameter 9 no description String optional 9th parameter 10 no description String optional 10th parameter 11 no description String optional 11th parameter 12 no description String optional 12th parameter 13 no description String optional 13th parameter 14 no description String optional 14th parameter 15 no description String optional 15th parameter 16 no description String optional 16th parameter 17 no description String optional 17th parameter 18 no description String optional 18th parameter 19 no description String optional 19th parameter 20 no description String optional 20th parameter 21 no description String optional Show subst: subst Set to any value to show "subst:" before the template name Example true Boolean optional Language LANG The prefix for a link to Wikipedias in other languages. Example de: Line optional Sister project SISTER The prefix for an interwiki link to other sister projects Example M: Line optional

See also

• {{tlxb}}, a version of {{tlx}} where the template name is shown in bold.
• {{tlb}}, a version of {{tl}} where the template name is shown in bold.
• {{temt}}, a version of {{tlx}} that handles templates whose names include "Template:" and pages outside the Template: namespace that are treated as templates.
• {{para}}, for the presentation of template parameters and values (e.g. |paraname=val, |another=).
• {{tnull}}, like Template:Tnull without linking the template.