Template:Tlx/doc

This  template documentation is transcluded for all Tlx family templates (Tlx, Tlxc, Tlxm, 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 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 " &amp;#124; ..."). A keyword parameter can be used with equals code &amp;#61; or = or in nowiki-text: "&lt;nowiki>size=10&lt;/nowiki>" or all parameters as a string in " " tags; see Examples at bottom. For more details, see |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, for example:  .  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.


 * If given no additional parameters except   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.


 * display compared to : (Tl: Tl versus Tlx: )


 * Comparatively, 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.


 * 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:Substituting templates. This is useful to indicate when a template should be substituted. For example will display.


 * 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
{&#123;Template:&#125;} is a generalization of x, x, 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

 * {&#123;|template name&#125;}
 * {&#123;|template name|param&#125;}
 * {&#123;|template name|1|2|3|4|5|6|7|8|9|10&#125;}
 * {&#123;|template name|1|2|3|4|5|6|7|8|9|10&amp;#124;more&#125;}
 * {&#123;|template name|param&amp;#61;value&#125;}

Up to 10 placeholders for parameters of the specified template