Difference between revisions of "Template:Tl/doc"

From Arkaz
Jump to: navigation, search
(New page: <includeonly>:''This template documentation is <!--- ----- ---->transcluded from Template:Tl/doc'' <!--- ----- ---->[<span class="plainlinks">[{{f...)
 
 
Line 1: Line 1:
−
<includeonly>:''This template documentation is [[M:Meta:Template doc page pattern |<!---
+
{{Documentation subpage}}
−
-----
+
<includeonly>{{high-risk| 700,000+ }}</includeonly>
−
---->transcluded]] from [[Template:Tl/doc]]'' <!---
+
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
−
-----
 
−
---->[<span class="plainlinks">[{{fullurl:Template:Tl/doc|action=edit}} <!---
 
−
-----
 
−
----> edit usage]</span>]<!---
 
−
-----
 
−
---->{{#ifeq:{{SITENAME}}|Meta|<!--- then do nothing ---->|<!---
 
−
----- otherwise ---->[<span class="plainlinks">[{{fullurl:M:Template:Tl/doc|action=edit}} <!---
 
−
-----
 
−
----> edit Master usage]</span>]}}<!---
 
−
-----
 
−
----></includeonly><!---
 
−
-----
 
−
----><noinclude><!---
 
−
-----
 
−
---->
 
−
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE ----><!---
 
−
-----
 
−
---->
 
−
{{Interwikitmp-grp|V=D|cat=|Tl/doc|{{PAGENAME}}}}</noinclude>
 
 
__NOTOC__
 
__NOTOC__
−
==Documentation==
 
  
−
{{Tlx|Tl}} and {{Tl|Tl2}} are simple [[w:macro|macro]] [[m:Help:template|templates]] used to display a template name as a link. '''Tl''' stands for '''T'''emplate '''l'''ink.  
+
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:
 +
 
 +
::<code><nowiki>{{tl|example}}</nowiki></code>
  
−
:Tl2 differs in that it displays an arguably clearer result like {{[[Template:Tlx|Tlx]]}}, and also like 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''.
+
:generates
  
−
;related: {{Tl2|Tlx}} displays with the same enhanced presentation, and also expands several 'placeholder' parameters to generate a sample template call.
+
::{{tl|example}}
 +
 
 +
More complex variations are described below.
 
   
 
   
−
== Usage ==
+
=== 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''.
 +
 +
{{tlx|tlx}} displays with the same enhanced presentation, and also expands several 'placeholder' parameters to generate a sample template call.
 +
 
 +
=== Usage ===
  
 
<pre>
 
<pre>
−
 
 
  {{Tl|template name to display}}
 
  {{Tl|template name to display}}
 
and
 
and
Line 44: Line 33:
 
</pre>
 
</pre>
  
−
== Example ==
+
=== Example ===
 +
 
 
{| class="wikitable"
 
{| class="wikitable"
 
! Code
 
! Code
Line 68: Line 58:
 
|}
 
|}
  
−
== See also ==
+
=== See also ===
−
* {{Ltswpd|tl}}&nbsp; &nbsp;&mdash; links and edit history of the Tl template.
+
 
−
* {{Ltswpd|tl2}} &nbsp;&mdash; links and edit history of the Tl2 template.
+
* {{tl|tl2}} – Template link, up to three parameters and interwiki links.
−
* {{Ltswpd|tlp}} &nbsp;&mdash; Template link, with single parameter.
+
* {{tl|tlp}} – Template link, with single parameter.
−
* {{Ltswpd|tlx}} &nbsp;&mdash; Template link, up to three parameters.
+
* {{tl|tlx}} – Template link, up to three parameters and interwiki links.
−
* {{Ltswpd|tlsp}} &mdash; Template link, ditto subst'ed.
+
* {{tl|tlsp}} – Template link, ditto subst'ed.
−
* {{Ltswpd|lts}} &nbsp;&mdash; see Lts discussion for more variants.
+
* {{tl|lts}} – See Lts discussion for more variants.
−
* {{Ltswpd|tlu}} - like {{tlx|tl}} / {{tlx|tlp}} for any namespace.
+
* {{tl|tlu}} – Like {{tlx|tl}} / {{tlx|tlp}} for any namespace.
−
* {{Ltswpd|tn}} - Same as tl, but shows the braces as part of the link.
+
* {{tl|tn}} – Same as tl, but shows the braces as part of the link.
−
* {{Lcs|Internal link templates}}
+
* {{tl|evd}} – Show live example
 +
* {{tl|tlc}}, {{tl|tld}} and {{tl|tlf}} – Template names without links.
 +
* [[:Category:Internal link templates]]
  
−
<includeonly><!--- Categories for calling templates below this line -----
+
<includeonly>
−
-----
+
<!-- ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE -->
−
---->
+
[[Category:Typing-aid templates|{{PAGENAME}}]]
−
{{#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:Internal link templates|{{PAGENAME}}]]
−
[[Category:Typing-aid templates|{{PAGENAME}}]]
+
 
 +
</includeonly>

Latest revision as of 11:29, 9 March 2009

40px 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
{{example}}

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}}

See also

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


Retrieved from "http://www.arkaz.org/lore/index.php?title=Template:Tl/doc&oldid=2205"