Template:Dcr

~~Example text~~

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

{{dc}}

Usage

The {{deprecated code}} template (easiest used from its {{dc}} redirect) can be used to indicate, e.g. in template documentation or OODA WIKI articles on things like HTML specifications, code that has been deprecated and should not normally be used. It can also be used to indicate other deleted or deprecated material. On the technical level it is a CSS-styled ‎<del>...‎</del> that greys out the text (the near-universal sign in computing and computing documentation for "doesn't work", "don't do this", "bad code", "ignore", "option not available", etc.), and removes that element's usual strikethrough (CSS: "line-through") rendering, which makes the content hard to read. If you really want that line-through, use the {{dc2}} (AKA {{dcs}}) variant ~~to do this~~; it is otherwise identical.

Note: This template does not apply a monospaced font. This is so that it can be used inside an existing code (or non-code) block and inherit its font style. If necessary, wrap the template in one of ‎<code>...‎</code> (source code), ‎<kbd>...‎</kbd> (example input), or ‎<samp>...‎</samp> (example output) as semantically appropriate. If you want monospace without semantic markup like ‎<code>, you can use the alternative templates {{mxtd}}: Example text, or {{!mxt}}: Example text.

Parameters

|1= the content to be marked as deprecated
|2= or |title= a mouse-over "tooltip" (in some browsers, anyway), e.g. for briefly explaining the deprecation, e.g. "Deprecated since HTML 3.0" or "Breaks infobox formatting"
|red=y make the text red instead of grey, for indicating dangerous/error/forbidden things (a shortcut for this is {{dcr}})
|class= assign a CSS class
|id= assign an HTML ID for #linking and other purposes (must be unique on the page and start with an alphabetic letter)
|style= add additional CSS styling (can be used to add text-decoration:line-through; back in if you want that formatting; a shortcut for this is {{dc2}} or {{dcs}})

Examples

{{dc|deprecated}} yields: ~~deprecated~~
{{dcr|deprecated}} yields: ~~deprecated~~
{{dc2|deprecated}} yields: ~~deprecated~~
{{dcs|deprecated}} yields: ~~deprecated~~

{{xtd}} and related templates for indicating deprecated, good, bad, and neutral examples in guidelines, how-tos, and template documentation.
- {{mxtd}} in this template group (example output here) is an alternative to {{dc}}.
- {{!mxt}} in this template group (example output here) is an alternative to {{dcr}}.
{{strongbad}} – for introducing something as deprecated or issuing some other warning in documentation, e.g.: {{strongbad|Not for use in mainspace.}}

Semantic markup templates

Template Example output Use

{{strong}} Important! To indicate 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 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

{{tjp}} |selfref=yes To display template parameters with colors (as they would appear in the {{tj}} and {{tji}} templates)

{{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

{{tji}} {{hatnote|Hello|selfref=yes|category=no}} To showcase with colors in horizontal format the syntax of any template, while providing an easy way to display placeholder texts using colons as separators

{{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

Shortcut

{{codenowiki}}

This template uses Lua:

Module:Template link general

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

Wrapping of long names (default)
Code	Output
{{codenowiki\|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}}

Wrapping of long names (`nowrap=on`)
Code	Output
{{codenowiki\|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}}

Wrapping of long names (`nowrapname=on`)
Code	Output
{{codenowiki\|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}}

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>}	Template loop detected: Template: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}}`

↑ ^1.0 ^1.1 ^1.2 {{tlg}} is the most general template, allowing any combination of text style and/or link style options.
↑ ^2.0 ^2.1 ^2.2 ^2.3 ^2.4 Prevents wrapping of text by placing it inside ‎...‎ tags.
↑ ^3.0 ^3.1 ^3.2 Allows links to templates in any namespace.
↑ {{tlg|plaincode=yes}} uses ‎<code style="border:none; background-color:transparent;">...‎</code>.
↑ ^5.0 ^5.1 Displays monospaced font using ‎...‎.

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 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

Templates producing utility links for a given template (Hatnote used here as example)
Code example	Effect
`{{lt\|Hatnote}}`	[[Template:]]
`{{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}}`	{{Hatnote}}
`{{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)

Template loop detected: Template:Semantic markup templates

{{small|small text}}

To wrap example code in <code><nowiki>...</nowiki></code>

Shortcut

{{kbdnowiki}}

This template uses Lua:

Module:Template link general

Parameters

Parameter	Action	Use with {{example}}	Default active
	Default (without accessory parameters)	{{example}}
brace	Include braces as part of the template link	{{example}}	{{tlw}}/{{tn}}
braceinside	Include innermost braces as part of the template link	{{example}}
bold	Renders the template link/name in bold	{{example}}	{{tlb}}, {{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}}	{{tlf}}, {{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}}	{{tls}}, {{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}}` [2]

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

Wrapping of long names (default)
Code	Output
{{kbdnowiki\|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}}

Wrapping of long names (`nowrap=on`)
Code	Output
{{kbdnowiki\|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}}

Wrapping of long names (`nowrapname=on`)
Code	Output
{{kbdnowiki\|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}}

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>}	Template loop detected: Template: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}}`

↑ ^1.0 ^1.1 ^1.2 {{tlg}} is the most general template, allowing any combination of text style and/or link style options.
↑ ^2.0 ^2.1 ^2.2 ^2.3 ^2.4 Prevents wrapping of text by placing it inside ‎...‎ tags.
↑ ^3.0 ^3.1 ^3.2 Allows links to templates in any namespace.
↑ {{tlg|plaincode=yes}} uses ‎<code style="border:none; background-color:transparent;">...‎</code>.
↑ ^5.0 ^5.1 Displays monospaced font using ‎...‎.

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 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

Templates producing utility links for a given template (Hatnote used here as example)
Code example	Effect
`{{lt\|Hatnote}}`	[[Template:]]
`{{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}}`	{{Hatnote}}
`{{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)

Template loop detected: Template:Semantic markup templates

{{large|large text}}

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

{{tj}} _{[this is a block template]} To showcase with colors and multiple lines (vertical format) the syntax of any template, while providing an easy way to display placeholder texts using colons as separators

{{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:Deprecated code/doc.
Editors can experiment in this template's sandbox and testcases pages.
Subpages of this template.

Usage

Parameters

Examples

See also

Parameters

Unnamed (Positional)

Examples

See also

General-purpose formatting

Other formatting templates

With utility links

Parameters

Unnamed (Positional)

Examples

See also

General-purpose formatting

Other formatting templates

With utility links