Worked over the introduction, will do the rest soon.
Xeverything11 (talk | contribs)
m 247 revisions imported from mhdev:Template:Template_link/doc
 
(187 intermediate revisions by more than 100 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
__NOTOC__
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.  
This is the {{tl|tl}} template.


First a short example. This code: <code><nowiki>{{tl|example}}</nowiki></code> renders like this: {{tl|example}}
==Examples==
An example of its use is:


'''Tl''' stands for '''T'''emplate '''l'''ink. {{tl|tl}} 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.
::<code><nowiki>{{tl|Example}}</nowiki></code>
:which generates
::{{tl|Example}}


=== Related templates ===


{{tl2|tl2}} differs in that it displays an arguably clearer result like {{tlx|tlx}}, and also takes the named parameters 'SISTER=xx' and 'LANG=ll', so that it may also be used to ''list and link to templates on other English and non-English language sister projects''.
== TemplateData ==
<templatedata>{
{{tlx|tlx}} displays with the same enhanced presentation, and also expands several 'placeholder' parameters to generate a sample template call.
"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
}
}
}</templatedata>


=== Usage ===
== See also ==
 
* {{tl|tlx}} to produce a [t]emplate [l]ink with an e[x]panded number of parameters.
<pre>
<includeonly>[[Category:link templates]]</includeonly>
{{Tl|template name to display}}
and
{{Tl2|template name to display}} -- local link, just like Tl.
or
{{Tl2|SISTER=V:|template name to display}} -- displays a template on Wikiversity
or
{{Tl2|LANG=fr.|SISTER=wikisource|template name to display}} -- displays a template
                      on the French Wikisource sister project.
</pre>
 
=== Example ===
 
