Template:Template link expanded with bold

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

{{tlxb}}

This template uses Lua:

Module:Template link general (sandbox)

This template, often abbreviated as {{tlxb}}, 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.

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

Unnamed (Positional)

This template can take any number of

unnamed parameters

as parameters accompanying the template link (or name); see Examples below.

Examples

Code	Output	Remarks
{{ tlxb\|x2\|3=one\|4=two}}	`{{x2}}`	Null parameter stops parsing.

Wrapping of long names (default)
Code	Output
{{ tlxb \|long template name that would wrap to new line\|this is a long value for the 1st parameter that would wrap}}	`{{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
{{ tlxb \|nowrap=on\|long template name that would wrap to new line\|long value for the 1st parameter that would wrap}}	`{{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
{{ tlxb \|nowrapname=on\|long template name that would wrap to new line\|long value for the 1st parameter that would wrap}}	`{{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	{{ Template:tlu}}^{[note 3]}	{{tlf}}^{[note 2]} ^{<template link>}	{{ Template:tlsu}}^{[note 3]}	{{subst:tlsf}}^{[note 2]} ^{<template link>}	{{tn}}	{{ tla }}
`code`	`code=yes`	`{{` `Template:tlxu}}`^{[note 3]}	`{{tlc}}`^{template link >}	`{{subst:tlxs }}`	`{{subst:tlsc}}`^{[note 2]} ^{<template link>}	—
monospace	`plaincode=yes`^{[note 4]}	—		{{ tltss}}^{[note 5]}	—
`kbd`	`kbd=yes`^{[note 5]}	—		{{ tltss}}^{[note 5]}	—
bold	`bold=yes`	{{tlb }}	—
`bold+code`	`bold=yes\|code=yes`	`{{tlxb}}`
`italic+code`	`italic=yes\|code=yes`	`{{tlxi }}`

^
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

Templates producing specialised formatting effects for given templates, modules or parameters
Code example	Effect	Notes
`{{Tj \|Hatnote\|Some text\|selfref: yes\|category: no\|lang: fr}}`	{{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\|Some text\|selfref=yes\|category=no\|lang=fr}}	Supports colors, placeholder texts, named and unnamed parameters
`<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\|lang=fr\|Some text}}</nowiki>}}`	{{hatnote\|lang=fr\|Some text}} 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\|hello}}`	`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 `<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\|{{{1}}}\|true\|false}}`	{{#if}} {{#if:{{{1}}}\|true\|false}}	tl }}
`{{magic word\|uc:}}`	{{uc:}}	Magic word links

With utility links

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}}`	{{Hatnote}} (t/l)
`{{twlh\|Hatnote}}`	Template:Hatnote (links, talk)

The above

Template:Tlg/doc.
Editors can experiment in this template's sandbox and testcases pages.
Subpages of this template

.

[TlTfn1-1] 
tlg
}} is the most general template, allowing any combination of text style and/or link style options.

[TlTfn2-2] Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.

[TlTfn3-3] Allows links to templates in any namespace.

[TlTfn4-4] {{tlg|plaincode=yes}} uses <code style="border:none; background-color:transparent;">...</code>.

[TlTfn5-5] Displays monospaced font using <span style="font-family:monospace;">...</span>.

[note 1]

[note 3]

[note 2]

[note 4]

[note 5]

Code example	Effect	Notes
`{{Tj \|Hatnote\|Some text\|selfref: yes\|category: no\|lang: fr}}`	{{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\|Some text\|selfref=yes\|category=no\|lang=fr}}	Supports colors, placeholder texts, named and unnamed parameters
`<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\|lang=fr\|Some text}}</nowiki>}}`	{{hatnote\|lang=fr\|Some text}} 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\|hello}}`	`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 `<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\|{{{1}}}\|true\|false}}`	{{#if}} {{#if:{{{1}}}\|true\|false}}	tl }}
`{{magic word\|uc:}}`	{{uc:}}	Magic word links

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