Template:Template link with parameters

Template documentationview edit history purge

{{tlp Template:Tlp }}

This template uses Lua:

Module:Template link general (sandbox)

[画像:Warning] This template is used on approximately70,000 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.

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

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

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

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Template link with parameters in articlesbased on its TemplateData.

TemplateData for Template link with parameters

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

Template parameters[Edit template data ]
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Template name	`1`	no description	String	required
First parameter	`2`	First parameter of the template	Content	suggested
Second parameter	`3`	Second parameter of the template	Content	suggested
Third parameter	`4`	Third parameter of the template	Content	optional
Fourth parameter	`5`	Fourth parameter of the template	Content	optional
Fifth parameter	`6`	Fifth parameter of the template	Content	optional
Sixth parameter	`7`	Sixth parameter of the template	Content	optional
Seventh parameter	`8`	Seventh parameter of the template	Content	optional
Eigth parameter	`9`	Eigth parameter of the template	Content	optional
Ninth parameter	`10`	Ninth parameter of the template	Content	optional
brace	`brace`	Include braces as part of the template link	Boolean	optional
braceinside	`braceinside`	Include innermost braces as part of the template link	Boolean	optional
bold	`bold`	Renders the template link/name in bold	Boolean	optional
code	`code`	Display output using HTML <code>...</code> tags (monospaced font)	Boolean	optional
italic	`italic`	Display any parameters accompanying the template link/name in italics	Boolean	optional
kbd	`kbd`	Display output using HTML <kbd>...</kbd> tags (monospaced font)	Boolean	optional
nolink	`nolink`	Don't render the template name as a link	Boolean	optional
nowrap	`nowrap`	Prevent the insertion of line breaks (word wrap) in the output	Boolean	optional
nowrapname	`nowrapname`	Prevent word wrapping in the output of template name/link (parameters will wrap if needed)	Boolean	optional
plaincode	`plaincode`	Uses <code style="border:none; background:transparent;">...</code>	Boolean	optional
subst	`subst`	Include a subst: prefix before the template link/name	Boolean	optional
alttext	`alttext`	Label to be displayed for the template link	String	optional
_show_result	`_show_result`	Display the result of the template	Boolean	optional
_expand	`_expand`	Add a link to the expanded template page	Boolean	optional
a	`a`	Add an asterisk before the template code	Boolean	optional

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 alternativetext
`{{tlg }}` options^{[note 1]} to achieve link style	N/a	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>}	N/a
monospace	`plaincode=yes`^{[note 4]}	N/a		{{subst:tltss }}^{[note 5]}	N/a
`kbd`	`kbd=yes`^{[note 5]}	N/a		{{subst:tltss }}^{[note 5]}	N/a
bold	`bold=yes`	{{tlb }}	N/a
`bold+code`	`bold=yes\|code=yes`	`{{tlxb }}`
`italic+code`	`italic=yes\|code=yes`	`{{tlxi }}`

1 2 3 {{tlg }} is the most general template, allowing any combination of text style and/or link style options.
1 2 3 4 5 Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.
1 2 3 Allows links to templates in any namespace.
↑ {{tlg|plaincode=yes}} uses <code style="border:none; background-color:transparent;">...</code>.
1 2 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
<syntaxhighlightlang="wikitext"> {{Hatnote \| Some text \| selfref = yes \| category = no \| lang = fr }} </syntaxhighlight>	{{Hatnote \| Some text \| selfref = yes \| category = no \| lang = fr }}	Same as above
`<syntaxhighlightlang="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
`{{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 }}
`{{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 }}

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 /docedit /sbox /sboxdiff /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)
`{{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" (uppercasei) and/or "l" (lowercaseL); for these, {{var serif}} should be used to ensure a noticeable distinction
{{var serif }}	`strIllustratePrefix`	(see {{var}} above)
{{mvar }}	Let x be the maximum value used.	Used to refer to individual variables in <math> (formula) elements in normal running text.
{{dfn }}	This term has a definition	To indicate a term defined in nearby text.
{{dfni }}	This term has a definition	Wrapper for {{dfn }} that applies metadata and italic styling.
{{lang }}	She said: "Je suis française."	Indicate that a piece of text belongs to a particular language other than that of the page as a whole.
{{tld }}	`{{DEFAULTSORT:Y, X}}`	To display wikicode variables and magic words as they would appear in code
{{parameter }}	`\|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 {{parameter}} 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 }}	<table align=center style="background: ivory">	(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 }}	You miss 100% of the shots you don't take	For larger blocks of source code and other pre-formatted text
{{blockquote }}	No good deed goes unpunished	For block quotations (only – never for non-quotations)
{{block indent }}	Hurry and succumb to temptation before it goes away	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_with_parameters&oldid=989852922"

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
`<syntaxhighlightlang="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
`{{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 }}
`{{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 }}