Template:Template link/doc: Difference between revisions

Content deleted Content added

Inline

Latest revision as of 18:15, 30 August 2024

This is a documentation subpage for Template:Template link.
It may contain usage information, categories and other content that is not part of the original template page.

Shortcuts

{{tl}}
{{TL}}
{{t}}
{{temp}}

The template link template is a simple macro template used to display a template name as a link surrounded by braces, thus showing the template name as code rather than actually invoking it. Its primary use is in instruction and documentation where it is used to refer to a template by name without invoking it.

Note that this template may be used under the name "tee-el" (tl) as well as "tee-one" (t1)— both function the same way and produce the same results. This is not true for all such visually confusing templates containing a possible 1/l mix-up as they are not interchangeable.

{{Tla}} works exactly like {{tl}} with the addition of optionally displaying alternative label text (link label). {{tlg}} can include the use of parameters in the template (as {{{1}}}).

Examples

A short example of its use is:

which generates

Other longer examples:

Code	Result	Notes
{{tl\|Void}}	{{Void}}	Standard usage
{{tls\|Example}}	{{subst:Example}}	For templates that should be substituted
{{tl2\|X1}}	`{{X1}}`	This formats the link to show how it would look in code (i.e., monospace font)
{{tl2\|sister=M:\|3x}}	`{{3x}}`	Same as above, for templates on another Wikimedia project (in this example, Meta, using `m:`). See Interwiki codes.
{{tl2\|sister=wikibooks\|lang=de:\|WP}}	`{{WP}}`	For templates on another language project
{{tl\|1==)}}	{{=)}}	Use the format `{{tl\|1=templatename}}` if the template contains template coding characters such as {{=)}} or {{!}}

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 in articles based on its TemplateData.

TemplateData for Template link

This template displays a template name as a link surrounded by braces, thus showing how the template name would be used in code. Its primary use is in instruction and documentation.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Template name	`1`	Positional parameter: the template name without the namespace prefix “Template:”, which is added automatically	Template	required

Template:tl2 (backlinks edit)
Template:tl (backlinks edit)
Template:tlp (backlinks edit) to produce a [t]emplate [l]ink with a single [p]arameter.
Template:tlx (backlinks edit) to produce a [t]emplate [l]ink with an e[x]panded number of parameters.
Template:tlsp (backlinks edit) to produce a [t]emplate [l]ink that's [s]ubst:ituted, with a single [p]arameter.
Template:lts (backlinks edit)
Template:tlu (backlinks edit), tl or tlp in any namespace.
Category:Internal template-link templates(edit talk links history)
Template:tl-r (backlinks edit) to produce a [t]emplate [l]ink to a template [r]edirect.

General-purpose formatting

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>}	{{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>}	—
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}}`

^ ^a ^b ^c {{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}}`	`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: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}}`	Template:Hatnote (links, talk)
`{{twlh\|Hatnote}}`	Template:Hatnote (links, talk)

[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 2]

[note 3]

[note 4]

[note 5]

@@ Line 1: / Line 1: @@
 {{Documentation subpage}}
 <!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
