Template:Tl/doc

Revision as of 22:04, 18 February 2020 by Zacharycook505-104668625857976836193 (Talk | contribs) (Created page with "{{Documentation subpage}} <!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: Wikipedia:Wikidata). --> {{redirect-d...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Revision as of 22:04, 18 February 2020 by Zacharycook505-104668625857976836193 (Talk | contribs) (Created page with "{{Documentation subpage}} <!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: Wikipedia:Wikidata). --> {{redirect-d...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Template:Redirect-distinguish

The template link 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. Note that this template may be used under the name "tee-el" (tl) as well as "tee-one" (t1)— both function the same way and produce the same results (this is not true for all such visually confusing templates containing a possible 1/l mix-up: {{Tla}} and {{T1a}} are not interchangeable). A short example of its use is:

{{tl|Example}}
which generates
{{Example}}

TemplateData

Template:TemplateData header <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": "the template name without the namespace prefix “Template:”, which is added automatically",
   "type": "line",
   "required": true
 }

}}</templatedata>

More complex variations are described below.

Examples

Code Result Notes
{{tl|Void}} {{Void}} Standard usage
{{tls|Example}} {{subst:Example}} For templates that should be substituted
{{tl2|X1}} {{X1}} This formats the link to show how it would look in code (i.e., monospace font)
{{tl2|sister=M:|3x}} {{3x}} Same as above, for templates on another Wikimedia project (in this example, Meta)
{{tl2|sister=wikibooks|lang=de:|WP}} {{WP}} For templates on another language project
{{tl|1==)}} {{=)}} Use the format {{tl|1=templatename}} if the template contains template coding characters such as {{=)}} or {{!}}

See also

Template:Template-linking templates