|
|
| Line 1: |
Line 1: |
| <includeonly>{{navbar|Template-linking templates|text=These tables:|style=float: right;}}</includeonly>
| | {{navbar|Template-linking templates|plain=1}} |
| === General-purpose formatting === | | <noinclude>{{float|{{template shortcut|tl-nav|tl templates}}}}</noinclude> |
| <div style="overflow-x: auto; margin: 1em 0;">
| | |
| {| class="wikitable plainrowheaders" style="margin: 0;" | | ===General-purpose formatting=== |
| |+ Comparison of template-linking templates according to the styles of generated text and link produced | | {| class="wikitable navbox collapsible" style="width:auto;font-size:90%;margin:1.0em auto 1.0em auto;vertical-align:top;text-align:center;" |
| |- style="background-color: #fee;"
| | |+ Comparison of template-linking templates according to their style |
| ! 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|DEFAULT}}
| |
| | {{code|nolink{{=}}yes}}
| |
| | {{code|subst{{=}}yes}}
| |
| || <code>nolink=yes<wbr/>|subst=yes</code>
| |
| | {{code|braceinside{{=}}yes}}
| |
| | {{code|alttext{{=}}Foo}}<br />{{code|2{{=}}Foo}}
| |
| |- | | |- |
| ! scope="row"| normal | | !style=*"| |
| | {{n/a|DEFAULT}} | | !style="background:#fcc;"| Link style → |
| | {{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}}
| | !style="background:#fee;"| Linked |
| | {{tlf|tlf}}<wbr/>{{NoteTag|name=TlTfn2}}<br /><sup><[[Template:Template link with link off|template link]]></sup>
| | !style="background:#fee;"| Unlinked |
| | {{tls|tls}}<br />{{tlsu|Template:tlsu}}<wbr/>{{NoteTag|name=TlTfn3}}
| | !style="background:#fee;"| Linked with subst |
| | {{tlsf|tlsf}}<wbr/>{{NoteTag|name=TlTfn2}}<br/><sup><[[Template:Tlsf|template link]]></sup>
| | !style="background:#fee;"| Linked including braces |
| | {{tn|tn}}
| | !style="background:#fee;"| Linked with alternative text |
| | {{tla|tla}}
| |
| |- | | |- |
| ! scope="row"| <code>code</code> | | !style="background:#ccf;"| Text style ↓ |
| | {{code|code{{=}}yes}} | | |'''↓ {{tlx|tlg}} options<sup>1</sup> →''' |
| | {{tl2|tl2}}<br />{{Template link expanded|tlx}}<br />{{tlxu|Template:tlxu}}<wbr/>{{NoteTag|name=TlTfn3}} | | |{{n/a}} |
| | {{tlc|tlc}}<wbr/>{{NoteTag|name=TlTfn2}}<br /><sup><[[Template:tlc|template link]]></sup><br />{{tnull|tnull}}<sup><[[Template:tnull|template link]]></sup> | | |{{code|nolink{{=}}yes}} |
| | {{tlxs|tlxs}} | | |{{code|subst{{=}}yes}} |
| | {{tlsc|tlsc}}<wbr/>{{NoteTag|name=TlTfn2}}<br/><sup><[[Template:Tlsc|template link]]></sup> | | |{{code|braceinside{{=}}yes}} |
| | colspan="2" rowspan="3" {{n/a}}
| | |{{code|alttext{{=}}Foo}}<br />{{code|2{{=}}Foo}} |
| |- | | |- |
| ! scope="row"| <span style="font-family:monospace; font-size:larger;">monospace</span>
| | |style="background:#eef;"| Normal |
| | {{code|plaincode{{=}}yes}}<wbr/>{{NoteTag|name=TlTfn4}} | | | {{n/a}} |
| | colspan="2" rowspan="2" {{n/a}} | | | {{nowrap|{{tlx|tlg}}<sup>1, 2</sup>}}<br />{{tlx|tl}}<br />{{tlx|tlp}}<sup>2</sup><br />{{tlx|tlu}}<sup>4</sup> |
| | rowspan="2"| {{tltss|tltss}}<wbr/>{{NoteTag|name=TlTfn5}} | | | {{tlx|tlf}}<sup>2</sup> |
| | rowspan="2" {{n/a}} | | | {{tlx|tls}}<br />{{tlx|tlsp}} |
| | | {{tlx|tn}} |
| | | {{tlx|tla}} |
| |- | | |- |
| ! scope="row"| <kbd>kbd</kbd> | | !style="background:#eef;"| <code>Code</code> |
| | {{code|kbd{{=}}yes}}<wbr/>{{NoteTag||name=TlTfn5}} | | | {{code|code{{=}}yes}} or<br />{{code|tt{{=}}yes}} |
| | | {{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}} |
| |- | | |- |
| ! scope="row"| '''bold'''
| | |style="background:#eef;"| '''Bold''' |
| | {{code|bold{{=}}yes}} | | | {{code|bold{{=}}yes}} |
| | {{tlb|tlb}} | | | {{tlx|tlb}} |
| | colspan="5" rowspan="3" {{n/a}} | | | rowspan="3" colspan="4" {{n/a}} |
| |- | | |- |
| ! scope="row"| '''<code>bold+code</code>'''
| | |style="background:#eef;"| '''<code>Bold code</code>''' |
| || <code>bold=yes<wbr/>|code=yes</code> | | | {{code|bold{{=}}yes{{!}}code{{=}}yes}} |
| | {{tlxb|tlxb}} | | | {{tlx|tlxb}} |
| |- | | |- |
| ! scope="row"| ''<code>italic+code</code>''
| | |style="background:#eef;" | ''<code>Italic code</code>'' |
| || <code>italic=yes<wbr/>|code=yes</code> | | | {{code|italic{{=}}yes{{!}}code{{=}}yes}} |
| | {{tlxi|tlxi}} | | | {{tlx|tlxi}} |
| |} | | |} |
| </div>
| | {{clear}} |
| {{NoteFoot|refs= | | {{plainlist |style=font-size:90% | |
| {{NoteTag|name=TlTfn1|{{tlx|tlg}} is the most general template, allowing any combination of text style and/or link style options.}} | | *<sup>1</sup> {{tlx|tlg}} is the most general, 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.}}
| | *<sup>2</sup> Prevents wrapping of text by placing it inside {{tag|span|params=class="nowrap"}} tags. |
| {{NoteTag|name=TlTfn3|Allows links to templates in any namespace.}} | | *<sup>3</sup> Uses monospace font but not {{tag|code}}. |
| {{NoteTag|name=TlTfn4|{{tld|tlg|plaincode{{=}}yes}} uses [[HTML element#code|{{tag|code|params=style="border:none; background-color:transparent;"}}]].}}
| | *<sup>4</sup> Allows links to templates in any namespace. |
| {{NoteTag|name=TlTfn5|Displays monospaced font using {{tag|span|params=style="font-family:monospace;"}}.}}
| |
| }} | | }} |
| {{clear}}
| |
|
| |
|
| ===Other formatting templates=== | | ===Other formatting templates=== |
| {| class="wikitable sortable plainrowheaders" | | {| class="wikitable sortable" style="vertical-align:top;" |
| |+ Templates producing specialised formatting effects for given templates, modules or parameters
| | ! Code example !! Effect !! Notes |
| !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
| |
| |-
| |
| !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|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
| |
| |-
| |
| !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}}
| |
| | {{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>}}
| | | {{tlx|tl2|<nowiki>Hatnote|lang=fr</nowiki>}} || {{tl2|hatnote|lang=fr}} || Supports linking to sister projects (e.g., fr:Hatnote) |
| | {{para|title|<var>book title</var>}} || Formats template parameters for display, with or without values | |
| |- | | |- |
| !scope="row"| {{tlx|sclx|LASTING}}
| | | {{tlx|tlu|User:Ahunt/SSHFS}} || {{tlu|User:Ahunt/SSHFS}} || Supports linking to any namespace |
| | {{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}}
| | | {{tlx|xpd|<nowiki>Hatnote|Some hatnote text</nowiki>}} || {{xpd|hatnote|Some hatnote text}} || Shows code, example and a link to expand the template code |
| | {{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 plainrowheaders" | | {| class="wikitable sortable" style="vertical-align:top;" |
| |+ Templates producing utility links for a given template ([[Template:Hatnote|Hatnote]] used here as example)
| | ! Code example !! Effect |
| !scope="col"| Code example | |
| !scope="col"| Effect | |
| |- | | |- |
| !scope="row"| {{tlx|lt|Hatnote}}
| | | {{tlx|lts|Hatnote}} || {{lts|hatnote}} |
| | {{lt|hatnote}} | |
| |- | | |- |
| !scope="row"| {{tlx|lts|Hatnote}}
| | | {{tlx|t links|Hatnote}} || {{t links|hatnote}} |
| | {{lts|hatnote}} | |
| |- | | |- |
| !scope="row"| {{tlx|t links|Hatnote}}
| | | {{tlx|tfd links|Hatnote}} || {{tfd links|hatnote}} |
| | {{t links|hatnote}} | |
| |- | | |- |
| !scope="row"| {{tlx|tfd links|Hatnote}}
| | | {{tlx|tiw|Hatnote}} || {{tiw|hatnote}} |
| | {{tfd links|hatnote}} | |
| |- | | |- |
| !scope="row"| {{tlx|tetl|Hatnote}}
| | | {{tlx|tltt|Hatnote}} || {{tltt|Hatnote}} |
| | {{tetl|Hatnote}} | |
| |- | | |- |
| !scope="row"| {{tlx|tsetl|Hatnote}}
| | | {{tlx|tetl|Hatnote}} || {{tetl|Hatnote}} |
| | {{tsetl|Hatnote}} | |
| |- | | |- |
| !scope="row"| {{tlx|ti|Hatnote}}
| | | {{tlx|tsetl|Hatnote}} || {{tsetl|Hatnote}} |
| | {{ti|Hatnote}} | |
| |- | | |- |
| !scope="row"| {{tlx|tic|Hatnote}}
| | | {{tlx|ti|Hatnote}} || {{ti|Hatnote}} |
| | {{tic|Hatnote}} | |
| |- | | |- |
| !scope="row"| {{tlx|tim|Hatnote}}
| | | {{tlx|tic|Hatnote}} || {{tic|Hatnote}} |
| | {{tim|Hatnote}} | |
| |- | | |- |
| !scope="row"| {{tlx|tiw|Hatnote}}
| | | {{tlx|tiw|Hatnote}} || {{tiw|Hatnote}} |
| | {{tiw|Hatnote}} | |
| |- | | |- |
| !scope="row"| {{tlx|tlt|Hatnote}}
| | | {{tlx|tlt|Hatnote}} || {{tlt|Hatnote}} |
| | {{tlt|Hatnote}} | |
| |- | | |- |
| !scope="row"| {{tlx|ttl|Hatnote}}
| | | {{tlx|ttl|Hatnote}} || {{ttl|Hatnote}} |
| | {{ttl|Hatnote}} | |
| |- | | |- |
| !scope="row"| {{tlx|twlh|Hatnote}}
| | | {{tlx|twlh|Hatnote}} || {{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>
| |