# வார்ப்புரு:Tlx/doc

<includeonly>  
<small>*This * template documentation is transcluded for all *Tlx family templates (Tlx, Tlxc, Tlxm, Tlxw, Tlxb)* [<span>[ edit]</span>].</small></includeonly><noinclude>  

</noinclude>  

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

## Purpose and naming
Mnemonically **'T**emplate **l**ink e**x**panded'. After <tt></tt> **'T**emplate **l**ink'.  

- This template takes another *template-name* and some associated (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 "<small>&amp;#124;</small>*...*"). 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 <code></code>, for example: <code><var>other parameters...</var></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 <code></code>.

---

- If given no additional parameters except *<code>&nbsp;'template&nbsp;name'&nbsp;, </code>*&nbsp;it presents the same as the similar 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: 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 . 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 , ,  
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

:<tt>{&#123;template name&#125;}</tt>  
:<tt>{&#123;template nameparam&#125;}</tt>  
:<tt>{&#123;template name12345678910&#125;}</tt>  
:<tt>{&#123;template name12345678910&amp;#124;more&#125;}</tt>  
:<tt>{&#123;template nameparam&amp;#61;value&#125;}</tt>  
*Up to 10 placeholders for parameters of the specified template*  

### Examples

****two** clobbers **2=one****

| to okay | } |
| --- | --- |