Difference between revisions of "Template:Template-linking templates"

From blackwiki
Jump to navigation Jump to search
m (217 revisions imported)
 
(61 intermediate revisions by 26 users not shown)
Line 1: Line 1:
{{navbar|Template-linking templates|plain=1}}<!--
+
<includeonly>{{navbar|Template-linking templates|text=These tables:|style=float: right;}}</includeonly>
--><noinclude>{{float|{{template shortcut|tl-nav|tl templates}}}}</noinclude><!--
 
-->
 
 
===General-purpose formatting===
 
===General-purpose formatting===
{| class="wikitable navbox collapsible" style="width:auto;font-size:90%;margin:1.0em auto 1.0em auto;vertical-align:top;text-align:center;"
+
{| class="wikitable plainrowheaders"
|+ Comparison of template-linking templates according to their style
+
|+ 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&nbsp;text
 
|-
 
|-
!style=*"|
+
! scope="row"| {{tlx|tlg}} options{{NoteTag|name=TlTfn1}}<br />to achieve link style
!style="background:#fcc;"| Link style →
+
| {{n/a}}
!style="background:#fee;"| Linked
+
| {{n/a|DEFAULT}}
!style="background:#fee;"| Unlinked
+
| {{code|nolink{{=}}yes}}
!style="background:#fee;"| Linked with subst
+
| {{code|subst{{=}}yes}}
!style="background:#fee;"| Linked including braces
+
| {{code|braceinside{{=}}yes}}
!style="background:#fee;"| Linked with alternative&nbsp;text
+
| {{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}}
 
|-
 
|-
!style="background:#ccf;"| Text style ↓
+
! scope="row"| <code>code</code>
|'''↓ {{tlx|tlg}} options<sup>1</sup> →'''
+
| {{code|code{{=}}yes}}
|{{n/a}}
+
| {{tl2|tl2}}<br />{{tlx|tlx}}<br />{{tlxu|Template:tlxu}}<sup>3</sup>{{NoteTag|name=TlTfn3}}
|{{code|nolink{{=}}yes}}
+
| {{tlc|tlc}}{{NoteTag|name=TlTfn2}}<br /><sup><[[Template:tlc|template link]]></sup><br />{{tnull|tnull}}<sup><[[Template:tnull|template link]]></sup>
|{{code|subst{{=}}yes}}
+
| {{tlxs|tlxs}}
|{{code|braceinside{{=}}yes}}
+
| colspan="2" rowspan="3" {{n/a}}
|{{code|alttext{{=}}Foo}}<br />{{code|2{{=}}Foo}}
 
 
|-
 
|-
|style="background:#eef;"| Normal
+
! scope="row"| <span style="font-family:monospace; font-size:larger;">monospace</span>
| {{n/a}}
+
| {{code|plaincode{{=}}yes}}{{NoteTag|name=TlTfn4}}
| {{nowrap|{{tlx|tlg}}<sup>1</sup>}}<br />{{tlx|tl}}<br />{{tlx|tlp}}<sup>2</sup><br />{{tlx|tlu}}<sup>4</sup>
+
| colspan="2" rowspan="2" {{n/a}}
| {{tlx|tlf}}<sup>2</sup>
+
| rowspan="2"| {{tltss|tltss}}{{NoteTag|name=TlTfn5}}
| {{tlx|tls}}<br />{{tlx|tlsp}}
 
| {{tlx|tn}}
 
| {{tlx|tla}}
 
 
|-
 
|-
!style="background:#eef;"| <code>Code</code>
+
! scope="row"| <kbd>kbd</kbd>
| {{code|code{{=}}yes}} or<br />{{code|tt{{=}}yes}}
+
| {{code|kbd{{=}}yes}}{{NoteTag||name=TlTfn5}}
| {{tlx|tlx}}<br />{{tlx|tltt}}<br />{{tlx|tltt2}}
 
| {{tlx|tlc}}<sup>2</sup><br />{{tlx|tld}}<sup>2</sup><br />{{tlx|tnull}}
 
| {{tlx|tlxs}}<br />{{tlx|tltts}}<br />{{tlx|tltts3}}<br />{{tlx|tltss}}<sup>3</sup>
 
| colspan="2" {{n/a}}
 
 
|-
 
|-
|style="background:#eef;"| '''Bold'''
+
! scope="row"| '''bold'''
 
| {{code|bold{{=}}yes}}
 
| {{code|bold{{=}}yes}}
| {{tlx|tlb}}
+
| {{tlb|tlb}}
| rowspan="3" colspan="4" {{n/a}}
+
| colspan="4" rowspan="3" {{n/a}}
 
|-
 
|-
|style="background:#eef;"| '''<code>Bold code</code>'''
+
! scope="row"| '''<code>bold+code</code>'''
 
| {{code|bold{{=}}yes{{!}}code{{=}}yes}}
 
| {{code|bold{{=}}yes{{!}}code{{=}}yes}}
| {{tlx|tlxb}}
+
| {{tlxb|tlxb}}
 
|-
 
|-
|style="background:#eef;" | ''<code>Italic code</code>''
+
! scope="row"| ''<code>italic+code</code>''
 
| {{code|italic{{=}}yes{{!}}code{{=}}yes}}
 
| {{code|italic{{=}}yes{{!}}code{{=}}yes}}
| {{tlx|tlxi}}
+
| {{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}}
{{plainlist |style=font-size:90% |
 
*<sup>1</sup> {{tlx|tlg}} is the most general, allowing any combination of text style and/or link style options.
 
*<sup>2</sup> Prevents wrapping of text by placing it inside {{tag|span|params=class="nowrap"}} tags.
 
*<sup>3</sup> Uses monospace font but not {{tag|code}}.
 
*<sup>4</sup> Allows links to templates in any namespace.
 
}}
 
  
 
===Other formatting templates===
 
===Other formatting templates===
{| class="wikitable sortable" style="vertical-align:top;"
+
{| class="wikitable sortable plainrowheaders"
! Code example !! Effect !! Notes
+
|+ 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>}} || {{tl2|hatnote|lang=fr}} || Supports linking to sister projects (e.g., fr:Hatnote)
+
!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}} || {{tlu|User:Ahunt/SSHFS}} || Supports linking to any namespace
+
!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>}} || {{demo|<nowiki>{{hatnote|lang=fr|Some text}}</nowiki>}} || Shows code and example
+
!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>}} || {{xpd|hatnote|Some hatnote text}} || Shows code, example and a link to expand the template code
+
!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|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|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|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
 +
