Template:Tlx/doc

- - -

There is a documentation subpage housing the metadata about parent template: Tlx.

This template creates example usage syntax for a template, and links the name to the template page. The name is derived from "Template list expanded".

Up to 7 pass parameters (numbered) for the specified template are displayed as 'placeholders', and more parameters are shown as "|...". An optional SISTER parameter can specify an interwiki prefix to link to another wiki.

Examples

Code	Result	Remark
{{tlx|x0}}	{{x0}}
{{tlx|x1|one}}	{{x1|one}}
{{tlx|x2|one|two}}	{{x2|one|two}}
{{tlx|x3|1|2|3}}	{{x3|1|2|3}}
{{tlx|x4|1|2|3|4}}	{{x4|1|2|3|4}}	up to 7 parameters, then ...
{{tlx|x4|1|2|3&#124;4}}	{{x4|1|2|3|4}}	<syntaxhighlight inline lang="html">|</syntaxhighlight> for more
{{tlx|x1|x=u}}	{{x1}}	= won't work
{{tlx|x1|x&#61;u}}	{{x1|x=u}}	<syntaxhighlight inline lang="html">=</syntaxhighlight> is okay
{{tlx|x1|<nowiki>x=u</nowiki>}}	{{x1|x=u}}	sticky nowiki is okay
{{tlx|x1|2=x=u}}	{{x1|x=u}}	numbered parameter is okay
{{tlx|x2| |two}}	{{x2|two}}	empty won't work
{{tlx|x2|&#32;|two}}	{{x2| |two}}	<syntaxhighlight inline lang="html"> </syntaxhighlight> is okay
{{tlx|x2|&nbsp;|two}}	{{x2| |two}}	<syntaxhighlight inline lang="html"> </syntaxhighlight> is okay
{{tlx|x2| &#124; two}}	{{x2| | two}}	<syntaxhighlight inline lang="html">|</syntaxhighlight> is okay
{{tlx|x2| Template:Magic word two}}	{{x2| | two}}	Template:Magic word is dubious
{{tlx|x2|2=|3=two}}	{{x2|two}}	empty really doesn't work
{{tlx|x2|3=two|2=one}}	{{x2|one|two}}	right to left okay

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools.

TemplateData for Tlx

Template list expanded

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Template	1	Linked template name	Template	required
Parameter 1	2	First parameter value	String	optional
Parameter 2	3	Second parameter value	String	optional
Parameter 3	4	Third parameter value	String	optional
Parameter 4	5	Fourth parameter value	String	optional
Parameter 5	6	Fifth parameter value	String	optional
Parameter 6	7	Sixth parameter value	String	optional
Overflow	8	Overflow shown as ...	String	optional
Nowrap?	nowrap	Whether to add “<span style="white-space: nowrap">” Default 0 Auto value 1	Boolean	optional
Interwiki	SISTER	Optional InterWiki link prefix	String	optional