No edit summary
Xeverything11 (talk | contribs)
m 247 revisions imported from mhdev:Template:Template_link/doc
 
(50 intermediate revisions by 29 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
{{#ifeq:{{FULLPAGENAME}} | Template:Tl | {{High-risk| 3520000+ }} {{used in system}} }}
The '''template link''' (or "tl") 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.  
__NOTOC__
 
{{redirect-distinguish|Template:TI|Template:Ti}}
==Examples==
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: {{tl|Tla}} and {{tl|T1a}} are not interchangeable).  A short example of its use is:
An example of its use is:


::<code><nowiki>{{tl|Example}}</nowiki></code>
::<code><nowiki>{{tl|Example}}</nowiki></code>
:which generates
:which generates
::{{tl|Example}}
::{{tl|Example}}


== TemplateData ==
== TemplateData ==
{{TemplateData header}}
<templatedata>{
<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.",
"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": {
"params": {
  "1": {
"1": {
    "label": "template name",
"label": "template name",
    "description": "the template name without the namespace prefix “Template:”, which is added automatically",
"description": "positional parameter: the template name without the namespace prefix “Template:”, which is added automatically",
    "type": "line",
"type": "wiki-template-name",
    "required": true
"required": true
  }
}
}}</templatedata>
}
 
}</templatedata>
More complex variations are described below.
 
==Examples==
{| class="wikitable"
! Code
! Result
! Notes
|-
| <code><nowiki>{{tl|Void}}</nowiki></code>
| {{[[Template:Void|Void]]}}
| Standard usage
|-
| <code><nowiki>{{tls|Example}}</nowiki></code>
| {{[[Wikipedia:Substitution|subst]]:[[Template:Example|Example]]}}
| For templates that should be [[Wikipedia:Substitution|substituted]]
|-
| <code><nowiki>{{tl2|X1}}</nowiki></code>
| <code><nowiki>{{</nowiki>[[{{{LANG|}}}{{{SISTER|}}}{{ns:Template}}:X1|X1]]<nowiki>}}</nowiki></code>
| This formats the link to show how it would look in code (i.e., monospace font)
|-
| <code><nowiki>{{tl2|sister=M:|3x}}</nowiki></code>
| <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)
|-
| <code><nowiki>{{tl2|sister=wikibooks|lang=de:|WP}}</nowiki></code>
| <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
––––– per this plan, then this /doc file fixed up to match whatever the correct syntax actually is.
––––– ALMOST work:
[[:de:wikibooks:{{ns:template}}:WP|WP]]
[[de:wikibooks:{{ns:template}}:WP|WP]]
-->
| For templates on another language project
|-
| <code><nowiki>{{tl|1==)}}</nowiki></code>
| {{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=!}}
|}


== See also ==
== See also ==
{{Template-linking templates}}
* {{tl|tlx}} to produce a [t]emplate [l]ink with an e[x]panded number of parameters.
 
<includeonly>[[Category:link templates]]</includeonly>
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
[[Category:Internal template-link templates]]
 
}}</includeonly>

Latest revision as of 07:43, 8 April 2025

Template:Documentation subpage The template link (or "tl") 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.

Examples

An example of its use is:

{{tl|Example}}
which generates
{{Example}}


TemplateData

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

ParameterDescriptionTypeStatus
template name1

positional parameter: the template name without the namespace prefix “Template:”, which is added automatically

Templaterequired

See also

  • {{tlx}} to produce a [t]emplate [l]ink with an e[x]panded number of parameters.