|-
 +
!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" style="vertical-align:top;"
+
{| class="wikitable sortable plainrowheaders"
! Code example !! Effect
+
|+ Templates producing utility links for a given template ([[Template:Hatnote|Hatnote]] used here as example)
 +
!scope="col"| Code example
 +
!scope="col"| Effect
 
|-
 
|-
| {{tlx|lts|Hatnote}} || {{lts|hatnote}}
+
!scope="row"| {{tlx|lt|Hatnote}}
 +
| {{lt|hatnote}}
 
|-
 
|-
| {{tlx|t links|Hatnote}} || {{t links|hatnote}}
+
!scope="row"| {{tlx|lts|Hatnote}}
 +
| {{lts|hatnote}}
 
|-
 
|-
| {{tlx|tfd links|Hatnote}} || {{tfd links|hatnote}}
+
!scope="row"| {{tlx|t links|Hatnote}}
 +
| {{t links|hatnote}}
 
|-
 
|-
| {{tlx|tiw|Hatnote}} || {{tiw|hatnote}}
+
!scope="row"| {{tlx|tfd links|Hatnote}}
 +
| {{tfd links|hatnote}}
 
|-
 
|-
| {{tlx|tltt|Hatnote}} || {{tltt|Hatnote}}
+
!scope="row"| {{tlx|tetl|Hatnote}}
 +
| {{tetl|Hatnote}}
 
|-
 
|-
| {{tlx|tetl|Hatnote}} || {{tetl|Hatnote}}
+
!scope="row"| {{tlx|tsetl|Hatnote}}
 +
| {{tsetl|Hatnote}}
 
|-
 
|-
| {{tlx|tsetl|Hatnote}} || {{tsetl|Hatnote}}
+
!scope="row"| {{tlx|ti|Hatnote}}
 +
| {{ti|Hatnote}}
 
|-
 
|-
| {{tlx|ti|Hatnote}} || {{ti|Hatnote}}
+
!scope="row"| {{tlx|tic|Hatnote}}
 +
| {{tic|Hatnote}}
 
|-
 
|-
| {{tlx|tic|Hatnote}} || {{tic|Hatnote}}
+
!scope="row"| {{tlx|tim|Hatnote}}
 +
| {{tim|Hatnote}}
 
|-
 
|-
| {{tlx|tiw|Hatnote}} || {{tiw|Hatnote}}
+
!scope="row"| {{tlx|tiw|Hatnote}}
 +
| {{tiw|Hatnote}}
 
|-
 
|-
| {{tlx|tlt|Hatnote}} || {{tlt|Hatnote}}
+
!scope="row"| {{tlx|tlt|Hatnote}}
 +
| {{tlt|Hatnote}}
 
|-
 
|-
| {{tlx|ttl|Hatnote}} || {{ttl|Hatnote}}
+
!scope="row"| {{tlx|ttl|Hatnote}}
 +
| {{ttl|Hatnote}}
 
|-
 
|-
| {{tlx|twlh|Hatnote}} || {{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

Comparison of template-linking templates according to the styles of generated text and link produced
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}}
  1. 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.
  2. Jump up to: 2.0 2.1 2.2 Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.
  3. Jump up to: 3.0 3.1 3.2 Allows links to templates in any namespace.
  4. {{tlg|plaincode=yes}} uses <code style="border:none; background-color:transparent;">...</code>.
  5. Jump up to: 5.0 5.1 Displays monospaced font using <span style="font-family:monospace;">...</span>.

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters
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

Templates producing utility links for a given template (Hatnote used here as example)
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}}
links talk edit
{{tsetl|Hatnote}} {{subst:Hatnote}}
 links talk edit
{{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)
Template documentation

Usage

Use this {{Template-linking templates}} on /doc pages for related templates.