Template:Template_link_with_subst
{subst:Template:Template link with subst}
This template, often abbreviated as {tls}, is used to provide stylized formatting to template displays without actually using the template itself. The code generated will be displayed inline. For a multi-line output, see {tj}.
Parameters
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} | {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)
This template can take any number of unnamed parameters as parameters accompanying the template link (or name); see Examples below.
Examples
Use the displayed value in the code column, not the underlying source code.
| Code | Output | Remarks |
|---|---|---|
| {tls | {subst:Banner} | Template:Banner does not exist. (Non-existent template is redlinked.) |
| {tls | {subst:Abc} | Template:Abc exists. |
| {tls | {subst:abC} | Template names are case-sensitive |
| {tls | {subst:abc} | (but the first letter is case-insensitive). |
| {tls | {subst:x0} | no parameters |
| {tls | {subst:x1|one} | one parameter |
| {tls | {subst:x2|one|two} | two parameters |
| {tls | {subst:x2|one=1|two=2} | two parameters, assigned values |
| {tls | {subst:x3|1|2|3|4|5|6|7|8|9|10} | ten parameters |
| {tls | {subst:convert|14|m|ftin|abbr=out|sp=us} | Unlimited parameters, as one <nowiki>...</nowiki> string. |
| {tls | {subst:x2|two} | Empty parameters are discarded. |
| {tls | {subst:x0} | <code> style |
| {tls | {subst:x0} | plaincode style |
| {tls | {subst:x0} | <kbd> style |
| {tls | {subst:x0} | bold link/name |
| {tls | {subst:x1|one} | parameter(s) in italics |
| {tls | {subst:x0} | |
| {tls | {subst:x0} | |
| {tls | {subst:x0} | all braces in link |
| {tls | {{subst:x0}} | inside braces in link |
| {tls | {subst:x0 link} | |
| {tls | {subst:x0} | Combine multiple parameter settings. |
| {tls | {subst:abc| one } | Using {spaces} before and after a parameter. |
| {tls | {subst:x2|one|two} | Can combine named and anonymous parameters ... |
| {tls | {subst:x2|one|two} | ... in any order ... |
| {tls | {subst:x2|one|two|three} | ... even intermixed ... |
| {tls | {subst:x2|one|two|three} | ... with many configurations. |
| {tls | {subst:x1} | = won't work |
| {tls | {subst:x1|x=u} | = is okay |
| {tls | {subst:x1|x=u} | {=} is okay (see Template:=) |
{tls<nowiki>...</nowiki>u} | {subst:x1|x=u} | Sticky nowiki is okay. |
| {tls | {subst:x2|one|two} | Right-to-left is okay |
| {tls} | tls | With no arguments, it emits the current page name without braces. |
| {tls | {subst:x2} | Null parameter stops parsing. |
| Code | Output |
|---|---|
| {tls |
{subst:long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap} |
| Code | Output |
|---|---|
| {tls |
{subst:long template name that would wrap to new line|long value for the 1st parameter that would wrap} |
| Code | Output |
|---|---|
| {tls |
{subst:long template name that would wrap to new line|long value for the 1st parameter that would wrap} |
See also
General-purpose formatting
| Text style ↓ | {tlg} options[note 1]to achieve text style |
Link 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
|
braceinside=yes
|
alttext=Foo2=Foo
|
| normal | DEFAULT | {tlg} {tl} {tlp|1|2|...} {Template:tlu} |
{tlf} <template link> |
{subst:tls} {subst:Template:tlsu} |
{subst:tlsf} <template link> |
{tn} | {tla} |
code
|
code=yes
|
{tl2}{tlx}{Template:tlxu} |
{tlc}<template link> {tnull}<template link>
|
{subst:tlxs}
|
{subst:tlsc}<template link> |
— | |
| monospace | plaincode=yes |
— | {subst:tltss} |
— | |||
| kbd | kbd=yes | ||||||
| bold | bold=yes
|
{tlb} | — | ||||
bold+code
|
bold=yes
|
{tlxb}
| |||||
italic+code
|
italic=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
| Code example | Effect | Notes |
|---|---|---|
{Tj|Hatnote|Some text|selfref: yes|category: no|lang: fr}
|
Supports colors, placeholder texts, named and unnamed parameters | |
<syntaxhighlight lang="wikitext">
{Hatnote
| Some text
| selfref = yes
| category = no
| lang = fr
}
</syntaxhighlight>
|
{Hatnote
| Some text
| selfref = yes
| category = no
| lang = fr
}
|
Same as above |
{Tji|Hatnote|Some text|selfref: yes|category: no|lang: fr}
|
{Hatnote |
Supports colors, placeholder texts, named and unnamed parameters |
|
{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|lang=fr|Some text}</nowiki>}
|
{hatnote|lang=fr|Some text}
|
Shows code and example |
{tln|Hatnote}
|
Template:Hatnote | Produces a normal link to the template |
{elc|Template:Hatnote}{elc|Template:Hatnote|Hatnote}
|
[[Template:Hatnote]][[Template:Hatnote|Hatnote]] |
Formats wikilink, with optional piped link text and blended suffix |
{ml|Example|hello}
|
{#invoke:Example|hello} | Counterpart to {tl} for linking to Lua modules |
{mfl|Example|hello}
|
{#invoke:Example|hello} | Similar to {ml}, but expects the function to be documented and creates a link to the corresponding section |
{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} |
{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
| 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} |
{tsetl|Hatnote}
|
{subst:Hatnote} |
{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) |