Template:Template link expanded with subst/sandbox

{{subst:Template:Template link expanded with subst/sandbox}}

This is the template sandbox page for Template:Template link expanded with subst (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

Warning This template is used on approximately 4,900 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.

Shortcut

{{tlxs Template:Tlxs }}

This template uses Lua:

Module:Template link general (sandbox)

This template, often abbreviated as {{tlxs}}, is used to provide stylized formatting to template displays without actually using the template itself. The code generated will be displayed inline.

Parameters

[edit ]

With the exception of alttext, the named parameters are toggles that are either omitted (default in most cases) or activated (by being assigned a value such as "on", "yes", "true", "include", etc.). They may be included in any order (see Examples below). Certain templates have the parameter "on" by default; see the main table for all alternate options. If a row renders identically to a previous row, it means the current template does not support that option and {{tlg}} needs to be used instead.

Parameter	Action	Use with {{example }}	Default active
Default (without accessory parameters)	`{{subst:example}}`
brace	Include braces as part of the template link	`{{subst:example}}`	{{tlw }}/{{tn }}
braceinside	Include innermost braces as part of the template link	`{{subst:example}}`
bold	Renders the template link/name in bold	`{{subst:example }}`	{{tlb }}, {{tlxb }}
code	Display output using HTML `<code>...</code>` tags (monospaced font)	`{{subst:example}}`	{{tlc }}, {{Template link expanded }}, etc.
italic	Display any parameters accompanying the template link/name in italics	`{{subst:example\|param}}`	{{tlxi }}
kbd	Display output using HTML `<kbd>...</kbd>` tags (monospaced font)	`{{subst:example}}`
nolink	Don't render the template name as a link	`{{subst:example}}`	{{tlf }}, {{tnull }}
nowrap	Prevent the insertion of line breaks (word wrap) in the output	`{{subst:example}}`	{{tlf }}, {{tlp }}
nowrapname	Prevent word wrapping in the output of template name/link (parameters will wrap if needed)	`{{subst:example }}`
plaincode	Uses `<code style="border:none; background:transparent;">...</code>`	`{{subst:example}}`	{{tltss }}
subst	Include a subst: prefix before the template link/name	`{{subst:example}}`	{{tls }}, {{tlxs }}, etc
alttext=`[text]`	Replace `[text]` with the actual label to be displayed for the template link	`{{subst:Other}}`	{{tla }}
_show_result	Will also display the result of the template	`{{subst:Min\|7\|-5}}` → -5
_expand	Will add a link to the expanded template page	`{{subst:Min\|7\|-5}}` [1]
a	will add an asterisk before the template code	`* {{subst:Min\|7\|-5}}`

Unnamed (Positional)

[edit ]

This template can take any number of unnamed parameters as parameters accompanying the template link (or name); see Examples below.

Examples

[edit ]

Use the displayed value in the code column, not the underlying source code.

Code	Output	Remarks
`{{tlxs\|Banner}}`	`{{subst:Banner}}`	Template:Banner does not exist. (Non-existent template is redlinked.)
`{{tlxs\|Abc}}`	`{{subst:Abc}}`	Template:Abc exists.
`{{tlxs\|abC}}`	`{{subst:abC}}`	Template names are case-sensitive
`{{tlxs\|abc}}`	`{{subst:abc}}`	(but the first letter is case-insensitive).
`{{tlxs\|x0}}`	`{{subst:x0}}`	no parameters
`{{tlxs\|x1\|one}}`	`{{subst:x1\|one}}`	one parameter
`{{tlxs\|x2\|one\|two}}`	`{{subst:x2\|one\|two}}`	two parameters
`{{tlxs\|x2\|2=one=1\|3=two=2}}`	`{{subst:x2\|one=1\|two=2}}`	two parameters, assigned values
`{{tlxs\|x3\|1\|2\|3\|4\|5\|6\|7\|8\|9\|10}}`	`{{subst:x3\|1\|2\|3\|4\|5\|6\|7\|8\|9\|10}}`	ten parameters
`{{tlxs\|convert\|<nowiki>14\|m\|ftin\|abbr=out\|sp=us</nowiki>}}`	`{{subst:convert\|14\|m\|ftin\|abbr=out\|sp=us}}`	Unlimited parameters, as one `<nowiki>...</nowiki>` string.
`{{tlxs\|x2\|two}}`	`{{subst:x2\|two}}`	Empty parameters are discarded.
`{{tlxs\|x0\|code: on}}`	`{{subst:x0}}`	<code> style
`{{tlxs\|x0\|plaincode: on}}`	`{{subst:x0}}`	plaincode style
`{{tlxs\|x0\|kbd: on}}`	`{{subst:x0}}`	<kbd> style
`{{tlxs\|x0\|bold: on}}`	`{{subst:x0 }}`	bold link/name
`{{tlxs\|x1\|one\|italic: on}}`	`{{subst:x1\|one}}`	parameter(s) in italics
`{{tlxs\|x0\|nolink: on}}`	`{{subst:x0}}`
`{{tlxs\|x0\|subst: on}}`	`{{subst:x0}}`
`{{tlxs\|x0\|brace: on}}`	`{{subst:x0}}`	all braces in link
`{{tlxs\|x0\|braceinside: on}}`	`{{subst:x0}}`	inside braces in link
`{{tlxs\|x0\|alttext: x0 link}}`	`{{subst:x0 link}}`
`{{tlxs\|x0\|bold: on\|code: on\|brace: on}}`	`{{subst:x0}}`	Combine multiple parameter settings.
`{{tlxs\|abc\|{{spaces}}one{{spaces}}}}`	`{{subst:abc\| one }}`	Using {{spaces }} before and after a parameter.
`{{tlxs\|x2\|bold: on\|code: on\|one\|two}}`	`{{subst:x2 \|one\|two}}`	Can combine named and anonymous parameters ...
`{{tlxs\|x2\|one\|two\|bold: on\|code: on}}`	`{{subst:x2 \|one\|two}}`	... in any order ...
`{{tlxs\|x2\|one\|code: on\|two\|bold: on\|three}}`	`{{subst:x2 \|one\|two\|three}}`	... even intermixed ...
`{{tlxs\|x2\|one\|code: on\|two\|bold: on\|three\|italic: on}}`	`{{subst:x2 \|one\|two\|three}}`	... with many configurations.
`{{tlxs\|x1\|x=u}}`	`{{subst:x1}}`	= won't work
`{{tlxs\|x1\|x=u}}`	`{{subst:x1\|x=u}}`	`=` is okay
`{{tlxs\|x1\|x{{=}}u}}`	`{{subst:x1\|x=u}}`	`{{=}}` is okay (see Template:=)
`{{tlxs\|x1\|x<nowiki>=</nowiki>u}}`	`{{subst:x1\|x=u}}`	Sticky nowiki is okay.
`{{tlxs\|x2\|3: two\|2: one}}`	`{{subst:x2\|one\|two}}`	Right-to-left is okay
`{{tlxs}}`	tlxs	With no arguments, it emits the current page name without braces.
`{{tlxs\|x2\|3: one\|4: two}}`	`{{subst:x2}}`	Null parameter stops parsing.

Wrapping of long names (default)
Code	Output
`{{tlxs\|long template name that would wrap to new line\|this is a long value for the 1st parameter that would wrap}}`	`{{subst:long template name that would wrap to new line\|this is a long value for the 1st parameter that would wrap}}`

Wrapping of long names (`nowrap=on`)
Code	Output
`{{tlxs\|nowrap: on\|long template name that would wrap to new line\|long value for the 1st parameter that would wrap}}`	`{{subst:long template name that would wrap to new line\|long value for the 1st parameter that would wrap}}`

Wrapping of long names (`nowrapname=on`)
Code	Output
`{{tlxs\|nowrapname: on\|long template name that would wrap to new line\|long value for the 1st parameter that would wrap}}`	`{{subst:long template name that would wrap to new line \|long value for the 1st parameter that would wrap}}`

Comparison of template-linking templates according to the styles of generated text and link produced
Text style ↓	`{{tlg}}` options^{[note 1]} to achieve text style	Link style
Text style ↓	`{{tlg}}` options^{[note 1]} to achieve text style	Linked	Unlinked	Linked with subst	Unlinked with subst	Linked including braces	Linked with alternative text
`{{tlg}}` options^{[note 1]} to achieve link style	—	DEFAULT	`nolink=yes`	`subst=yes`	`nolink=yes\|subst=yes`	`braceinside=yes`	`alttext=Foo` `2=Foo`
normal	DEFAULT	{{tlg}}^{[note 1]} {{tl }} {{tlp\|1\|2\|...}}^{[note 2]} {{Template:tlu}}^{[note 3]}	{{tlf}}^{[note 2]} ^{<template link>}	{{subst:tls}} {{subst:Template:tlsu}}^{[note 3]}	{{subst:tlsf}}^{[note 2]} ^{<template link>}	{{tn}}	{{tla}}
`code`	`code=yes`	`{{tl2}}` `{{tlx}}` `{{Template:tlxu}}`^{[note 3]}	`{{tlc}}`^{[note 2]} ^{<template link>} `{{tnull}}`^{<template link>}	`{{subst:tlxs}}`	`{{subst:tlsc}}`^{[note 2]} ^{<template link>}	—
monospace	`plaincode=yes`^{[note 4]}	—		{{subst:tltss}}^{[note 5]}	—
`kbd`	`kbd=yes`^{[note 5]}	—		{{subst:tltss}}^{[note 5]}	—
bold	`bold=yes`	{{tlb }}	—
`bold+code`	`bold=yes\|code=yes`	`{{tlxb }}`
`italic+code`	`italic=yes\|code=yes`	`{{tlxi}}`

^ ^a ^b ^c {{tlg}} is the most general template, allowing any combination of text style and/or link style options.
^ ^a ^b ^c ^d ^e Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.
^ ^a ^b ^c Allows links to templates in any namespace.
^ {{tlg|plaincode=yes}} uses <code style="border:none; background-color:transparent;">...</code>.
^ ^a ^b Displays monospaced font using <span style="font-family:monospace;">...</span>.

Other formatting templates

[edit ]

Templates producing specialised formatting effects for given templates, modules or parameters
Code example	Effect	Notes
<syntaxhighlightlang="wikitext"> {{Hatnote \| Some text \| selfref = yes \| category = no \| lang = fr }} </syntaxhighlight>	{{Hatnote \| Some text \| selfref = yes \| category = no \| lang = fr }}	Same as above
`<syntaxhighlight lang="wikitext" inline>{{Hatnote\|Some text\|selfref=yes\|category=no\|lang=fr}}</syntaxhighlight>`	`{{Hatnote\|Some text\|selfref=yes\|category=no\|lang=fr}}`	Same as above
`{{tl2\|Hatnote\|lang=fr}}`	`{{hatnote}}`	Supports linking to sister projects (e.g., fr:Hatnote)
`{{demo\|<nowiki>{{Hatnote\|Some text}}</nowiki>}}`	{{hatnote\|Some text}} Some text	Shows code and example
`{{tln\|Hatnote}}`	Template:Hatnote	Produces a normal link to the template
`{{elc\|Template:Example}}` `{{elc\|Template:Example\|Text\|suffix}}`	`[[Template:Example]]` `[[Template:Example\|Text]]suffix`	Shows how wikilink would be entered in wiki markup, with optional link text and suffix
`{{ml\|Example\|hello}}`	{{#invoke:Example\|hello}}	Counterpart to {{tl }} for linking to Lua modules
`{{mlx\|Example\|hello}}`	`{{#invoke:Example\|hello}}`	Counterpart to {{tlx }} for linking to Lua modules
`{{ml-lua\|Module:Example}}`	`require('Module:Example')`	Link to Lua modules and built-in libraries, showing Lua code.
`{{para\|title\|<var>book title</var>}}`	`\|title=book title`	Formats template parameters for display, with or without values
`{{sclx\|LASTING}}`	`[[WP:LASTING]]`	Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a `<code>...</code>` tag.
`{{tag\|ref}}` `{{xtag\|templatedata}}`	`<ref>...</ref>` `<templatedata>`	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
`{{dtl\|Ping project}}`	{{d:Ping project}}	Wikidata counterpart to {{tl }}
`{{mwl\|#if}}` `{{mwl\|#if\|{{{1}}}\|true\|false}}`	{{#if}} {{#if:{{{1}}}\|true\|false}}	Magic word links
`{{pf\|if}}` `{{pf\|if\|{{{1}}}\|true\|false}}`	{{#if}} {{#if:{{{1}}}\|true\|false}}	Parser function equivalent to {{tl }}
`{{magic word\|uc:}}`	{{uc:}}	Magic word links

With utility links

[edit ]

Templates producing utility links for a given template (Hatnote used here as example)
Code example	Effect
`{{lt\|Hatnote}}`	Template:Hatnote (edit \| talk \| history \| links \| watch \| logs)
`{{lts\|Hatnote}}`	Template:Hatnote (edit talk links history)
`{{t links\|Hatnote}}`	{{Hatnote}} (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test)
`{{tfd links\|Hatnote}}`	Template:Hatnote (talk · history · transclusions · logs · subpages)
`{{tetl\|Hatnote}}`	{{Hatnote}} links talk edit
`{{tsetl\|Hatnote}}`	{{subst:Hatnote}} links talk edit
`{{ti\|Hatnote}}`	Template:Hatnote (talk · links · edit)
`{{tic\|Hatnote}}`	Template:Hatnote (talk links edit)
`{{tim\|Hatnote}}`	m:Template:Hatnote (backlinks edit)
`{{tiw\|Hatnote}}`	Template:Hatnote (backlinks edit)
`{{tlt\|Hatnote}}`	{{Hatnote}} (talk)
`{{ttl\|Hatnote}}`	Template:Hatnote (links, talk)
`{{twlh\|Hatnote}}`	Template:Hatnote (links, talk)

v
t
e

Semantic markup templates

Template	Example output	Use
{{strong }}	Important!	To indicate <strong> importance, seriousness, or urgency instead of just simple typographical boldfacing
{{strongbad }}	"Never use ..."	Same as {{strong}} but in red
{{stronggood }}	"Only use ..."	Same as {{strong}} but in green
{{em }}	"An emphatic phrase"	To indicate <em> stress emphasis (not just purely typographical italicization like for book titles or foreign terms)
{{var }}	`strPrefix`	To indicate text is a variable name. Use for any variable names except those including "I" (uppercase i) and/or "l" (lowercase L); for these, {{var serif}} should be used to ensure a noticeable distinction
{{var serif }}	`strIllustratePrefix`	(see {{var}} above)
{{tld }}	`{{DEFAULTSORT:Y, X}}`	To display wikicode variables and magic words as they would appear in code
{{para }}	`\|year=2008`	To display template parameters with or without values
{{param }}	`{{{title\|alt}}}`	To display parameters as used in code (i.e. with triple braces), especially to indicate relationships between them. May be combined with {{para}} above
{{param value }}	`··2·blanks·fore·and·aft··`	To display parameter values lightly bordered; replaces <code>...</code>, especially when value contains embedded or leading/trailing blanks; visualized here with middot (·) but can use ␠, ▯, or any character.
{{tlx }} etc.	`{{Template\|1\|2\|...\|10}}`	To display a template call (with or without parameters and values) as code
{{tag }}	"The `<img>...</img>` tags ..."	To render HTML elements ("tags") in prose
{{code }}/{{codett }}	"Ensure the `alt=` parameter ..."	To indicate text is source code. To nest other templates within {{code}}, use `<code>...</code>`. {{codett }} differs only in styling: `someMethod` becomes `someMethod`
{{PreCode }}	"FORTH has keyword `?BRANCH`."	Like {{code }}, but prevents line breaks inside the code. Only for very short code parts.
{{subst:codenowiki }}	`{{small\|small text example}}`	To wrap example code in `<code><nowiki>...</nowiki></code>`
{{subst:kbdnowiki }}	`{{large\|large text example}}`	To wrap example code in `<kbd><nowiki>...</nowiki></kbd>`
{{syntaxhighlight }}	_{[this is a block template]}	( or `{{sxhl}}` ) Wrapper for `<syntaxhighlight>...</syntaxhighlight>`, but will wrap overflowing text
{{deprecated code }}	"Do not use `<(削除) blink (削除ここまで)>`."	( or `{{dc}}` ) To indicate deprecated source code in template documentation, articles on HTML specs, etc. The `{{dc2}}` variant uses strike-through (`<(削除) blink (削除ここまで)>`) while `{{dcr}}` uses red (`<(削除) blink (削除ここまで)>`).
{{pre }}	_{[this is a block template]}	For larger blocks of source code and other pre-formatted text
{{quote }}	_{[this is a block template]}	For block quotations (only – never for non-quotations)
{{block indent }}	_{[this is a block template]}	For indented blocks of material; visually identical to `{{quote}}` but without quote markup
{{kbd }}	`user input`	To indicate user input
{{key press }}	`Ctrl`+`x`	To indicate specific-keystroke input, including combinations
{{key top }}	`Left shift`	Similar; includes more symbols, but does not directly support combinations
{{button }}	`Don't save`	To indicate a button in a user interface
{{samp }}	`example output`	To indicate sample or example output

The above documentation is transcluded from Template:Tlg/doc. (edit | history)
Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
Subpages of this template.

Retrieved from "https://en.wikipedia.org/w/index.php?title=Template:Template_link_expanded_with_subst/sandbox&oldid=1265037497"

Parameters

Unnamed (Positional)

Examples

See also

General-purpose formatting

Other formatting templates

With utility links