← Older edit
VisualWikitext
→Example: Remove incorrect description - hopefully someone else knows this template's purpose
Xeverything11 (talk | contribs)
Bureaucrats, Interface administrators, Administrators
399 edits
m 247 revisions imported from mhdev:Template:Template_link/doc
 
(89 intermediate revisions by 57 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
{{High-risk|2,500,000+}}
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOcodeOM OF THIS PAGE -->
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__


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 how the template name would be used in code. Its primary use is in instruction and documentation. A short example is that the code:
==Examples==
An example of its use is:


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


== TemplateData ==
<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": "string",
"type": "wiki-template-name",
    "required": true
"required": true
  }
}
}}</templatedata>
}
 
}</templatedata>
More complex variations are described below.
 
==Example==
{| class="wikitable"
! Code
! Result
! Notes
|-
| <code><nowiki>{{tl|Void}}</nowiki></code>
| {{[[Template:Void|Void]]}}
| Standard usage
|-
| <code><nowiki>{{tls|Void}}</nowiki></code>
| {{[[Wikipedia:Substitution|subst]]:[[Template:Void|Void]]}}
| 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>
|
|-
| <code><nowiki>{{tl2|SISTER=M:|3x}}</nowiki></code>
| <code><nowiki>{{</nowiki>[[{{{LANG|}}}M:{{ns:Template}}:3x|3x]]<nowiki>}}</nowiki></code>
| For templates on another Wikimedia project (such as meta)
|-
| <code><nowiki>{{tl2|SISTER=wikibooks|LANG=de:|WP}}</nowiki></code>
| <code><nowiki>{{</nowiki>[hcodep://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's other project
|-
| <code><nowiki>{{tl|1==)}}</nowiki></code>
| {{tl|1==)}}
| Use this format 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 | |
[[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.
Retrieved from "https://howto.skywiki.org/wiki/Template:Template_link/doc?oldid=624"
Retrieved from "https://howto.skywiki.org/wiki/Template:Template_link/doc?oldid=624"