Template:Tlx/doc

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

Basically:

Where parameters might contain "=" characters, use instead

For more than 10 parameters, possibly also containing "=", use

The three dots in the examples represent a number of arguments that have been omitted and are not an actual argument.

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: "size=10" 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 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 .

Parameters

 * 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 noticeably 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 non-blank value will place the string " " before the template name, linked to Help:Substitution. This is useful to indicate when a template should be substituted. For example will display . This is similar to the action of the  template:  will display.
 * Additionally, Tlx will take a named parameter SISTER to link interwiki to other sister projects such as one of these examples: M: (Meta), Q: (WikiQuote), S: (WikiSource), etc. allowing documentation or discourse about a template across interwiki boundaries.
 * Tlx will also take a named parameter LANG to link to other language Wikipedias, such as one of these examples: de: (German), sv: (Swedish), etc. allowing documentation or discourse about a template across language 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;}</tt>
 * {&#123;|template name|param&amp;#61;value&#125;}</tt>

Up to 10 placeholders for parameters of the specified template