Template:Template link code - Wikipedia (original) (raw)

From Wikipedia, the free encyclopedia

	This template is used on approximately 1,120,000 pages, or roughly 2% of all pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

{{tlc Template:Tlc}}

This template, often abbreviated as {{tlc}}, 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](/wiki/Template:Tlg "Template: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 `...` 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 `...` 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 `...`	{{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]
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
{{tlc\|Banner}}	{{Banner}}	Template:Banner does not exist. (Non-existent template is redlinked.)
{{tlc\|Abc}}	{{Abc}}	Template:Abc exists.
{{tlc\|abC}}	{{abC}}	Template names are case-sensitive
{{tlc\|abc}}	{{abc}}	(but the first letter is case-insensitive).
{{tlc\|x0}}	{{x0}}	no parameters
{{tlc\|x1	one}}	{{x1\|one}}
{{tlc\|x2	one	two}}
{{tlc\|x2	2=one=1	3=two=2}}
{{tlc\|x3	1	2
{{tlc\|convert	14	m
{{tlc\|x2	two}}	{{x2\|two}}
{{tlc\|x0	code=on}}	{{x0}}
{{tlc\|x0	plaincode=on}}	{{x0}}
{{tlc\|x0	kbd=on}}	{{x0}}
{{tlc\|x0	bold=on}}	{{x0}}
{{tlc\|x1	one	italic=on}}
{{tlc\|x0	nolink=on}}	{{x0}}
{{tlc\|x0	subst=on}}	{{subst:x0}}
{{tlc\|x0	brace=on}}	{{x0}}
{{tlc\|x0	braceinside=on}}	{{x0}}
{{tlc\|x0	alttext=x0 link}}	{{x0 link}}
{{tlc\|x0	bold=on	code=on
{{tlc\|abc	{{spaces}}one{{spaces}}}}	{{abc\| one }}
{{tlc\|x2	bold=on	code=on
{{tlc\|x2	one	two
{{tlc\|x2	one	code=on
{{tlc\|x2	one	code=on
{{tlc\|x1	x=u}}	{{x1}}
{{tlc\|x1	x=u}}	{{x1\|x=u}}
{{tlc\|x1	x{{=}}u}}	{{x1\|x=u}}
{{tlc\|x1	2=x=u}}	{{x1\|x=u}}
{{tlc\|x1	x=u}}	{{x1\|x=u}}
{{tlc\|x2	3=two	2=one}}
{{tlc}}	tlc	With no arguments, it emits the current page name without braces.
{{tlc\|x2	3=one	4=two}}

Wrapping of long names (default)

Code	Output
{{tlc\|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
{{tlc\|nowrap=on	long template name that would wrap to new line

Wrapping of long names (nowrapname=on)

Code	Output
{{tlc\|nowrapname=on	long template name that would wrap to new line

TemplateData

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 `…` 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 `...` 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 `...`	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

^ a b c {{[tlg](/wiki/Template:Tlg "Template: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 ....
^ 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
<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
<syntaxhighlight lang="wikitext" inline>{{Hatnote\|Some text	selfref=yes	category=no	lang=fr}}	{{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\|{{Hatnote	Some text}}}}	{{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	`book title`}}	\|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 `...` tag.
{{tag\|ref}}{{xtag	templatedata}}	...<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 /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)
{{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 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 {{parameter}} \|year=2008 To display template parameters with or without values {{param}} {{{title

v t e 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 {{parameter}} |year=2008 To display template parameters with or without values {{param}} {{{title