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

From Yugipedia
Jump to: navigation, search
 
m (1 revision imported: mass import/update of Wikipedia stuff)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Navbar-header|<big>Template linking templates</big>|Tl-nav|plain=1}}
+
<includeonly>{{navbar|Template-linking templates|text=These tables:|style=float: right;}}</includeonly>
{| align="center" class="wikitable collapsible" style="margin:1em auto 1em auto; width:auto; text-align:center; font-size:90%;"
+
=== General-purpose formatting ===
|- style="line-height:10pt;"
+
<div style="overflow-x: auto; margin: 1em 0;">
!
+
{| class="wikitable plainrowheaders" style="margin: 0;"
! Link Style
+
|+ Comparison of template-linking templates according to the styles of generated text and link produced
! style="font-weight:normal;" |Linked
+
|- style="background-color: #fee;"
! style="font-weight:normal;" |Unlinked
+
! scope="col" rowspan="2"| Text style ↓
! style="font-weight:normal;" |Linked with subst:
+
! scope="col" rowspan="2"| {{Template link expanded|tlg}} options{{NoteTag|name=TlTfn1}}<br />to achieve text style
! style="font-weight:normal;" |Linked including braces
+
! scope="col" colspan="6"| Link style
! style="font-weight:normal;" |Linked with alternative&nbsp;text
+
|- style="background-color: #fee;"
|- valign="top"
+
! scope="col"| Linked
! Text Style
+
! scope="col"| Unlinked
! {{tlx|tlg}} option
+
! scope="col"| Linked with subst
| style="font-weight: bold;" |--
+
! scope="col"| Unlinked with subst
| style="font-weight: bold;" nowrap |{{code|nolink{{=}}yes}}
+
! scope="col"| Linked including braces
| style="font-weight: bold;" |{{code|subst{{=}}yes}}
+
! scope="col"| Linked with alternative&nbsp;text
| style="font-weight: bold;" |{{code|braceinside{{=}}yes}}
 
| style="font-weight: bold;" |{{code|alttext{{=}}FOO}}
 
 
|-
 
|-
! style="font-weight:normal;" | Normal
+
! scope="row"| {{Template link expanded|tlg}} options{{NoteTag|name=TlTfn1}}<br />to achieve link style
| style="font-weight: bold;" |--
+
| {{n/a}}
| {{tlx|tl}}, {{tlx|tlp}}; {{tlx|tlg}}
+
| {{n/a|DEFAULT}}
| {{tlx|tlf}}
+
| {{code|nolink{{=}}yes}}
| {{tlx|tls}}, {{tlx|tlsp}}
+
| {{code|subst{{=}}yes}}
| {{tlx|tn}}
+
|| <code>nolink=yes<wbr/>|subst=yes</code>
| {{tlx|tla}}
+
| {{code|braceinside{{=}}yes}}
 +
| {{code|alttext{{=}}Foo}}<br />{{code|2{{=}}Foo}}
 
|-
 
|-
! style="font-weight:normal;" | <tt>Teletype</tt>
+
! scope="row"| normal
| style="font-weight: bold;" |{{code|tt{{=}}yes}}
+
| {{n/a|DEFAULT}}
| {{tlx|tlx}}
+
| {{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}}
| {{tlx|tld}}
+
| {{tlf|tlf}}<wbr/>{{NoteTag|name=TlTfn2}}<br /><sup><[[Template:Template link with link off|template link]]></sup>
| {{tlx|tlxs}}
+
| {{tls|tls}}<br />{{tlsu|Template:tlsu}}<wbr/>{{NoteTag|name=TlTfn3}}
|
+
| {{tlf|tlsf}}<wbr/>{{NoteTag|name=TlTfn2}}<br/><sup><[[Template:Tlsf|template link]]></sup>
|
+
| {{tn|tn}}
 +
| {{tla|tla}}
 
|-
 
|-
! style="font-weight:normal;" | '''Bold'''
+
! scope="row"| <code>code</code>
| style="font-weight: bold;" |{{code|bold{{=}}yes}}
+
| {{code|code{{=}}yes}}
| {{tlx|tlb}}
+
| {{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}}
 
|-
 
|-
! style="font-weight:normal;" | <tt>'''Bold Teletype'''</tt>
+
! scope="row"| <span style="font-family:monospace; font-size:larger;">monospace</span>
| style="font-weight: bold;" |{{code|bold{{=}}yes{{!}}tt{{=}}yes}}
+
| {{code|plaincode{{=}}yes}}<wbr/>{{NoteTag|name=TlTfn4}}
| {{tlx|tlxb}}
+
| colspan="2" rowspan="2" {{n/a}}
|
+
| rowspan="2"| {{tltss|tltss}}<wbr/>{{NoteTag|name=TlTfn5}}
|
+
| rowspan="2" {{n/a}}
|
 
|
 
 
|-
 
|-
! style="font-weight:normal;" | <tt>''Italic Teletype''</tt>
+
! scope="row"| <kbd>kbd</kbd>
| style="font-weight: bold;" |{{code|italic{{=}}yes{{!}}tt{{=}}yes}}
+
| {{code|kbd{{=}}yes}}<wbr/>{{NoteTag||name=TlTfn5}}
| {{tlx|tlxi}}
 
|
 
|
 
|
 
|
 
 
|-
 
|-
! style="font-weight:normal;" | <code>Code</code>
+
! scope="row"| '''bold'''
| style="font-weight: bold;" |{{code|code{{=}}yes}}
+
| {{code|bold{{=}}yes}}
|
+
| {{tlb|tlb}}
| {{tlx|tlc}}
+
| 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 align=center style="font-size:90%;">'''NOTE:''' {{tlx|tlg}} is the most general, allowing any combination of the above options.</div><noinclude>
+
</div>
[[Category:Template documentation]]
+
{{NoteFoot|refs=
</noinclude>
+
{{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}}
 +
 
 +
===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|tl2|<nowiki>Hatnote|lang=fr</nowiki>}}
 +
| {{tl2|hatnote|lang=fr}} || Supports linking to sister projects (e.g., fr:Hatnote)
 +
|-
 +
!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
 +
|-
 +
!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}} -->
 +