{| class="wikitable"
! Code
! Result
|-
| <code><nowiki>{{Tl|x0}}</nowiki></code>
| {{[[Template:X0|x0]]}}
|-
| <code><nowiki>{{Tl2|x1}}</nowiki></code>
| <tt><nowiki>{{</nowiki>[[{{{LANG|}}}{{{SISTER|}}}{{ns:Template}}:x1|x1]]<nowiki>}}</nowiki></tt>
|-
| <code><nowiki>{{Tl2|SISTER=M:|3x}}</nowiki></code>
| <tt><nowiki>{{</nowiki>[[{{{LANG|}}}M:{{ns:Template}}:3x|3x]]<nowiki>}}</nowiki></tt>
|-
| <code><nowiki>{{Tl2|SISTER=wikibooks|LANG=de:|WP}}</nowiki></code>
| <tt><nowiki>{{</nowiki>[http://de.wikibooks.org/wiki/Vorlage:WP WP]<nowiki>}}</nowiki></tt><!---
----- 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]]
---->
|}
 
=== See also ===
 
* {{tiw|tl}}&nbsp; &nbsp;&mdash; links and edit history of the Tl template.
* {{tiw|tl2}} &nbsp;&mdash; links and edit history of the Tl2 template.
* {{tiw|tlp}} &nbsp;&mdash; Template link, with single parameter.
* {{tiw|tlx}} &nbsp;&mdash; Template link, up to three parameters.
* {{tiw|tlsp}} &mdash; Template link, ditto subst'ed.
* {{tiw|lts}} &nbsp;&mdash; see Lts discussion for more variants.
* {{tiw|tlu}} - like {{tlx|tl}} / {{tlx|tlp}} for any namespace.
* {{tiw|tn}} - Same as tl, but shows the braces as part of the link.
* {{Lcs|Internal link templates}}
* {{tiw|evd}} - Show live example
 
<includeonly><!--- Categories for calling templates below this line -----
-----
---->
{{#ifeq:{{PAGENAME}}|Tl|{{interwikitmp-grp|V=1 |Tl }}}}
{{#ifeq:{{PAGENAME}}|Tl2|{{interwikitmp-grp|V=6|cat=|Tl2}}[[Category:Interwiki link templates|Tl2]]}}
<!-- ADD CATEGORIES for calling templates BELOW THIS LINE -->
[[Category:Internal link templates|{{PAGENAME}}]]
[[Category:Typing-aid templates|{{PAGENAME}}]]
<!--- ------------------------------------------------------------------------------ -----
----- ADD INTERWIKIS BELOW THIS LINE By calling templates or this page's interwiki's -----
---->
{{#ifeq:{{PAGENAME}}|Tl|<!--- ADD INTERWIKIS BELOW THIS LINE for 'Tl' -----
----->
[[ar:قالب:قا]] &nbsp;
[[az:Şablon:ŞK]] &nbsp;
[[bg:Шаблон:Ш]] &nbsp;
[[ca:Plantilla:Tl]] &nbsp;
[[cs:Šablona:Šablona]] &nbsp;
[[da:Skabelon:Vis]]
[[eo:Ŝablono:Ŝ]] &nbsp;
[[es:Plantilla:Template link]] &nbsp;
[[fa:الگو:الگوی]] &nbsp;
[[fi:Malline:Malline]] &nbsp;
[[fr:Modèle:M]] &nbsp;
[[he:תבנית:תב]] &nbsp;
[[ia:Patrono:Tl]] &nbsp;
[[ja:Template:Tl]] &nbsp;
[[ka:თარგი:Tl]] &nbsp;
[[ko:틀:Tl]] &nbsp;
[[kw:Template:Viz]] &nbsp;
[[my:Template:Tl]] &nbsp;
[[or:Template:Tl]] &nbsp;
[[pih:Template:Tl]] &nbsp;
[[pl:Szablon:S]] &nbsp;
[[pt:Predefinição:Link para predefinição]] &nbsp;
[[ru:Шаблон:Tl]] &nbsp;
[[sl:Predloga:Tl]] &nbsp;
[[sv:Mall:Mall]] &nbsp;
[[th:แม่แบบ:Tl]] &nbsp;
[[tr:Şablon:Tl]] &nbsp;
[[uk:Шаблон:Tl]] &nbsp;
[[vi:Tiêu bản:Tl]] &nbsp;
[[zh:Template:Tl]] &nbsp;
[[zh-yue:Template:Tl]] &nbsp;
 
<!-- ADD INTERWIKIS ABOVE THIS LINE for 'TL' -->
}}<!---
----- --------------------------------------------- -----
----><!--- ADD INTERWIKIS BELOW THIS LINE for 'Tl2' -----
-----
-----
---->{{#ifeq:{{PAGENAME}}|Tl2|
[[az:Şablon:ŞK2]] &nbsp;
[[bg:Шаблон:Ш2]] &nbsp;
[[ca:Plantilla:Tl2]] &nbsp;
[[cs:Šablona:Šablona2]] &nbsp;
[[eo:Ŝablono:Ŝ2]] &nbsp;
[[es:Plantilla:Template link2]] &nbsp;
[[fa:الگو:الگوی]] &nbsp;
[[fi:Malline:Malline2]] &nbsp;
[[fr:Modèle:M2]] &nbsp;
[[he:תבנית:תב]] &nbsp;
[[ia:Patrono:Tl2]] &nbsp;
[[ka:თარგი:Tl2]] &nbsp;
[[ko:틀:Tl2]] &nbsp;
[[kw:Template:Viz2]] &nbsp;
[[my:Template:Tl]] &nbsp;
[[or:Template:Tl2]] &nbsp;
[[pih:Template:Tl2]] &nbsp;
[[pl:Szablon:S2]] &nbsp;
[[pt:Predefinição:Link para predefinição2]] &nbsp;
[[ru:Шаблон:Tl2]] &nbsp;
[[sl:Predloga:Tl2]] &nbsp;
[[sv:Mall:Mall2]] &nbsp;
[[th:แม่แบบ:Tl2]] &nbsp;
[[uk:Шаблон:Tl2]] &nbsp;
[[vi:Tiêu bản:Tl2]] &nbsp;
[[zh:Template:Tl2]] &nbsp;
[[zh-yue:Template:Tl2]] &nbsp;
}}
</includeonly><!---
-----
----><noinclude><!---
----- ----- ADD Interwiki's BELOW this line for this 'Tl/doc page', not the working templates ----
---->{{WPTSP loose ends}}
[[bg:Шаблон:Ш/документация]]
[[de:Vorlage:Tl]] &nbsp;
[[eo:Ŝablono:Ŝ2/doc]] &nbsp;
[[es:Plantilla:Template link/doc]] &nbsp;
[[fa:الگو:الگوی/doc]] &nbsp;
[[fi:Malline:Malline/doc]] &nbsp;
[[fr:Modèle:M/doc]] &nbsp;
[[he:תבנית:תב/doc]] &nbsp;
[[ia:Patrono:Tl/doc]] &nbsp;
[[ja:Template:Tl/doc]] &nbsp;
[[ka:თარგი:Tl/doc]] &nbsp;
[[kw:Template:Viz/doc]] &nbsp;
[[or:Template:Tl/doc]] &nbsp;
<!--- ----- ADD Interwiki's ABOVE this line for this 'Tl/doc page', not the working templates ----
-----
----></noinclude>

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.