Difference between revisions of "Template:Template-linking templates"
Jump to navigation
Jump to search
Template documentation
(→Other formatting templates: Add {{Elc}}) |
m (217 revisions imported) |
||
(61 intermediate revisions by 26 users not shown) | |||
Line 1: | Line 1: | ||
− | {{navbar|Template-linking templates| | + | <includeonly>{{navbar|Template-linking templates|text=These tables:|style=float: right;}}</includeonly> |
− | |||
− | |||
===General-purpose formatting=== | ===General-purpose formatting=== | ||
− | {| class="wikitable | + | {| class="wikitable plainrowheaders" |
− | | | + | |+ Comparison of template-linking templates according to the styles of generated text and link produced |
+ | |- style="background-color: #fee;" | ||
+ | ! scope="col" rowspan="2"| Text style ↓ | ||
+ | ! scope="col" rowspan="2"| {{tlx|tlg}} options{{NoteTag|name=TlTfn1}}<br />to achieve text style | ||
+ | ! scope="col" colspan="5"| Link style | ||
+ | |- style="background-color: #fee;" | ||
+ | !scope="col"| Linked | ||
+ | !scope="col"| Unlinked | ||
+ | !scope="col"| Linked with subst | ||
+ | !scope="col"| Linked including braces | ||
+ | !scope="col"| Linked with alternative text | ||
|- | |- | ||
− | ! | + | ! scope="row"| {{tlx|tlg}} options{{NoteTag|name=TlTfn1}}<br />to achieve link style |
− | + | | {{n/a}} | |
− | + | | {{n/a|DEFAULT}} | |
− | ! | + | | {{code|nolink{{=}}yes}} |
− | + | | {{code|subst{{=}}yes}} | |
− | + | | {{code|braceinside{{=}}yes}} | |
− | + | | {{code|alttext{{=}}Foo}}<br />{{code|2{{=}}Foo}} | |
+ | |- | ||
+ | ! scope="row"| normal | ||
+ | | {{n/a|DEFAULT}} | ||
+ | | {{nowrap|{{tlg|tlg}}}}{{NoteTag|name=TlTfn1}}<br />{{tl|tl}}<br />{{tlp|tlp|1|2|...}}{{NoteTag|name=TlTfn2}}<br />{{tlu|Template:tlu}}{{NoteTag|name=TlTfn3}} | ||
+ | | {{tlf|tlf}}{{NoteTag|name=TlTfn2}}<br /><sup><[[Template:Template link with link off|template link]]></sup> | ||
+ | | {{tls|tls}}<br />{{tlsp|tlsp|1|2|...}}<br />{{tlsu|Template:tlsu}}{{NoteTag|name=TlTfn3}} | ||
+ | | {{tn|tn}} | ||
+ | | {{tla|tla}} | ||
|- | |- | ||
− | ! | + | ! scope="row"| <code>code</code> |
− | + | | {{code|code{{=}}yes}} | |
− | |{{ | + | | {{tl2|tl2}}<br />{{tlx|tlx}}<br />{{tlxu|Template:tlxu}}<sup>3</sup>{{NoteTag|name=TlTfn3}} |
− | | | + | | {{tlc|tlc}}{{NoteTag|name=TlTfn2}}<br /><sup><[[Template:tlc|template link]]></sup><br />{{tnull|tnull}}<sup><[[Template:tnull|template link]]></sup> |
− | |{{ | + | | {{tlxs|tlxs}} |
− | + | | colspan="2" rowspan="3" {{n/a}} | |
− | |{{ | ||
|- | |- | ||
− | |style=" | + | ! scope="row"| <span style="font-family:monospace; font-size:larger;">monospace</span> |
− | + | | {{code|plaincode{{=}}yes}}{{NoteTag|name=TlTfn4}} | |
− | | {{ | + | | colspan="2" rowspan="2" {{n/a}} |
− | | | + | | rowspan="2"| {{tltss|tltss}}{{NoteTag|name=TlTfn5}} |
− | | {{ | ||
− | |||
− | |||
|- | |- | ||
− | ! | + | ! scope="row"| <kbd>kbd</kbd> |
− | | {{code| | + | | {{code|kbd{{=}}yes}}{{NoteTag||name=TlTfn5}} |
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
− | + | ! scope="row"| '''bold''' | |
| {{code|bold{{=}}yes}} | | {{code|bold{{=}}yes}} | ||
− | | {{ | + | | {{tlb|tlb}} |
− | | | + | | colspan="4" rowspan="3" {{n/a}} |
|- | |- | ||
− | + | ! scope="row"| '''<code>bold+code</code>''' | |
| {{code|bold{{=}}yes{{!}}code{{=}}yes}} | | {{code|bold{{=}}yes{{!}}code{{=}}yes}} | ||
− | | {{ | + | | {{tlxb|tlxb}} |
|- | |- | ||
− | + | ! scope="row"| ''<code>italic+code</code>'' | |
| {{code|italic{{=}}yes{{!}}code{{=}}yes}} | | {{code|italic{{=}}yes{{!}}code{{=}}yes}} | ||
− | | {{ | + | | {{tlxi|tlxi}} |
|} | |} | ||
+ | {{NoteFoot|refs= | ||
+ | {{NoteTag|name=TlTfn1|{{tlx|tlg}} is the most general template, allowing any combination of text style and/or link style options.}} | ||
+ | {{NoteTag|name=TlTfn2|Prevents wrapping of text by placing it inside {{tag|span|params=class="nowrap"}} tags.}} | ||
+ | {{NoteTag|name=TlTfn3|Allows links to templates in any namespace.}} | ||
+ | {{NoteTag|name=TlTfn4|{{tld|tlg|plaincode{{=}}yes}} uses [[HTML element#code|{{tag|code|params=style="border:none; background-color:transparent;"}}]].}} | ||
+ | {{NoteTag|name=TlTfn5|Displays monospaced font using {{tag|span|params=style="font-family:monospace;"}}.}} | ||
+ | }} | ||
{{clear}} | {{clear}} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
===Other formatting templates=== | ===Other formatting templates=== | ||
− | {| class="wikitable sortable" | + | {| class="wikitable sortable plainrowheaders" |
− | + | |+ Templates producing specialised formatting effects for given templates, modules or parameters | |
+ | !scope="col"| Code example | ||
+ | !scope="col"| Effect | ||
+ | !scope="col"| Notes | ||
|- | |- | ||
− | | {{tlx|tl2|<nowiki>Hatnote|lang=fr</nowiki>}} | + | !scope="row"| {{tlx|tl2|<nowiki>Hatnote|lang=fr</nowiki>}} |
+ | | {{tl2|hatnote|lang=fr}} || Supports linking to sister projects (e.g., fr:Hatnote) | ||
|- | |- | ||
− | | {{tlx|tlu|User:Ahunt/SSHFS}} | + | !scope="row"| {{tlx|tlu|User:Ahunt/SSHFS}} |
+ | | {{tlu|User:Ahunt/SSHFS}} || Supports linking to any namespace | ||
|- | |- | ||
− | | {{tlx|demo|<nowiki><nowiki>{{Hatnote|lang=fr|Some text}}</nowiki></nowiki>}} | + | !scope="row"| {{tlx|demo|<nowiki><nowiki>{{Hatnote|lang=fr|Some text}}</nowiki></nowiki>}} |
+ | | {{demo|<nowiki>{{hatnote|lang=fr|Some text}}</nowiki>}} || Shows code and example | ||
|- | |- | ||
− | | {{tlx|xpd|<nowiki>Hatnote|Some hatnote text</nowiki>}} | + | !scope="row"| {{tlx|xpd|<nowiki>Hatnote|Some hatnote text</nowiki>}} |
+ | | {{xpd|hatnote|Some hatnote text}} || Shows code, example and a link to expand the template code | ||
+ | |- | ||
+ | !scope="row"| {{tlx|tln|Hatnote}} | ||
+ | | {{tln|Hatnote}} || Produces a normal link to the template | ||
|- | |- | ||
<!-- Yes, I know these two aren't actually template-linking templates, but they're a heck of a lot easier to find if listed in the docs for e.g. {{tl}} --> | <!-- Yes, I know these two aren't actually template-linking templates, but they're a heck of a lot easier to find if listed in the docs for e.g. {{tl}} --> | ||
− | | {{tlx| | + | !scope="row"| {{tlx|elc|Template:Hatnote}}<br />{{tlx|elc|<nowiki>Template:Hatnote|Hatnote</nowiki>}} |
+ | | {{elc|Template:Hatnote}}<br />{{elc|<nowiki>Template:Hatnote|Hatnote</nowiki>}} || Formats wikilink, with optional piped link text and blended suffix | ||
|- | |- | ||
− | | {{tlx| | + | !scope="row"| {{tlx|ml|Example|hello}} |
+ | | {{ml|Example|hello}} || Counterpart to {{tl|tl}} for linking to Lua modules | ||
+ | |- | ||
+ | !scope="row"| {{tlx|mlx|Example|hello}} | ||
+ | | {{mlx|Example|hello}} || Counterpart to {{tl|tlx}} for linking to Lua modules | ||
+ | |- | ||
+ | !scope="row"| {{tlx|para|<nowiki>title|<var>book title</var></nowiki>}} | ||
+ | | {{para|title|<var>book title</var>}} || Formats template parameters for display, with or without values | ||
+ | |- | ||
+ | !scope="row"| {{tlx|sclx|LASTING}} | ||
+ | | {{sclx|LASTING}} || Takes a shortcut suffix in project namespace and displays it with brackets and the [[WP:ALIAS|WP: alias]] in a [[WP:CODE|{{tag|code}}]] tag. | ||
+ | |- | ||
+ | !scope="row"| {{tlx|tag|ref}}<br />{{tlx|xtag|templatedata}} | ||
+ | | {{tag|ref}}<br />{{xtag|templatedata}} || Formats [X]HTML tags; can add content, choose opening, closing, or self-closing | ||
+ | |- | ||
+ | !scope="row"| {{tlx|dtl|Ping project}} | ||
+ | | {{dtl|Ping project}} || Wikidata counterpart to {{tl|tl}} | ||
+ | |- | ||
+ | !scope="row"| {{tlx|pf|if}}<br />{{tlx|pf|if|<nowiki>{{{1}}}</nowiki>|true|false}} | ||
+ | | {{pf|if}}<br />{{pf|if|<nowiki>{{{1}}}</nowiki>|true|false}} || [[Help:Parser functions|Parser function]] equivalent to {{tl|tl}} | ||
|} | |} | ||
===With utility links=== | ===With utility links=== | ||
− | {| class="wikitable sortable" | + | {| class="wikitable sortable plainrowheaders" |
− | + | |+ Templates producing utility links for a given template ([[Template:Hatnote|Hatnote]] used here as example) | |
+ | !scope="col"| Code example | ||
+ | !scope="col"| Effect | ||
|- | |- | ||
− | | {{tlx| | + | !scope="row"| {{tlx|lt|Hatnote}} |
+ | | {{lt|hatnote}} | ||
|- | |- | ||
− | | {{tlx| | + | !scope="row"| {{tlx|lts|Hatnote}} |
+ | | {{lts|hatnote}} | ||
|- | |- | ||
− | | {{tlx| | + | !scope="row"| {{tlx|t links|Hatnote}} |
+ | | {{t links|hatnote}} | ||
|- | |- | ||
− | | {{tlx| | + | !scope="row"| {{tlx|tfd links|Hatnote}} |
+ | | {{tfd links|hatnote}} | ||
|- | |- | ||
− | | {{tlx| | + | !scope="row"| {{tlx|tetl|Hatnote}} |
+ | | {{tetl|Hatnote}} | ||
|- | |- | ||
− | | {{tlx| | + | !scope="row"| {{tlx|tsetl|Hatnote}} |
+ | | {{tsetl|Hatnote}} | ||
|- | |- | ||
− | | {{tlx| | + | !scope="row"| {{tlx|ti|Hatnote}} |
+ | | {{ti|Hatnote}} | ||
|- | |- | ||
− | | {{tlx| | + | !scope="row"| {{tlx|tic|Hatnote}} |
+ | | {{tic|Hatnote}} | ||
|- | |- | ||
− | | {{tlx| | + | !scope="row"| {{tlx|tim|Hatnote}} |
+ | | {{tim|Hatnote}} | ||
|- | |- | ||
− | | {{tlx|tiw|Hatnote}} | + | !scope="row"| {{tlx|tiw|Hatnote}} |
+ | | {{tiw|Hatnote}} | ||
|- | |- | ||
− | | {{tlx|tlt|Hatnote}} | + | !scope="row"| {{tlx|tlt|Hatnote}} |
+ | | {{tlt|Hatnote}} | ||
|- | |- | ||
− | | {{tlx|ttl|Hatnote}} | + | !scope="row"| {{tlx|ttl|Hatnote}} |
+ | | {{ttl|Hatnote}} | ||
|- | |- | ||
− | | {{tlx|twlh|Hatnote}} | + | !scope="row"| {{tlx|twlh|Hatnote}} |
− | |} | + | | {{twlh|Hatnote}} |
+ | |}<noinclude> | ||
+ | {{Documentation | ||
+ | | content = | ||
+ | {{template shortcut|tl-nav|tl templates}} | ||
+ | ==Usage== | ||
+ | Use this {{tl|Template-linking templates}} on /doc pages for related templates. | ||
+ | [[Category:Documentation see also templates]] | ||
+ | }}</noinclude> |
Latest revision as of 11:11, 22 September 2020
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=Foo 2=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}}
|
- ↑ Jump up to: 1.0 1.1 1.2
{{tlg}}
is the most general template, allowing any combination of text style and/or link style options. - ↑ Jump up to: 2.0 2.1 2.2 Prevents wrapping of text by placing it inside
<span class="nowrap">...</span>
tags. - ↑ Jump up to: 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>
. - ↑ Jump up to: 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) |

Usage
Use this {{Template-linking templates}} on /doc pages for related templates.
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Subpages of this template. |