Template:Template-linking templates: Difference between revisions
Appearance
m 1 revision imported |
m 1 revision imported |
||
| (One intermediate revision by one other user 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 === | |||
<div style="overflow-x: auto; margin: 1em 0;"> | |||
===General-purpose formatting=== | {| class="wikitable plainrowheaders" style="margin: 0;" | ||
{| class="wikitable | |+ Comparison of template-linking templates according to the styles of generated text and link produced | ||
|+ Comparison of template-linking templates according to | |- style="background-color: #fee;" | ||
! scope="col" rowspan="2"| Text style ↓ | |||
! scope="col" rowspan="2"| {{Template link expanded|tlg}} options{{NoteTag|name=TlTfn1}}<br />to achieve text style | |||
! scope="col" colspan="6"| Link style | |||
|- style="background-color: #fee;" | |||
! scope="col"| Linked | |||
! scope="col"| Unlinked | |||
! scope="col"| Linked with subst | |||
! scope="col"| Unlinked with subst | |||
! scope="col"| Linked including braces | |||
! scope="col"| Linked with alternative text | |||
|- | |- | ||
! | ! scope="row"| {{Template link expanded|tlg}} options{{NoteTag|name=TlTfn1}}<br />to achieve link style | ||
| {{n/a}} | | {{n/a}} | ||
| {{n/a|DEFAULT}} | |||
| {{code|nolink{{=}}yes}} | | {{code|nolink{{=}}yes}} | ||
| {{code|subst{{=}}yes}} | | {{code|subst{{=}}yes}} | ||
|| <code>nolink=yes<wbr/>|subst=yes</code> | |||
| {{code|braceinside{{=}}yes}} | | {{code|braceinside{{=}}yes}} | ||
| {{code|alttext{{=}}Foo}}<br />{{code|2{{=}}Foo}} | | {{code|alttext{{=}}Foo}}<br />{{code|2{{=}}Foo}} | ||
|- | |- | ||
! scope="row"| normal | |||
| {{n/a|DEFAULT}} | | {{n/a|DEFAULT}} | ||
| {{nowrap|{{ | | {{nowrap|{{tlg|tlg}}}}<wbr/>{{NoteTag|name=TlTfn1}}<br />{{tl|tl}}<br />{{tlp|tlp|1|2|...}}<wbr/>{{NoteTag|name=TlTfn2}}<br />{{tlu|Template:tlu}}<wbr/>{{NoteTag|name=TlTfn3}} | ||
| {{ | | {{tlf|tlf}}<wbr/>{{NoteTag|name=TlTfn2}}<br /><sup><[[Template:Template link with link off|template link]]></sup> | ||
| {{ | | {{tls|tls}}<br />{{tlsu|Template:tlsu}}<wbr/>{{NoteTag|name=TlTfn3}} | ||
| {{ | | {{tlsf|tlsf}}<wbr/>{{NoteTag|name=TlTfn2}}<br/><sup><[[Template:Tlsf|template link]]></sup> | ||
| {{ | | {{tn|tn}} | ||
| {{tla|tla}} | |||
|- | |- | ||
! scope="row"| <code>code</code> | |||
| {{code|code{{=}}yes}} | | {{code|code{{=}}yes}} | ||
| {{ | | {{tl2|tl2}}<br />{{Template link expanded|tlx}}<br />{{tlxu|Template:tlxu}}<wbr/>{{NoteTag|name=TlTfn3}} | ||
| {{ | | {{tlc|tlc}}<wbr/>{{NoteTag|name=TlTfn2}}<br /><sup><[[Template:tlc|template link]]></sup><br />{{tnull|tnull}}<sup><[[Template:tnull|template link]]></sup> | ||
| {{ | | {{tlxs|tlxs}} | ||
| | | {{tlsc|tlsc}}<wbr/>{{NoteTag|name=TlTfn2}}<br/><sup><[[Template:Tlsc|template link]]></sup> | ||
| colspan="2" rowspan="3" {{n/a}} | |||
|- | |||
! scope="row"| <span style="font-family:monospace; font-size:larger;">monospace</span> | |||
| {{code|plaincode{{=}}yes}}<wbr/>{{NoteTag|name=TlTfn4}} | |||
| colspan="2" rowspan="2" {{n/a}} | |||
| rowspan="2"| {{tltss|tltss}}<wbr/>{{NoteTag|name=TlTfn5}} | |||
| rowspan="2" {{n/a}} | |||
|- | |- | ||
! scope="row"| <kbd>kbd</kbd> | |||
| | | {{code|kbd{{=}}yes}}<wbr/>{{NoteTag||name=TlTfn5}} | ||
|- | |- | ||
! scope="row"| '''bold''' | |||
| {{code|bold{{=}}yes}} | | {{code|bold{{=}}yes}} | ||
| {{ | | {{tlb|tlb}} | ||
| | | colspan="5" rowspan="3" {{n/a}} | ||
|- | |- | ||
! scope="row"| '''<code>bold+code</code>''' | |||
| | || <code>bold=yes<wbr/>|code=yes</code> | ||
| {{ | | {{tlxb|tlxb}} | ||
|- | |- | ||
! scope="row"| ''<code>italic+code</code>'' | |||
| | || <code>italic=yes<wbr/>|code=yes</code> | ||
| {{ | | {{tlxi|tlxi}} | ||
|} | |} | ||
</div> | |||
{{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=== | |||
{| 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 | |||
|- | |||
!scope="row"| {{Tlx|Tj|Hatnote|Some text|selfref: yes|category: no|lang: fr}} | |||
| {{Tj|Hatnote|Some text|selfref: yes|category: no|lang: fr}} || Supports colors, placeholder texts, named and unnamed parameters | |||
|- | |||
!scope="row"| <!-- Using deprecate <source> tag to syntaxhighlight <syntaxhighlight> tag --> | |||
<source lang="wikitext"> | |||
<syntaxhighlight lang="wikitext"> | |||
{{Hatnote | |||
| Some text | |||
| selfref = yes | |||
| category = no | |||
| lang = fr | |||
}} | }} | ||
</syntaxhighlight> | |||
</source> | |||
=== | | <syntaxhighlight lang="wikitext"> | ||
{{Hatnote | |||
| Some text | |||
| selfref = yes | |||
| category = no | |||
| lang = fr | |||
}} | |||
</syntaxhighlight> | |||
| Same as above | |||
|- | |||
!scope="row"| {{Tlx|Tji|Hatnote|Some text|selfref: yes|category: no|lang: fr}} | |||
| {{Tji|Hatnote|Some text|selfref: yes|category: no|lang: fr}} || Supports colors, placeholder texts, named and unnamed parameters | |||
|- | |- | ||
| {{ | |||
!scope="row"| <code>{{xtag|syntaxhighlight|params=lang="wikitext" inline}}<nowiki>{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}</nowiki>{{xtag|syntaxhighlight|c}}</code> | |||
| <syntaxhighlight lang="wikitext" inline>{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}</syntaxhighlight> | |||
| Same as above | |||
|- | |- | ||
| {{tlx| | !scope="row"| {{tlx|tl2|<nowiki>Hatnote|lang=fr</nowiki>}} | ||
| {{tl2|hatnote|lang=fr}} || Supports linking to sister projects (e.g., fr:Hatnote) | |||
|- | |- | ||
| {{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| | !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 | |||
|- | |||
!scope="row"| {{tlx|ml|Example|hello}} | |||
| {{ml|Example|hello}} || Counterpart to {{tl|tl}} for linking to Lua modules | |||
|- | |- | ||
| {{tlx| | !scope="row"| {{tlx|mfl|Example|hello}} | ||
| {{mfl|Example|hello}} || Similar to {{tl|ml}}, but expects the function to be documented and creates a link to the corresponding section | |||
|- | |- | ||
| {{tlx| | !scope="row"| {{tlx|mlx|Example|hello}} | ||
| {{mlx|Example|hello}} || Counterpart to {{tl|tlx}} for linking to Lua modules | |||
|- | |- | ||
| {{tlx| | !scope="row"| {{tlx|ml-lua|Module:Example}} | ||
| {{ml-lua|Module:Example}} || Link to Lua modules and built-in libraries, showing Lua code. | |||
|- | |||
!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}} | |||
|- | |||
!scope="row"| {{tlx|magic word|uc:}} | |||
| {{magic word|uc:}} || Magic word links | |||
|} | |} | ||
===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> | |}<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]] | [[Category:Documentation see also templates]] | ||
</noinclude> | }}</noinclude> | ||
Latest revision as of 08:31, 4 May 2025
General-purpose formatting
| Text style ↓ | {{tlg}} options[note 1]to achieve text style |
Link style | |||||
|---|---|---|---|---|---|---|---|
| Linked | Unlinked | Linked with subst | Unlinked with subst | Linked including braces | Linked with alternative text | ||
{{tlg}} options[note 1]to achieve link style |
— | DEFAULT | nolink=yes
|
subst=yes
|
nolink=yes
|
braceinside=yes
|
alttext=Foo2=Foo
|
| normal | DEFAULT | {{tlg}} {{tl}} {{tlp|1|2|...}} {{Template:tlu}} |
{{tlf}} <template link> |
{{subst:tls}} {{subst:Template:tlsu}} |
{{subst:tlsf}} <template link> |
{{tn}} | {{tla}} |
code
|
code=yes
|
{{tl2}}{{tlx}}{{Template:tlxu}} |
{{tlc}}<template link> {{tnull}}<template link>
|
{{subst:tlxs}}
|
{{subst:tlsc}}<template link> |
— | |
| monospace | plaincode=yes |
— | {{subst:tltss}} |
— | |||
| kbd | kbd=yes | ||||||
| bold | bold=yes
|
{{tlb}} | — | ||||
bold+code
|
bold=yes
|
{{tlxb}}
| |||||
italic+code
|
italic=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 2.3 2.4 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 |
|---|---|---|
{{Tj|Hatnote|Some text|selfref: yes|category: no|lang: fr}}
|
Supports colors, placeholder texts, named and unnamed parameters | |
<syntaxhighlight lang="wikitext">
{{Hatnote
| Some text
| selfref = yes
| category = no
| lang = fr
}}
</syntaxhighlight>
|
{{Hatnote
| Some text
| selfref = yes
| category = no
| lang = fr
}}
|
Same as above |
{{Tji|Hatnote|Some text|selfref: yes|category: no|lang: fr}}
|
{{Hatnote |
Supports colors, placeholder texts, named and unnamed parameters |
|
{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}
|
Same as above |
{{tl2|Hatnote|lang=fr}}
|
{{hatnote}} |
Supports linking to sister projects (e.g., fr:Hatnote) |
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}
|
{{hatnote|lang=fr|Some text}}
|
Shows code and example |
{{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 |
{{mfl|Example|hello}}
|
{{#invoke:Example|hello}} | Similar to {{ml}}, but expects the function to be documented and creates a link to the corresponding section |
{{mlx|Example|hello}}
|
{{#invoke:Example|hello}} |
Counterpart to {{tlx}} for linking to Lua modules |
{{ml-lua|Module:Example}}
|
require('Module:Example') |
Link to Lua modules and built-in libraries, showing Lua code. |
{{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}} |
{{magic word|uc:}}
|
{{uc:}} | Magic word links |
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 (talk · history · transclusions · logs · subpages) |
{{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 |
{{tiw|Hatnote}}
|
Template:Hatnote (backlinks edit) |
{{tlt|Hatnote}}
|
{{Hatnote}} (talk) |
{{ttl|Hatnote}}
|
Template:Hatnote (links, talk) |
{{twlh|Hatnote}}
|
Template:Hatnote (links, talk) |
Usage
Use this {{Template-linking templates}} on /doc pages for related templates.