Template:Tlx/doc

This template is used to show example template usage without expanding the template itself.

Basic use
(Note: In the following examples, ellipses (groups of three dots) indicate where parameters have been omitted.)


 * produces:

Where parameters might contain one or more equals-signs ("="), replace each equals-sign with :
 * produces:

For more than ten parameters, possibly also containing equals-signs, use  thus:
 * produces:

Purpose and naming
Mnemonically, "[t]emplate [l]ink e[x]panded" (after tl, "[t]emplate [l]ink").

This template allows an example of calling a template, accompanied by one or more parameters, to be displayed without also causing the template to be called.

Up to ten of the template's parameters (numbered or nowiki-keywords) may be displayed as placeholders, while more than over 10 parameters can be displayed using a coded vertical-bar (as in "&amp;#124;..."). A keyword parameter can be used with equals code &amp;#61; or = or in nowiki-text: "size=10" or all parameters as a string in "" tags; see Examples at bottom. For more details, see |this talk page.

If the intended template lists numerous parameters, then perhaps this template should really not be used, and just hardcode the usage with. For example:
 * Exceptions
 * .

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 .

Parameters

 * If the only parameter supplied is, i.e. a template's name, 's output is the same as tl – i.e. a link within braces – but in a monospaced font:
 * produces: tl
 * produces:
 * will also not take nor display additional parameters.

subst
 * Named parameters
 * Setting this parameter to any non-blank value will prefix the string  linked to Help:Substitution. This is useful to indicate when a template should be substituted. For example,  produces: . This is similar to the action of the  template:  produces:.

SISTER
 * For an interwiki link to other sister projects, such as: M: (Meta), Q: (WikiQuote), S: (WikiSource), etc, facilitating interwiki template documentation and/or discussion.

LANG
 * For a link to Wikipedias in other languages, such as: de: (German), sv: (Swedish), etc, facilitating cross-language template documentation and/or discussion.

Documentation
Tlx is a generalization of x, x etc., with output that is arguably more legible. This depends on the browser, but narrow gaps between characters such as "{", "&#124;", "}" and links can be hard to read when not monospaced (and hard to click on; for uses like, see tlw, which makes the click target bigger).

Usage


There are up to 10 placeholders for parameters of the specified template.

Examples

 * Unlimited parameters as one  string

Template-linking templates
{	"params": { "1": {			"label": "Template name", "description": "Name of the template to link", "example": "Tlx", "type": "wiki-template-name", "required": true },		"2": {			"label": "1st parameter", "type": "string" },		"3": {			"label": "2nd parameter", "type": "string" },		"4": {			"label": "3rd parameter", "type": "string" },		"5": {			"label": "4th parameter", "type": "string" },		"6": {			"label": "5th parameter", "type": "string" },		"7": {			"label": "6th parameter", "type": "string" },		"8": {			"label": "7th parameter", "type": "string" },		"9": {			"label": "8th parameter", "type": "string" },		"10": {			"label": "9th parameter", "type": "string" },		"11": {			"label": "10th parameter", "type": "string" },		"12": {},		"subst": { "description": "Set to any value to show \"subst:\" before the template name", "example": "true", "type": "boolean" },		"LANG": { "label": "Language", "description": "For a link to Wikipedias in other languages", "example": "de:", "type": "string" },		"SISTER": { "description": "For an interwiki link to other sister projects", "example": "M:", "type": "string" }	},	"description": "Show example template usage without expanding the template itself.", "paramOrder": [ "1",		"2",		"3",		"4",		"5",		"6",		"7",		"8",		"9",		"10",		"11",		"12",		"subst", "LANG", "SISTER" ],	"format": "inline" }