Template:Tlx/doc

{{tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}} → {{template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}}

Purpose and naming

Mnemonically 'Template link expanded'... after {{tl}} 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 five pass parameters (numbered or nowiki-keywords) for the specified template are displayed as 'placeholders', and over 5 parameters can be displayed using a coded vertical-bar (as in "&#124;..."). A keyword parameter can be used, when tagged as a nowiki-keyword: "<nowiki>siz=10<\nowiki>" with each keyword parameter surrounded by "<nowiki>" tags; see Examples at bottom. For more details, see the 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><nowiki></code>, for example: <code><nowiki><code><nowiki>{{Anytemplate|arg1=23|siz=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>.

---

• If given no additional parameters except  'template name' ({{{1}}}),  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.

• {{Tl|Tl}} display compared to {{Tlx|Tl}}: (Tl: {{Tlx}} versus Tlx: {{Tl}})

• Comparatively, {{Tl}} will not take or display additional parameters, and for minor technical reasons, may preferred for mere listing and referencing in long pages involving a lot of template expansions.

• Additionally, Tlx will take a 'named' parameter 'SISTER' to link interwiki to other sister projects such as one of these examples: '|SISTER=', 'Tlx|SISTER=M:', 'Tlx|SISTER=Q:', 'Tlx|SISTER=S:', allowing documentation or discourse about a template across interwiki boundaries. Small 'front end' Shell or convience templates {{Tlxw}} and {{Tlxm}} are typing-aid templates available at Meta for automatic substitution in discussions about templates on Wikipedia or Meta.

---

This usage also applies to interwiki capable template variations

1. {{Tlxc}} -- which links to templates on Wikimedia Commons (The Commons).
2. {{Tlxm}} -- which links to templates on Meta
3. {{Tlxw}} -- which links to templates on Wikipedia

---

Documentation

{{Tlx/doc}} is a generalization of {{Tl|x}}, {{Tlp|x|y}}, 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

{{Tlx/doc|template name}}

{{Tlx/doc|template name|param}}

{{Tlx/doc|template name|1|2|3}}

{{Tlx/doc|template name|1|2|3&#124;more}}

{{Tlx/doc|template name|param&#61;value}}

Up to three placeholders for parameters of the specified template

See also

Template:Para – for giving examples of template parameters and values only, instead of entire templates with parameters.