!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
 +
|-
 +
!scope="row"| {{tlx|mlx|Example|hello}}
 +
| {{mlx|Example|hello}} || Counterpart to {{tl|tlx}} for linking to Lua modules
 +
|-
 +
!scope="row"| {{tlx|ml-lua|Module:Example|hello}}
 +
| {{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===
 +
{| 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
 +
|-
 +
!scope="row"| {{tlx|lt|Hatnote}}
 +
| {{lt|hatnote}}
 +
|-
 +
!scope="row"| {{tlx|lts|Hatnote}}
 +
| {{lts|hatnote}}
 +
|-
 +
!scope="row"| {{tlx|t links|Hatnote}}
 +
| {{t links|hatnote}}
 +
|-
 +
!scope="row"| {{tlx|tfd links|Hatnote}}
 +
| {{tfd links|hatnote}}
 +
|-
 +
!scope="row"| {{tlx|tetl|Hatnote}}
 +
| {{tetl|Hatnote}}
 +
|-
 +
!scope="row"| {{tlx|tsetl|Hatnote}}
 +
| {{tsetl|Hatnote}}
 +
|-
 +
!scope="row"| {{tlx|ti|Hatnote}}
 +
| {{ti|Hatnote}}
 +
|-
 +
!scope="row"| {{tlx|tic|Hatnote}}
 +
| {{tic|Hatnote}}
 +
|-
 +
!scope="row"| {{tlx|tim|Hatnote}}
 +
| {{tim|Hatnote}}
 +
|-
 +
!scope="row"| {{tlx|tiw|Hatnote}}
 +
| {{tiw|Hatnote}}
 +
|-
 +
!scope="row"| {{tlx|tlt|Hatnote}}
 +
| {{tlt|Hatnote}}
 +
|-
 +
!scope="row"| {{tlx|ttl|Hatnote}}
 +
| {{ttl|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 23:46, 1 April 2023

General-purpose formatting[edit]

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 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|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:Template:tlsu}}[note 3]
{{tlsf}}[note 2]
<template link>
{{tn}} {{tla}}
code code=yes {{tl2}}
{{tlx}}
{{Template:tlxu}}[note 3]
{{tlc}}[note 2]
<template link>
{{tnull}}<template link>
{{subst:tlxs}} {{subst:tlsc}}[note 2]
<template link>
monospace plaincode=yes[note 4] {{subst:tltss}}[note 5]
kbd kbd=yes[note 5]
bold bold=yes {{tlb}}
bold+code bold=yes|code=yes {{tlxb}}
italic+code italic=yes|code=yes {{tlxi}}
  1. a b c {{tlg}} is the most general template, allowing any combination of text style and/or link style options.
  2. a b c d e Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.
  3. a b c Allows links to templates in any namespace.
  4. {{tlg|plaincode=yes}} uses <code style="border:none; background-color:transparent;">...</code>.
  5. a b Displays monospaced font using <span style="font-family:monospace;">...</span>.

Other formatting templates[edit]

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)
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}} 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
{{mlx|Example|hello}} {{#invoke:Example|hello}} Counterpart to {{tlx}} for linking to Lua modules
{{ml-lua|Module:Example|hello}} 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[edit]

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 (talk · history · transclusions · logs · subpages)
{{tetl|Hatnote}} {{Hatnote}}
links talk edit
{{tsetl|Hatnote}} {{subst:Hatnote}}
 links talk edit
{{ti|Hatnote}} Template:Hatnote (talk · links · 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)