Template:Tlx/doc

This  template documentation is transcluded for all Tlx family templates (Tlx, Tlxc, Tlxw, Tlxb)'' [ [ edit] ].


 * → if they might contain "=" signs.
 * → (for more than 10 parameters)
 * → (for more than 10 parameters)

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 ten of the template's parameters (numbered or nowiki-keywords) may be displayed as placeholders, while more than over 10 parameters can be displayed using a coded vertical-bar (as in " &amp;#124; …"). A keyword parameter can be used with equals code &amp;#61; or  or in nowiki-text:  "  or all parameters as a string in " " tags; see Examples at bottom. For more details, see this talk page.

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

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.

Parameters

 * If the only parameter supplied is 1, i.e. a template's name, 's output is the same as   -- i.e. a link within braces but in a monospaced font:
 * produces: tl
 * produces:
 * will also not take nor display additional parameters.

subst
 * Named parameters
 * Setting this parameter to any non-blank value will prefix the string subst: linked to w:Help:Substitution. This is useful to indicate when a template should be substituted. For example, produces: . This is similar to the action of the  template:  produces:.

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

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

Documentation
{&#123;Template:&#125;} is a generalization of x, x etc, with output that is arguably more legible. This depends on the browser, but narrow gaps between characters such as "{", "&#124;", "}" and links can be hard to read when not monospaced (and hard to click on; for uses like, see , which makes the click target bigger).

Usage


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

Examples

 * Unlimited parameters as one  string