Template:Template link general

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

Shortcut: {{tlg}}

This template uses Lua:

Module:Template link general

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. 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;color:inherit;">...</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}}`
_expand	Will add a link to the expanded template page	`{{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

Note: On the source sister projects, en.wikipedia and Meta, X0, X1, X2, ..., X9 are sandbox templates for experimentation on involved templates that need be in template space. An auto-cleansing software facility exists that might be used to duplicate the facility on other Sister projects.

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

Wrapping of long names (default)
Code	Output
`{{tlg\|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
`{{tlg\|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
`{{tlg\|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}}` optionsTemplate:NoteTag to achieve text style	Link style
Text style ↓	`{{tlg}}` optionsTemplate:NoteTag to achieve text style	Linked	Unlinked	Linked with subst	Unlinked with subst	Linked including braces	Linked with alternative text
`{{tlg}}` optionsTemplate:NoteTag to achieve link style	--	--	`nolink=yes`	`subst=yes`	`nolink=yes\|subst=yes`	`braceinside=yes`	`alttext=Foo` `2=Foo`
normal	--	{{tlg}}Template:NoteTag {{tl}} {{tlp\|1\|2\|...}}Template:NoteTag Template:TluTemplate:NoteTag	{{tlf}}Template:NoteTag ^{<template link>}	{{subst:tls}} Template:TlsuTemplate:NoteTag	Template:TlsfTemplate:NoteTag ^{<template link>}	{{tn}}	{{{{{2}}}}}
`code`	`code=yes`	{{tl2}} `{{tlx}}` Template:TlxuTemplate:NoteTag	`{{tlc}}`Template:NoteTag ^{<template link>} `{{tnull}}`^{<template link>}	{{subst:tlxs}}	Template:TlscTemplate:NoteTag ^{<template link>}	colspan="2" rowspan="3" --
monospace	`plaincode=yes`Template:NoteTag	colspan="2" rowspan="2" --	Template:TltssTemplate:NoteTag	rowspan="2" --
`kbd`	`kbd=yes`Template:NoteTag		Template:TltssTemplate:NoteTag
bold	`bold=yes`	{{tlb}}	colspan="5" rowspan="3" --
`bold+code`	`bold=yes\|code=yes`	{{tlxb}}
`italic+code`	`italic=yes\|code=yes`	Template:Tlxi

Template:NoteFoot

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}}`	Template:Tj	Supports colors, placeholder texts, named and unnamed parameters
`{{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:Tln	Produces a normal link to the template
`{{elc\|Template:Hatnote}}` `{{elc\|Template:Hatnote\|Hatnote}}`	Template:Elc Template:Elc	Formats wikilink, with optional piped link text and blended suffix
`{{ml\|Example\|hello}}`	{{#invoke:Example\|hello}}	Counterpart to {{tl}} for linking to Lua modules
`{{mlx\|Example\|hello}}`	Template:Mlx	Counterpart to {{tlx}} for linking to Lua modules
`{{ml-lua\|Module:Example\|hello}}`	Template:Ml-lua	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}}`	Template:Sclx	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>` Template:Xtag	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
`{{dtl\|Ping project}}`	Template:Dtl	Wikidata counterpart to {{tl}}
`{{pf\|if}}` `{{pf\|if\|{{{1}}}\|true\|false}}`	`#if:` `#if:`	Parser function equivalent to {{tl}}
`{{magic word\|uc:}}`	Template:Magic word	Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)
Code example	Effect
`{{lt\|Hatnote}}`	<
`{{lts\|Hatnote}}`	Template:Lts
`{{t links\|Hatnote}}`	Template:T links
`{{tfd links\|Hatnote}}`	Template:Tfd links
`{{tetl\|Hatnote}}`	Template:Tetl
`{{tsetl\|Hatnote}}`	Template:Tsetl
`{{ti\|Hatnote}}`
`{{tic\|Hatnote}}`	Template:Tic
`{{tim\|Hatnote}}`	Template:Tim
`{{tiw\|Hatnote}}`	Template:Tiw
`{{tlt\|Hatnote}}`	Template:Tlt
`{{ttl\|Hatnote}}`	Template:Ttl
`{{twlh\|Hatnote}}`	Template:Twlh

Template:Semantic markup templates

The above documentation is transcluded from Template:Template link general/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.