Template:Template link/doc: Difference between revisions

From Space Station 14 Wiki
Template:Template link/doc
m (1 revision imported)
Tag: New redirect
 
Line 1: Line 1:
{{Documentation subpage}}
#REDIRECT [[Wikipedia:Template:Template link/doc]]
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
{{redirect-distinguish|Template:TI|Template:Ti}}{{Template shortcut|tl|t}}
{{#ifeq:{{FULLPAGENAME}} | Template:Template link | {{used in system}} }}
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 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:  and  are not interchangeable.
 
'''{{tl|Tla}}''' works exactly like {{tl|tl}} with the addition of optionally displaying '''a'''lternative label text (link label).  '''{{tl|tlg}}''' can include the use of parameters in the template (as  <nowiki>{{{1}}}</nowiki>).
 
==Examples==
A short example of its use is:
 
::<code><nowiki>{{tl|Example}}</nowiki></code>
:which generates
::{{tl|Example}}
 
Other longer examples:
 
{| class="wikitable"
! Code
! Result
! Notes
|-
| {{tlx|tl|Void}}
| {{tl|Void}}
| Standard usage
|-
| {{tlx|tls|Example}}
| {{tls|Example}}
| For templates that should be [[Wikipedia:Substitution|substituted]]
|-
| {{tlx|tl2|X1}}
| {{tl2|X1}}
| This formats the link to show how it would look in code (i.e., monospace font)
|-
| {{tlx|tl2|sister{{=}}M:|3x}}
| <code><nowiki>{{</nowiki>[[{{{LANG|}}}M:{{ns:Template}}:3x|3x]]<nowiki>}}</nowiki></code>
| Same as above, for templates on another Wikimedia project (in this example, Meta, using '''<code>m:</code>'''). See [[Help:Interwiki_linking#Prefix_codes_for_linking_to_Wikimedia_sister_projects|Interwiki codes]].
|-
| {{tlx|tl2|sister{{=}}wikibooks|lang{{=}}de:|WP}}
| <code><nowiki>{{</nowiki>[http://de.wikibooks.org/wiki/Vorlage:WP WP]<nowiki>}}</nowiki></code><!--
––––– 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]]
-->
| For templates on another language project
|-
| {{tlx|tl|<nowiki>1==</nowiki>)}}
| {{tl|1==)}}
| Use the format <code><nowiki>{{tl|1=templatename}}</nowiki></code> if the template contains template coding characters such as {{tl|1==)}} or {{tl|1=!}}
|}
 
== TemplateData ==
{{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": "positional parameter: the template name without the namespace prefix “Template:”, which is added automatically",
"type": "wiki-template-name",
"required": true
}
}
}</templatedata>
 
== See also ==
* {{tiw|tl2}}
* {{tiw|tl}}
* {{tiw|tlp}} to produce a [t]emplate [l]ink with single [p]arameter.
* {{tiw|tlx}} to produce a [t]emplate [l]ink with e[x]panded number of parameters.
* {{tiw|tlsp}} to produce a [t]emplate [l]ink that's [[Wikipedia:Substitution|[s]ubst:]]ituted, with a single [p]arameter.
* {{tiw|lts}}
* {{tiw|tlu}}, tl or tlp in any [[Wikipedia:Namespaces|namespace]].
* {{lcs|Internal template-link templates}}
* {{tiw|xpd}} to e[xp]an[d] (i.e. demonstrate) a template ''in situ''.
* {{tiw|tl-r}} to produce a [t]emplate [l]ink to a template [r]edirect.
{{Template-linking templates}}
 
<includeonly>{{Sandbox other||
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
[[Category:Internal template-link templates]]
}}</includeonly>

Latest revision as of 22:42, 20 February 2022