← Older editNewer edit →
VisualWikitext
m update transclusion count
No edit summary
Line 6: Line 6:
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:
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>
::<code><nowiki>{{Tl|Example}}</nowiki></code>


:generates
:generates


::{{tl|example}}
::{{Tl|Example}}


More complex variations are described below.
More complex variations are described below.
   
   
=== Related templates ===
===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''.
{{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.
{{Tlx|Tlx}} displays with the same enhanced presentation, and also expands several 'placeholder' parameters to generate a sample template call.
 
=== Usage ===


===Usage===
<pre>
<pre>
  {{Tl|template name to display}}
  {{Tl|Template name to display}}
and
and
  {{Tl2|template name to display}} -- local link, just like Tl.
  {{Tl2|Template name to display}} -- local link, just like Tl.
  or
  or
  {{Tl2|SISTER=V:|template name to display}} -- displays a template on Wikiversity
  {{Tl2|SISTER=V:|Template name to display}} -- displays a template on Wikiversity
  or
  or
  {{Tl2|LANG=fr.|SISTER=wikisource|template name to display}} -- displays a template  
  {{Tl2|LANG=fr.|SISTER=wikisource|Template name to display}} -- displays a template  
                       on the French Wikisource sister project.
                       on the French Wikisource sister project.
  {{tl|1==)}} -- use 1= where the template name contains an equals sign (as [[template:=)]] does).
  {{Tl|1==)}} -- use 1= where the template name contains an equals sign (as [[template:=)]] does).
</pre>
</pre>


=== Example ===
===Example===
 
{| class="wikitable"
{| class="wikitable"
! Code
! Code
! Result
! Result
|-
|-
| <code><nowiki>{{Tl|x0}}</nowiki></code>
| <code><nowiki>{{Tl|X0}}</nowiki></code>
| {{[[Template:X0|x0]]}}
| {{[[Template:X0|X0]]}}
|-
|-
| <code><nowiki>{{Tl2|x1}}</nowiki></code>
| <code><nowiki>{{Tl2|X1}}</nowiki></code>
| <tt><nowiki>{{</nowiki>[[{{{LANG|}}}{{{SISTER|}}}{{ns:Template}}:x1|x1]]<nowiki>}}</nowiki></tt>
| <tt><nowiki>{{</nowiki>[[{{{LANG|}}}{{{SISTER|}}}{{ns:Template}}:X1|X1]]<nowiki>}}</nowiki></tt>
|-
|-
| <code><nowiki>{{Tl2|SISTER=M:|3x}}</nowiki></code>
| <code><nowiki>{{Tl2|SISTER=M:|3x}}</nowiki></code>
Line 54: Line 51:
----- per this plan, then this /doc file fixed up to match whatever the correct syntax actually is.
----- per this plan, then this /doc file fixed up to match whatever the correct syntax actually is.
----- ALMOST work:  
----- ALMOST work:  
[[:de:wikibooks:{{ns:template}}:WP |WP]]
[[:de:wikibooks:{{ns:template}}:WP|WP]]
[[de:wikibooks:{{ns:template}}:WP |WP]]
[[de:wikibooks:{{ns:template}}:WP|WP]]
---->
---->
|-
|-
| <code><nowiki>{{tl|1==)}}</nowiki></code>
| <code><nowiki>{{Tl|1==)}}</nowiki></code>
| {{tl|1==)}}
| {{Tl|1==)}}
|}
|}


=== See also ===
===See also===
 
*{{Tl|Tl2}} – Template link, up to three parameters and interwiki links.
* {{tl|tl2}} – Template link, up to three parameters and interwiki links.
*{{Tl|Tlp}} – Template link, with up to eight parameters.
* {{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|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|tlsp}} – Template link, ditto subst'ed.
*{{Tl|Tlb}} &nbsp; 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|tlb}} &nbsp; 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|lts}} – See Lts discussion for more variants.
*{{Tl|Tlu}} – Like {{Tlx|Tl}} / {{Tlx|Tlp}} for any namespace.
* {{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|tn}} – Same as tl, but shows the braces as part of the link.
*{{Tl|Evd}} – Show live example
* {{tl|evd}} – Show live example
*{{Tl|Tlc}}, {{Tl|Tld}} and {{Tl|Tlf}} – Template names without links.
* {{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|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|tlrow}} - For showing templates and their properties in a table
*[[:Category:Internal link templates]]
* [[:Category:Internal link templates]]


<includeonly>
<includeonly>

Revision as of 12:30, 5 August 2010

Template:Documentation subpage


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

Template: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.
 {{Tl|1==)}} -- use 1= where the template name contains an equals sign (as [[template:=)]] does).

Example

Code Result
{{Tl|X0}} {{X0}}
{{Tl2|X1}} {{X1}}
{{Tl2|SISTER=M:|3x}} {{3x}}
{{Tl2|SISTER=wikibooks|LANG=de:|WP}} {{WP}}
{{Tl|1==)}} {{=)}}

See also

  • {{Tl2}} – Template link, up to three parameters and interwiki links.
  • {{Tlp}} – Template link, with up to eight parameters.
  • {{Tlx}} – Template link, up to three parameters and interwiki links, plus uses a non-proportional monospaced font.
  • {{Tlsp}} – Template link, ditto subst'ed.
  • {{Tlb}}   Same as {{Tl}}, but gives the template name in boldface type (this can be useful when stressing the difference between two similarly named templates). The {{Tlxb}} variant is the same, except it uses a monospaced non-proportional font instead of regular text.
  • {{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.
  • {{Tltt}} and {{Tltt2}} – Template link with tooltip, with no and one parameter respectively.
  • {{Tlrow}} - For showing templates and their properties in a table
  • Category:Internal link templates


Retrieved from "https://howto.skywiki.org/wiki/Template:Template_link/doc?oldid=478"
Retrieved from "https://howto.skywiki.org/wiki/Template:Template_link/doc?oldid=478"