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

From blackwiki
Jump to navigation Jump to search
blackwiki>JohnFromPinckney
(→‎General-purpose formatting: Caption improvement(?))
blackwiki>JohnFromPinckney
Line 1: Line 1:
 
<includeonly>{{navbar|Template-linking templates|text=These tables:|style=float: right;}}</includeonly>
 
<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
 
|+ 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-color: #fcc;" | Link style →
+
| {{n/a}}
! style="background-color: #fee;" | Linked
 
! style="background-color: #fee;" | Unlinked
 
! style="background-color: #fee;" | Linked with subst
 
! style="background-color: #fee;" | Linked including braces
 
! style="background-color: #fee;" | Linked with alternative&nbsp;text
 
|-
 
! style="background-color: #ccf;" | Text style ↓
 
| '''↓ {{tlx|tlg}} options<sup>1</sup> →'''
 
 
| {{n/a|DEFAULT}}
 
| {{n/a|DEFAULT}}
 
| {{code|nolink{{=}}yes}}
 
| {{code|nolink{{=}}yes}}
Line 20: Line 22:
 
| {{code|alttext{{=}}Foo}}<br />{{code|2{{=}}Foo}}
 
| {{code|alttext{{=}}Foo}}<br />{{code|2{{=}}Foo}}
 
|-
 
|-
| style="background-color: #eef;" | normal
+
! scope="row"| normal
 
| {{n/a|DEFAULT}}
 
| {{n/a|DEFAULT}}
| {{nowrap|{{tlg|tlg}}<sup>1</sup>}}<br />{{tl|tl}}<br />{{tlp|tlp|1|2|...}}<sup>2</sup><br />{{tlu|Template:tlu}}<sup>3</sup>
+
| {{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}}<sup>2, <[[Template:Template link with link off|template link]]></sup>
+
| {{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}}<sup>3</sup>
+
| {{tls|tls}}<br />{{tlsp|tlsp|1|2|...}}<br />{{tlsu|Template:tlsu}}{{NoteTag|name=TlTfn3}}
 
| {{tn|tn}}
 
| {{tn|tn}}
 
| {{tla|tla}}
 
| {{tla|tla}}
 
|-
 
|-
| style="background-color: #eef;" | <code>code</code>
+
! scope="row"| <code>code</code>
 
| {{code|code{{=}}yes}}
 
| {{code|code{{=}}yes}}
| {{tl2|tl2}}<br />{{tlx|tlx}}<br />{{tlxu|Template:tlxu}}<sup>3</sup>
+
| {{tl2|tl2}}<br />{{tlx|tlx}}<br />{{tlxu|Template:tlxu}}<sup>3</sup>{{NoteTag|name=TlTfn3}}
| {{tlc|tlc}}<sup>2, <[[Template:tlc|template link]]></sup><br />{{tnull|tnull}}<sup><[[Template:tnull|template link]]></sup>
+
| {{tlc|tlc}}{{NoteTag|name=TlTfn2}}<br /><sup><[[Template:tlc|template link]]></sup><br />{{tnull|tnull}}<sup><[[Template:tnull|template link]]></sup>
 
| {{tlxs|tlxs}}
 
| {{tlxs|tlxs}}
 +
| colspan="2" rowspan="3" {{n/a}}
 +
|-
 +
! scope="row"| <span style="font-family:monospace; font-size:larger;">monospace</span>
 +
| {{code|plaincode{{=}}yes}}{{NoteTag|name=TlTfn4}}
 
| colspan="2" rowspan="2" {{n/a}}
 
| colspan="2" rowspan="2" {{n/a}}
 +
| rowspan="2"| {{tltss|tltss}}{{NoteTag|name=TlTfn5}}
 
|-
 
|-
| style="background-color: #eef;" | <span style="font-family:monospace; font-size:larger;">monospace</span><br /><kbd>kbd</kbd>
+
! scope="row"| <kbd>kbd</kbd>
| {{code|plaincode{{=}}yes}}<sup>4</sup><br />{{code|kbd{{=}}yes}}<sup>5</sup>
+
| {{code|kbd{{=}}yes}}{{NoteTag||name=TlTfn5}}
| colspan=2 {{n/a}}
 
| {{tltss|tltss}}<sup>5</sup>
 
 
|-
 
|-
| style="background-color: #eef;" | '''bold'''
+
! scope="row"| '''bold'''
 
| {{code|bold{{=}}yes}}
 
| {{code|bold{{=}}yes}}
 
| {{tlb|tlb}}
 
| {{tlb|tlb}}
| rowspan="3" colspan="4" {{n/a}}
+
| colspan="4" rowspan="3" {{n/a}}
 
|-
 
|-
| style="background-color: #eef;" | '''<code>bold+code</code>'''
+
! scope="row"| '''<code>bold+code</code>'''
 
| {{code|bold{{=}}yes{{!}}code{{=}}yes}}
 
| {{code|bold{{=}}yes{{!}}code{{=}}yes}}
 
| {{tlxb|tlxb}}
 
| {{tlxb|tlxb}}
 
|-
 
|-
| style="background-color: #eef;" | ''<code>italic+code</code>''
+
! scope="row"| ''<code>italic+code</code>''
 
| {{code|italic{{=}}yes{{!}}code{{=}}yes}}
 
| {{code|italic{{=}}yes{{!}}code{{=}}yes}}
 
| {{tlxi|tlxi}}
 
| {{tlxi|tlxi}}
|-
+
|}
| colspan="7" style="background-color:#eee; padding-left:1em;" | {{plainlist |
+
{{NoteFoot|refs=
* <sup>1</sup>&nbsp; {{tlx|tlg}} is the most general, allowing any combination of text style and/or link style options.
+
{{NoteTag|name=TlTfn1|{{tlx|tlg}} is the most general template, allowing any combination of text style and/or link style options.}}
* <sup>2</sup>&nbsp; Prevents wrapping of text by placing it inside {{tag|span|params=class="nowrap"}} tags.
+
{{NoteTag|name=TlTfn2|Prevents wrapping of text by placing it inside {{tag|span|params=class="nowrap"}} tags.}}
* <sup>3</sup>&nbsp; Allows links to templates in any namespace.
+
{{NoteTag|name=TlTfn3|Allows links to templates in any namespace.}}
* <sup>4</sup>&nbsp; {{tld|tlg|plaincode{{=}}yes}} uses [[HTML element#code|{{tag|code|params=style="border:none; background-color:transparent;"}}]].
+
{{NoteTag|name=TlTfn4|{{tld|tlg|plaincode{{=}}yes}} uses [[HTML element#code|{{tag|code|params=style="border:none; background-color:transparent;"}}]].}}
* <sup>5</sup>&nbsp; Displays monospaced font using {{tag|span|params=style="font-family:monospace;"}}.
+
{{NoteTag|name=TlTfn5|Displays monospaced font using {{tag|span|params=style="font-family:monospace;"}}.}}
 
}}
 
}}
|}
 
 
{{clear}}
 
{{clear}}
  

Revision as of 06:02, 7 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. 1.0 1.1 1.2 {{tlg}} is the most general template, allowing any combination of text style and/or link style options.
  2. 2.0 2.1 2.2 Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.
  3. 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. 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)
{{tltt|Hatnote}} Template:Tltt
{{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.