|
|
| (137 intermediate revisions by 87 users not shown) |
| Line 1: |
Line 1: |
| {{Documentation subpage}} | | {{Documentation subpage}} |
| <includeonly>{{high-risk| 1,400,000+ }}</includeonly>
| | <!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). --> |
| <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM 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> |
| | :which generates |
| | ::{{tl|Example}} |
|
| |
|
| :generates
| |
|
| |
|
| ::{{Tl|Example}} | | == 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.", |
| | "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> |
|
| |
|
| More complex variations are described below.
| | == See also == |
|
| | * {{tl|tlx}} to produce a [t]emplate [l]ink with an e[x]panded number of parameters. |
| ===Related templates=== | | <includeonly>[[Category:link templates]]</includeonly> |
| {{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''.
| |
|
| |
| {{Tlx|Tlx}} displays with the same enhanced presentation, and also expands several 'placeholder' parameters to generate a sample template call. | |
| | |
| ===Usage===
| |
| <pre>
| |
| {{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.
| |
| {{Tl|1==)}} -- use 1= where the template name contains an equals sign (as [[template:=)]] does).
| |
| </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]]
| |
| ---->
| |
| |-
| |
| | <code><nowiki>{{Tl|1==)}}</nowiki></code>
| |
| | {{Tl|1==)}}
| |
| |}
| |
| | |
| ===See also===
| |
| *{{Tl|Tl2}} – Template link, up to three parameters and interwiki links.
| |
| *{{Tl|Tlp}} – Template link, with up to eight parameters.
| |
| *{{Tl|Tlx}} – Template link, up to three parameters and interwiki links, plus uses a non-proportional monospaced font.
| |
| *{{Tl|Tlsp}} – Template link, ditto subst'ed.
| |
| *{{Tl|Tlb}} Same as {{Tl|Tl}}, but gives the template name in boldface type (this can be useful when stressing the difference between two similarly named templates). The {{Tl|Tlxb}} variant is the same, except it uses a monospaced non-proportional font instead of regular text.
| |
| *{{Tl|Lts}} – See Lts discussion for more variants.
| |
| *{{Tl|Tlu}} – Like {{Tlx|Tl}} / {{Tlx|Tlp}} for any namespace.
| |
| *{{Tl|Tn}} – Same as tl, but shows the braces as part of the link.
| |
| *{{Tl|Tlc}}, {{Tl|Tld}} and {{Tl|Tlf}} – Template names without links.
| |
| *{{Tl|Tltt}} and {{Tl|Tltt2}} – Template link with tooltip, with no and one parameter respectively.
| |
| *{{Tl|Tlrow}} - For showing templates and their properties in a table
| |
| *{{Tl|Xpd}} – Show live (expanded) example.
| |
| | |
| *[[:Category:Internal link templates]]
| |
| | |
| <includeonly> | |
| <!-- ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE -->
| |
| [[Category:Typing-aid templates|{{PAGENAME}}]] | |
| [[Category:Internal link templates|{{PAGENAME}}]]
| |
| | |
| [[ar:قالب:قا]]
| |
| [[az:Şablon:ŞK]]
| |
| [[be-x-old:Шаблён:Ш]]
| |
| [[bg:Шаблон:Ш]]
| |
| [[ca:Plantilla:Tl]]
| |
| [[cs:Šablona:Šablona]]
| |
| [[cy:Nodyn:Nodyn]]
| |
| [[da:Skabelon:Vis]]
| |
| [[de:Vorlage:Vorlage]]
| |
| [[nv:Bee álnééhí:Tl]]
| |
| [[dsb:Pśedłoga:Pśedłoga]]
| |
| [[et:Mall:Malli näide]]
| |
| [[eo:Ŝablono:Ŝ]]
| |
| [[es:Plantilla:Enlace plantilla]]
| |
| [[eu:Txantiloi:Tx]]
| |
| [[fa:الگو:الگوی]]
| |
| [[fi:Malline:Malline]]
| |
| [[fr:Modèle:M]]
| |
| [[got:Template:Tl]]
| |
| [[hy:Կաղապար:Tl]]
| |
| [[he:תבנית:תב]]
| |
| [[hsb:Předłoha:Předłoha]]
| |
| [[ia:Patrono:Tl]]
| |
| [[it:Template:Tl]]
| |
| [[ja:Template:Tl]]
| |
| [[ka:თარგი:Tl]]
| |
| [[ko:틀:Tl]]
| |
| [[ku:Şablon:Tl]]
| |
| [[kw:Template:Viz]]
| |
| [[la:Formula:Fn]]
| |
| [[hu:Sablon:Sablonhivatkozás leírással]]
| |
| [[mk:Шаблон:Tl]]
| |
| [[my:Template:Tl]]
| |
| [[no:Mal:Mal]]
| |
| [[or:Template:Tl]]
| |
| [[pa:ਨਮੂਨਾ:Tl]]
| |
| [[pih:Template:Tl]]
| |
| [[pl:Szablon:S]]
| |
| [[pnt:Πρότυπον:Πρότυπον]]
| |
| [[pt:Predefinição:Ligação para predefinição]]
| |
| [[ro:Format:F]]
| |
| [[ru:Шаблон:Tl]]
| |
| [[sl:Predloga:Tl]]
| |
| [[sv:Mall:Mall]]
| |
| [[th:แม่แบบ:Tl]]
| |
| [[tr:Şablon:Tl]]
| |
| [[uk:Шаблон:Tl]]
| |
| [[vi:Tiêu bản:Tl]]
| |
| [[xal:Зура:Зура]]
| |
| [[zh:Template:Tl]]
| |
| [[zh-yue:Template:Tl]]
| |
| </includeonly> | |
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
Template parameters
| Parameter | Description | Type | Status |
|---|
| template name | 1 | positional parameter: the template name without the namespace prefix “Template:”, which is added automatically
| Template | required |
|---|
See also
- {{tlx}} to produce a [t]emplate [l]ink with an e[x]panded number of parameters.
