మూస:Tlx/doc

This is a documentation subpage for మూస:Tlx (see that page for the మూస itself).
It contains usage information, categories, and other content that are not part of the original మూస page.

This template is used on 9,000+ pages.
To avoid large-scale disruption and unnecessary server load, any changes should first be tested in the template sandbox or a user subpage. The tested changes can then be added in one single edit to this template. Please consider discussing any changes on the talk page before implementing them.

{{tlx|template|first parameter|second|third|fourth|etc}} becomes →
{{template|first parameter|second|third|fourth|etc}}

Purpose and naming: Mnemonically 'Template list expanded'... named after {{tl}} 'Template list'

Usage

{{Tlx/doc|template name}}

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

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

This template takes a template-name and an optional number of associated parameters (or 'pass parameters'), and aggregates them into an 'example demonstration' of how the template might be used. It's primary use is in instruction and documentation such as this passage.
Additionally, tlx can be used to demonstrate templates on other sister projects.

Examples

Markup	Displays	Remarks
{{tlx\|`tlx`}}	{{tlx}}
{{tlx\|`w:tlx`}}	{{tlx}}	Interwiki template example
{{tlx\|`subst:tlx`}}	{{subst:tlx}}	Template substitution example
{{tlx\|`tlx`\| \|`two`}}	{{tlx\| \|`two`}}	Empty parameter example
{{tlx\|`tlx`\|`example=true`}}	{{tlx\|`example=true`}}	Named parameter example
{{tlx\|`tlx`\|`2=1`}}	{{tlx\|`1`}}	Parameter shown without number parameter name
{{tlx\|`tlx`\|`2=1`}}	{{tlx\|`2=1`}}	Use `=` to display number parameter names
{{tlx\|`tlx`\|`2{{=}}1`}}	{{tlx\|`2=1`}}	`{{=}}` also works
{{tlx\|`tlx`\|`2<nowiki>=</nowiki>1`}}	{{tlx\|`2=1`}}	sticky nowiki also works
{{tlx\|`tlx`\|`2=one`\|`two`}}	{{tlx\|`two`}}	two clobbers 2=one
{{tlx\|`tlx`\|`3=two`\|`2=one`}}	{{tlx\|`one`\|`two`}}	right to left okay

Markup	Displays	Remarks
{{tlx\|`tlx`}}	{{tlx}}
{{tlx\|`w:tlx`}}	{{tlx}}	Interwiki template example
{{tlx\|`subst:tlx`}}	{{subst:tlx}}	Template substitution example
{{tlx\|`tlx`\| \|`two`}}	{{tlx\| \|`two`}}	Empty parameter example
{{tlx\|`tlx`\|`example=true`}}	{{tlx\|`example=true`}}	Named parameter example
{{tlx\|`tlx`\|`2=1`}}	{{tlx\|`1`}}	Parameter shown without number parameter name
{{tlx\|`tlx`\|`2=1`}}	{{tlx\|`2=1`}}	Use `=` to display number parameter names
{{tlx\|`tlx`\|`2{{=}}1`}}	{{tlx\|`2=1`}}	`{{=}}` also works
{{tlx\|`tlx`\|`2<nowiki>=</nowiki>1`}}	{{tlx\|`2=1`}}	sticky nowiki also works
{{tlx\|`tlx`\|`2=one`\|`two`}}	{{tlx\|`two`}}	two clobbers 2=one
{{tlx\|`tlx`\|`3=two`\|`2=one`}}	{{tlx\|`one`\|`two`}}	right to left okay