Template:Tlx/doc

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

This template is used on 10,000+ pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:Template

{{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}}`	`{{w:tlx}}`	Interwiki template example
`{{tlx\|subst:tlx}}`	`{{subst:tlx}}`	Template substitution example
`{{tlx\|tlx\|two}}`	`{{tlx\|two}}`	Empty parameter example
`{{tlx\|tlx}}`	`{{tlx}}`	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}}`	`{{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}}`	`{{w:tlx}}`	Interwiki template example
`{{tlx\|subst:tlx}}`	`{{subst:tlx}}`	Template substitution example
`{{tlx\|tlx\|two}}`	`{{tlx\|two}}`	Empty parameter example
`{{tlx\|tlx}}`	`{{tlx}}`	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}}`	`{{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