Templat:Tlx/doc

This is a documentation subpage for Templat:Tlx. It contains usage information, categories, interlanguage links and other content that is not part of the original templat page.

{{Tlx|Template|first parameter|second|third|...|tenth → {{Template|first parameter|second|third|...|tenth

{{Tlx|first parameter|...|third → {{Template|first parameter|second|third|...|tenth if they might contain "=" signs.

{{Tlx|Template|<nowiki>first|second|...|999th</nowiki> → {{Template|first|second|...|999th (for more than 10 parameters)

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 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 "&#124;..."). A keyword parameter can be used with equals code &#61; or {{=}} or in nowiki-text: "<nowiki>size=10</nowiki>" or all parameters as a string in "<nowiki>" 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 <code><nowiki>, for example: <code><nowiki>{{Anytemplate|arg1=23|size=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: {{Tl}} versus Tlx: {{Tl)

• Comparatively, {{Tl 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.

• {{Tlx 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:Substitution. This is useful to indicate when a template should be substituted. For example {{Tlx|Welcome|subst=Y will display {{subst:Welcome.

• 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

{{Tlx}} is a generalization of {{Tl}}, {{Tlp}}, 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|template name}}

{{Tlx|template name|param}}

{{Tlx|template name|1|2|3|4|5|6|7|8|9|10}}

{{Tlx|template name|1|2|3|4|5|6|7|8|9|10&#124;more}}

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

Up to 10 placeholders for parameters of the specified template

Examples

Code	Result	Remark
{{Tlx|x0	{{x0
{{Tlx|Abc	{{Abc
{{Tlx|ABC	{{ABC
{{Tlx|AbC	{{AbC
{{Tlx|x1|one	{{x1|one
{{Tlx|x2|one|two	{{x2|one|two
{{Tlx|x3|1|2|3|4|5|6|7	{{x3|1|2|3|4|5|6|7|8
{{Tlx|x4|1|2|3|4|5|6|7	{{x4|1|2|3|4|5|6|7|8	up to 10 parameters, then ...
{{Tlx|x5|1|2|3|4|5|6|7	{{x5|1|2|3|4|5|6|7|8	| for more
{{Tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>		unlimited parameters as one nowiki string
{{Tlx|x1|x=u	{{x1	= won't work
{{Tlx|x1|x&#61;u	{{x1|x=u	&#61; is okay
{{Tlx|x1|x{{=}}u	{{x1|x=u	{{=}} is okay
{{Tlx|x1|<nowiki>x=u</nowiki>	{{x1|x=u	sticky nowiki is okay
{{Tlx|x2| |two	{{x2|two	empty won't work
{{Tlx|x2|&#32;|two	{{x2| |two	&#32; is okay
{{Tlx|x2|&nbsp;|two	{{x2| |two	&nbsp; is okay
{{Tlx|x2| &#124; two	{{x2| | two	&#124; is okay
{{Tlx|x2| {{!}} two	{{x2| | two	{{! is dubious
{{Tlx|x2|2=|3=two	{{x2|two	empty really doesn't work
{{Tlx|x2|2=one|two	{{x2|two	two clobbers 2=one
{{Tlx|x2|3=two|2=one	{{x2|one|two	right to left okay

See also

• Template:Tlxb – same as {{Tlx}}, but gives the template name in boldface type (this can be useful when stressing the difference between two similarly named templates). Template:Tlb is the same, except it uses regular text instead of a monospaced non-proportional font.
• Template:Temt, – same as {{Tlx}}, but handles template names with the Template: prefix and templates not in the Template: namespace {{ns:10}}.
• Template:Para – for giving examples of template parameters and values only, instead of entire templates with parameters.

	Link Style	Linked	Unlinked	Linked with subst	Linked including braces	Linked with alternative text
Text Style	{{tlg option	--	nolink=yes	subst=yes	braceinside=yes	alttext=FOO
Normal	--	{{tl, {{tlp; {{tlg	{{tlf	{{tls, {{tlsp	{{tn	{{tla
Teletype	tt=yes	{{tlx	{{tld, {{tnull	{{tlxs
Bold	bold=yes	{{tlb
Bold Teletype	bold=yes|tt=yes	{{tlxb
Italic Teletype	italic=yes|tt=yes	{{tlxi
Code	code=yes		{{tlc

NOTE: {{tlg is the most general, allowing any combination of the above options.

Style comparison:

• {{tlf|Milford Haven Line|弘安源氏論議}} produces: {{Milford Haven Line|弘安源氏論議}}
• {{tld|Milford Haven Line|弘安源氏論議}} produces: Templat:Tld
• {{tlc|Milford Haven Line|弘安源氏論議}} produces: {{Milford Haven Line|弘安源氏論議}}

For parameter description,

• Templat:Tlp renders: |name=value