-{{redirect-distinguish|Template:TI|Template:Ti}}{{Template shortcut|T}}
+{{redirect-distinguish|Template:TI|Template:Ti}}{{Template shortcut|tl|TL|t|temp}}
-{{#ifeq:{{FULLPAGENAME}} | Template:Tl | {{High-risk| 4570631 |all-pages = yes}} {{used in system}} }}
+{{#ifeq:{{FULLPAGENAME}} | Template:Template link | {{used in system}} {{cascade-protected template}} }}
 The '''template link''' template is a simple [[w:Macro (computer science)|macro]] [[m:Help:template|template]] used to display a template name as a link surrounded by braces, thus showing the template name as code rather than actually invoking it. Its primary use is in instruction and documentation where it is used to refer to a template by name without invoking it.
-Note that this template may be used under the name "tee-el" (tl) as well as "tee-one" (t1)— both function the same way and produce the same results. This is not true for all such visually confusing templates containing a possible 1/l mix-up:  and  are not interchangeable.
+Note that this template may be used under the name "tee-el" (tl) as well as "tee-one" (t1)— both function the same way and produce the same results. This is not true for all such visually confusing templates containing a possible 1/l mix-up as they are not interchangeable.
-{{tl|Tla}} works exactly like {{tl|tl}} with the addition of optionally displaying alternative label text (link label).
+'''{{tl|Tla}}''' works exactly like {{tl|tl}} with the addition of optionally displaying '''a'''lternative label text (link label).   '''{{tl|tlg}}''' can include the use of parameters in the template (as  <nowiki>{{{1}}}</nowiki>).
-__TOC__
-== TemplateData ==
-{{TemplateData header}}
-<templatedata>{
-"description": "This template displays a template name as a link surrounded by braces, thus showing how the template name would be used in code. Its primary use is in instruction and documentation.",
-"params": {
-  "1": {
-    "label": "template name",
-    "description": "the template name without the namespace prefix “Template:”, which is added automatically",
-    "type": "line",
-    "required": true
-  }
-}}</templatedata>
-More complex variations are described below.
 ==Examples==
 A short example of its use is:
-::<code><nowiki>{{tl|Example}}</nowiki></code>
+::{{tji|tl|Example}}
 :which generates
 ::{{tl|Example}}
@@ Line 40: / Line 23: @@
 ! Notes
 |-
-| {{tlx|tl|Void}}
+| {{tji|tl|Void}}
 | {{tl|Void}}
 | Standard usage
 |-
-| {{tlx|tls|Example}}
+| {{tji|tls|Example}}
 | {{tls|Example}}
 | For templates that should be [[Wikipedia:Substitution|substituted]]
 |-
-| {{tlx|tl2|X1}}
+| {{tji|tl2|X1}}
 | {{tl2|X1}}
 | This formats the link to show how it would look in code (i.e., monospace font)
 |-
-| {{tlx|tl2|sister{{=}}M:|3x}}
+| {{tji|tl2|sister: M&#58;|3x}}
 | <code><nowiki>{{</nowiki>[[{{{LANG|}}}M:{{ns:Template}}:3x|3x]]<nowiki>}}</nowiki></code>
-| Same as above, for templates on another Wikimedia project (in this example, Meta)
+| Same as above, for templates on another Wikimedia project (in this example, Meta, using '''<code>m:</code>'''). See [[Help:Interwiki_linking#Prefix_codes_for_linking_to_Wikimedia_sister_projects|Interwiki codes]].
 |-
-| {{tlx|tl2|sister{{=}}wikibooks|lang{{=}}de:|WP}}
+| {{tji|tl2|sister: wikibooks|lang: de&#58;|WP}}
 | <code><nowiki>{{</nowiki>[http://de.wikibooks.org/wiki/Vorlage:WP WP]<nowiki>}}</nowiki></code><!--
 ––––– This is currently a fraudulent output result... the template code needs modified to work
@@ Line 66: / Line 49: @@
 | For templates on another language project
 |-
-| {{tlx|tl|<nowiki>1==</nowiki>)}}
+| {{tji|tl|1: {{=}})}}
 | {{tl|1==)}}
 | Use the format <code><nowiki>{{tl|1=templatename}}</nowiki></code> if the template contains template coding characters such as {{tl|1==)}} or {{tl|1=!}}
 |}
+== TemplateData ==
+{{TemplateData header}}
+<templatedata>{
+	"description": "This template displays a template name as a link surrounded by braces, thus showing how the template name would be used in code. Its primary use is in instruction and documentation.",
+	"params": {
+		"1": {
+			"label": "Template name",
+			"description": "Positional parameter: the template name without the namespace prefix “Template:”, which is added automatically",
+			"type": "wiki-template-name",
+			"required": true
+		}
+	},
+	"format": "inline"
+}</templatedata>
 == See also ==
+* {{tiw|tl2}}
+* {{tiw|tl}}
+* {{tiw|tlp}} to produce a [t]emplate [l]ink with a single [p]arameter.
+* {{tiw|tlx}} to produce a [t]emplate [l]ink with an e[x]panded number of parameters.
+* {{tiw|tlsp}} to produce a [t]emplate [l]ink that's [[Wikipedia:Substitution|[s]ubst:]]ituted, with a single [p]arameter.
+* {{tiw|lts}}
+* {{tiw|tlu}}, tl or tlp in any [[Wikipedia:Namespaces|namespace]].
+* {{lcs|Internal template-link templates}}
+* {{tiw|tl-r}} to produce a [t]emplate [l]ink to a template [r]edirect.
 {{Template-linking templates}}
@@ Line 77: / Line 84: @@
 <!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
 [[Category:Internal template-link templates]]
 }}</includeonly>

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