Difference between revisions of "Template:Tl/doc"
Jump to navigation
Jump to search
(←Blanked the page) |
blackwiki>Eyesnore 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
| This is a documentation subpage for Template:Tl. It contains usage information, categories and other content that is not part of the original template page. |
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
General-purpose formatting
| Text style ↓ | {{tlg}} options[note 1]to achieve text style |
Link style | ||||
|---|---|---|---|---|---|---|
| Linked | Unlinked | Linked with subst | Linked including braces | Linked with alternative text | ||
{{tlg}} options[note 1]to achieve link style |
N/A | DEFAULT | nolink=yes
|
subst=yes
|
braceinside=yes
|
alttext=Foo2=Foo
|
| normal | DEFAULT | {{tlg}}[note 1] {{tl}} {{tlp|1|2|...}}[note 2] {{Template:tlu}}[note 3] |
{{tlf}}[note 2] <template link> |
{{subst:tls}} {{subst:tlsp|1|2|...}} {{subst:Template:tlsu}}[note 3] |
{{tn}} | {{tla}} |
code
|
code=yes
|
{{tl2}}{{tlx}}{{Template:tlxu}}3[note 3]
|
{{tlc}}[note 2]<template link> {{tnull}}<template link>
|
{{subst:tlxs}}
|
N/A | |
| monospace | plaincode=yes[note 4]
|
N/A | {{subst:tltss}}[note 5] | |||
| kbd | kbd=yes[note 5]
| |||||
| bold | bold=yes
|
{{tlb}} | N/A | |||
bold+code
|
bold=yes|code=yes
|
{{tlxb}}
| ||||
italic+code
|
italic=yes|code=yes
|
{{tlxi}}
| ||||
- ↑ 1.0 1.1 1.2
{{tlg}}is the most general template, allowing any combination of text style and/or link style options. - ↑ 2.0 2.1 2.2 Prevents wrapping of text by placing it inside
<span class="nowrap">...</span>tags. - ↑ 3.0 3.1 3.2 Allows links to templates in any namespace.
- ↑
{{tlg|plaincode=yes}}uses<code style="border:none; background-color:transparent;">...</code>. - ↑ 5.0 5.1 Displays monospaced font using
<span style="font-family:monospace;">...</span>.
Other formatting templates
| Code example | Effect | Notes |
|---|---|---|
{{tl2|Hatnote|lang=fr}}
|
{{hatnote}} |
Supports linking to sister projects (e.g., fr:Hatnote) |
{{tlu|User:Ahunt/SSHFS}}
|
{{User:Ahunt/SSHFS}} | Supports linking to any namespace |
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}
|
{{hatnote|lang=fr|Some text}} |
Shows code and example |
{{xpd|Hatnote|Some hatnote text}}
|
"{{hatnote|Some hatnote text}}" gives "" [1] |
Shows code, example and a link to expand the template code |
{{tln|Hatnote}}
|
Template:Hatnote | Produces a normal link to the template |
{{elc|Template:Hatnote}}{{elc|Template:Hatnote|Hatnote}}
|
[[Template:Hatnote]][[Template:Hatnote|Hatnote]] |
Formats wikilink, with optional piped link text and blended suffix |
{{ml|Example|hello}}
|
{{#invoke:Example|hello}} | Counterpart to {{tl}} for linking to Lua modules |
{{mlx|Example|hello}}
|
{{#invoke:Example|hello}} |
Counterpart to {{tlx}} for linking to Lua modules |
{{para|title|<var>book title</var>}}
|
|title=book title |
Formats template parameters for display, with or without values |
{{sclx|LASTING}}
|
[[WP:LASTING]] |
Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a <code>...</code> tag.
|
{{tag|ref}}{{xtag|templatedata}}
|
<ref>...</ref><templatedata> |
Formats [X]HTML tags; can add content, choose opening, closing, or self-closing |
{{dtl|Ping project}}
|
{{d:Ping project}} | Wikidata counterpart to {{tl}} |
{{pf|if}}{{pf|if|{{{1}}}|true|false}}
|
{{#if}} {{#if:{{{1}}}|true|false}} |
Parser function equivalent to {{tl}} |
With utility links
| Code example | Effect |
|---|---|
{{lt|Hatnote}}
|
Template:Hatnote (edit | talk | history | links | watch | logs) |
{{lts|Hatnote}}
|
Template:Hatnote(edit talk links history) |
{{t links|Hatnote}}
|
Hatnote (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test) |
{{tfd links|Hatnote}}
|
Template:Hatnote (edit · talk · history · links · transclusions · logs · subpages · delete) |
{{tetl|Hatnote}}
|
{{Hatnote}} |
{{tsetl|Hatnote}}
|
{{subst:Hatnote}} |
{{ti|Hatnote}}
|
Template:Hatnote (talk⧼dot-separator⧽links⧼dot-separator⧽edit) |
{{tic|Hatnote}}
|
Template:Hatnote (talk links edit) |
{{tim|Hatnote}}
|
m:Template:Hatnote (backlinks edit) |
{{tiw|Hatnote}}
|
Template:Hatnote (backlinks edit) |
{{tlt|Hatnote}}
|
{{Hatnote}} (talk) |
{{ttl|Hatnote}}
|
{{Hatnote}} (t/l) |
{{twlh|Hatnote}}
|
Template:Hatnote (links, talk) |