Template:Template link/doc: Difference between revisions
Page last edited 3 weeks ago by Xeverything11
←Blanked the page |
m Reverted edits by 66.87.64.63 (talk): Unexplained blanking of page (HG) (3.1.21) |
||
Line 1: | Line 1: | ||
{{Documentation subpage}} | |||
{{#ifeq:{{FULLPAGENAME}} | Template:Tl | {{High-risk|3320000+}} }} | |||
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE --> | |||
__NOTOC__ | |||
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: | |||
::<code><nowiki>{{tl|Example}}</nowiki></code> | |||
:which generates | |||
::{{tl|Example}} | |||
<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. | |||
==Example== | |||
{| class="wikitable" | |||
! Code | |||
! Result | |||
! Notes | |||
|- | |||
| <code><nowiki>{{tl|Void}}</nowiki></code> | |||
| {{[[Template:Void|Void]]}} | |||
| Standard usage | |||
|- | |||
| <code><nowiki>{{tls|Void}}</nowiki></code> | |||
| {{[[Wikipedia:Substitution|subst]]:[[Template:Example|Example]]}} | |||
| For templates that should be [[Wikipedia:Substitution|substituted]] | |||
|- | |||
| <code><nowiki>{{tl2|X1}}</nowiki></code> | |||
| <code><nowiki>{{</nowiki>[[{{{LANG|}}}{{{SISTER|}}}{{ns:Template}}:X1|X1]]<nowiki>}}</nowiki></code> | |||
| This formats the link to show how it would look in code | |||
|- | |||
| <code><nowiki>{{tl2|SISTER=M:|3x}}</nowiki></code> | |||
| <code><nowiki>{{</nowiki>[[{{{LANG|}}}M:{{ns:Template}}:3x|3x]]<nowiki>}}</nowiki></code> | |||
| Same as above, for templates on another Wikimedia project (such as meta) | |||
|- | |||
| <code><nowiki>{{tl2|SISTER=wikibooks|LANG=de:|WP}}</nowiki></code> | |||
| <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 | |||
|- | |||
| <code><nowiki>{{tl|1==)}}</nowiki></code> | |||
| {{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=!}} | |||
|} | |||
== See also == | |||
{{Template-linking templates}} | |||
<includeonly> | |||
{{#ifeq:{{SUBPAGENAME}}|sandbox | | | |||
[[Category:Internal template-link templates]] | |||
}} | |||
</includeonly> |
Revision as of 02:38, 1 August 2016
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:
{{tl|Example}}
- which generates
- {{Example}}
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.
Parameter | Description | Type | Status | |
---|---|---|---|---|
template name | 1 | the template name without the namespace prefix “Template:”, which is added automatically | Line | required |
More complex variations are described below.
Example
Code | Result | Notes |
---|---|---|
{{tl|Void}}
|
{{Void}} | Standard usage |
{{tls|Void}}
|
{{subst:Example}} | For templates that should be substituted |
{{tl2|X1}}
|
{{X1}}
|
This formats the link to show how it would look in code |
{{tl2|SISTER=M:|3x}}
|
{{3x}}
|
Same as above, for templates on another Wikimedia project (such as 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