Difference between revisions of "Template:Template link/doc"

From Yugipedia
Jump to: navigation, search
(New page: <includeonly>:''This template documentation is <!--- ----- ---->transcluded from Template:Tl/doc'' <!--- ----- ---->[<span class="plainlinks">[{{f...)
 
(→‎See also: rm redundant sortkey(s))
(One intermediate revision by one other user not shown)
Line 1: Line 1:
−
<includeonly>:''This template documentation is [[M:Meta:Template doc page pattern |<!---
+
{{Documentation subpage}}
−
-----
+
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
−
---->transcluded]] from [[Template:Tl/doc]]'' <!---
 
−
-----
 
−
---->[<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>
 +
 
 +
:generates
  
−
: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''.
+
::{{tl|example}}
 +
 
 +
More complex variations are described below.
 +
 +
=== Related templates ===
  
−
;related: {{Tl2|Tlx}} displays with the same enhanced presentation, and also expands several 'placeholder' parameters to generate a sample template call.
+
{{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''.
 
   
 
   
−
== Usage ==
+
{{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 42: Line 30:
 
  {{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).
 
</pre>
 
</pre>
  
−
== Example ==
+
=== Example ===
 +
 
 
{| class="wikitable"
 
{| class="wikitable"
 
! Code
 
! Code
Line 66: Line 56:
 
[[de:wikibooks:{{ns:template}}:WP |WP]]
 
[[de:wikibooks:{{ns:template}}:WP |WP]]
 
---->
 
---->
 +
|-
 +
| <code><nowiki>{{tl|1==)}}</nowiki></code>
 +
| {{tl|1==)}}
 
|}
 
|}
  
−
== See also ==
+
=== 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.
+
* {{tl|tl2}} – Template link, up to three parameters and interwiki links.
−
* {{tiw|tlp}} &nbsp;&mdash; Template link, with single parameter.
+
* {{tl|tlp}} – Template link, with up to eight parameters.
−
* {{tiw|tlx}} &nbsp;&mdash; Template link, up to three parameters.
+
* {{tl|tlx}} – Template link, up to three parameters and interwiki links, plus uses a non-proportional monospaced font.
−
* {{tiw|tlsp}} &mdash; Template link, ditto subst'ed.
+
* {{tl|tlsp}} – Template link, ditto subst'ed.
−
* {{tiw|lts}} &nbsp;&mdash; see Lts discussion for more variants.
+
* {{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.
−
* {{tiw|tlu}} - like {{tlx|tl}} / {{tlx|tlp}} for any namespace.
+
* {{tl|lts}} – See Lts discussion for more variants.
−
* {{tiw|tn}} - Same as tl, but shows the braces as part of the link.
+
* {{tl|tlu}} – Like {{tlx|tl}} / {{tlx|tlp}} for any namespace.
−
* {{Lcs|Internal link templates}}
+
* {{tl|tn}} – Same as tl, but shows the braces as part of the link.
−
* {{tiw|evd}} - Show live example
+
* {{tl|evd}} – Show live example
 +
* {{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
 +
* [[:Category:Internal link templates]]
 +
 
 +
<includeonly>
 +
<!-- ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE -->
 +
[[Category:Typing-aid templates]]
 +
[[Category:Internal link templates]]
 +
</includeonly>

Revision as of 16:12, 15 February 2015


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.
 {{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://yugipedia.com/index.php?title=Template:Template_link/doc&oldid=967116"