Difference between revisions of "Template:Tl/doc"

Latest revision as of 15:12, 3 February 2009

This is a documentation subpage for Template:Tl (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

The template link template is a simple macro 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:

{{tl|example}}

generates

More complex variations are described below.

Related templates

{{tl2}} differs in that it displays an arguably clearer result like {{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}} displays with the same enhanced presentation, and also expands several 'placeholder' parameters to generate a sample template call.

Usage

 {{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.

Example

Code	Result
`{{Tl\|x0}}`	{{x0}}
`{{Tl2\|x1}}`	`{{x1}}`
`{{Tl2\|SISTER=M:\|3x}}`	`{{3x}}`
`{{Tl2\|SISTER=wikibooks\|LANG=de:\|WP}}`	`{{WP}}`

{{tl2}} – Template link, up to three parameters and interwiki links.
{{tlp}} – Template link, with single parameter.
{{tlx}} – Template link, up to three parameters and interwiki links.
{{tlsp}} – Template link, ditto subst'ed.
{{lts}} – See Lts discussion for more variants.
{{tlu}} – Like {{tl}} / {{tlp}} for any namespace.
{{tn}} – Same as tl, but shows the braces as part of the link.
{{evd}} – Show live example
{{tlc}}, {{tld}} and {{tlf}} – Template names without links.
Category:Internal link templates

@@ Line 1: / Line 1: @@
-<includeonly><span style="font-family:monospace;"><nowiki>{{</nowiki>{{#if:{{{subst|}}}|[[Help:Substitution|subst]]:}}[[{{{LANG|}}}{{{SISTER|}}}{{ns:Template}}:{{{1|}}}|{{{1|}}}]]<!--
+{{Documentation subpage}}
--->{{#if:{{{2|}}}|
+<includeonly>{{high-use| 600,000+ }}</includeonly>
-&#124;{{{2}}}
+<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
-}}<!--
+__NOTOC__
--->{{#if:{{{3|}}}|
-&#124;{{{3}}}
+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:
-}}<!--
--->{{#if:{{{4|}}}|
+::<code><nowiki>{{tl|example}}</nowiki></code>
-&#124;{{{4}}}
-}}<!--
+:generates
--->{{#if:{{{5|}}}|
-&#124;{{{5}}}
+::{{tl|example}}
-}}<!--
--->{{#if:{{{6|}}}|
+More complex variations are described below.
-&#124;{{{6}}}
-}}<!--
+=== Related templates ===
--->{{#if:{{{7|}}}|
-&#124;{{{7}}}
+{{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''.
-}}<!--
--->{{#if:{{{8|}}}|
+{{tlx|tlx}} displays with the same enhanced presentation, and also expands several 'placeholder' parameters to generate a sample template call.
-&#124;{{{8}}}
-}}<!--
+=== Usage ===
--->{{#if:{{{9|}}}|
-&#124;{{{9}}}
+<pre>
-}}<!--
+ {{Tl|template name to display}}
--->{{#if:{{{10|}}}|
+and
-&#124;{{{10}}}
+ {{Tl2|template name to display}} -- local link, just like Tl.
-}}<!--
+ or
--->{{#if:{{{11|}}}|
+ {{Tl2|SISTER=V:|template name to display}} -- displays a template on Wikiversity
-&#124;{{{11}}}
+ or
-}}<!--
+ {{Tl2|LANG=fr.|SISTER=wikisource|template name to display}} -- displays a template
--->{{#if:{{{12|}}}|
+                       on the French Wikisource sister project.
-&#124;''...''
+</pre>
-}}<nowiki>}}</nowiki></span></includeonly><noinclude>{{pp-template|small=yes}}{{documentation}}</noinclude>
+=== 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 ===
+* {{tl|tl2}} – Template link, up to three parameters and interwiki links.
+* {{tl|tlp}} – Template link, with single parameter.
+* {{tl|tlx}} – Template link, up to three parameters and interwiki links.
+* {{tl|tlsp}} – Template link, ditto subst'ed.
+* {{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|evd}} – Show live example
+* {{tl|tlc}}, {{tl|tld}} and {{tl|tlf}} – Template names without links.
+* [[: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]]
+[[da:Skabelon:Vis]]
+[[eo:Ŝablono:Ŝ]]
+[[es:Plantilla:Template link]]
+[[fa:الگو:الگوی]]
+[[fi:Malline:Malline]]
+[[fr:Modèle:M]]
+[[got:Template:Tl]]
+[[he:תבנית:תב]]
+[[ia:Patrono:Tl]]
+[[ja:Template:Tl]]
+[[ka:თარგი:Tl]]
+[[ko:틀:Tl]]
+[[kw:Template:Viz]]
+[[my:Template:Tl]]
+[[or:Template:Tl]]
+[[pa:ਨਮੂਨਾ:Tl]]
+[[pih:Template:Tl]]
+[[pl:Szablon:S]]
+[[pt:Predefinição:Link 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]]
+[[zh:Template:Tl]]
+[[zh-yue:Template:Tl]]
+</includeonly>

Difference between revisions of "Template:Tl/doc"

Latest revision as of 15:12, 3 February 2009

Related templates

Usage

Example

See also

Navigation menu

Search