Difference between revisions of "Template:Template link code/doc"
Jump to navigation
Jump to search
(Shamelessly copied from wikipedia.org) |
(Added a few more {{Wikipedia|...}} templates where needed) |
||
(2 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE --> | <!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE --> | ||
{{tsh|{{{1|tlg}}}|{{{2|}}}}} | {{tsh|{{{1|tlg}}}|{{{2|}}}}} | ||
This template, often abbreviated as {{tlf|{{#switch:{{lc:{{ROOTPAGENAME}}}} | This template, often abbreviated as {{tlf|{{#switch:{{lc:{{ROOTPAGENAME}}}} | ||
Line 36: | Line 33: | ||
| bold || Renders the template link/name in '''bold''' || {{tlg|bold=yes|example}} || {{tl|tlb}}, {{tl|tlxb}} | | bold || Renders the template link/name in '''bold''' || {{tlg|bold=yes|example}} || {{tl|tlb}}, {{tl|tlxb}} | ||
|- | |- | ||
| code || Display output using HTML | | code || Display output using HTML {{Wikipedia|HTML element#code|{{tag|code}}}} tags ({{Wikipedia|monospaced font}}) || {{tlg|code=yes|example}} || {{tl|tlc}}, {{tl|Template link expanded}}, etc. | ||
|- | |- | ||
| italic || Display any parameters accompanying the template link/name in ''italics'' ||| {{tlg|italic=yes|example|param}} || {{tl|tlxi}} | | italic || Display any parameters accompanying the template link/name in ''italics'' ||| {{tlg|italic=yes|example|param}} || {{tl|tlxi}} | ||
|- | |- | ||
| kbd || Display output using HTML | | kbd || Display output using HTML {{Wikipedia|HTML element#kbd|{{tag|kbd}}}} tags (monospaced font) || {{tlg|kbd=yes|example}} || | ||
|- | |- | ||
| nolink || Don't render the template name as a link || {{tlg|nolink=yes|example}} || {{tl|tlf}}, {{t|tnull}} | | nolink || Don't render the template name as a link || {{tlg|nolink=yes|example}} || {{tl|tlf}}, {{t|tnull}} | ||
|- | |- | ||
| nowrap || Prevent the insertion of line breaks ( | | nowrap || Prevent the insertion of line breaks ({{Wikipedia|word wrap}}) in the output || {{tlg|nowrap=yes|example}} || | ||
|- | |- | ||
| nowrapname || Prevent word wrapping in the output of template name/link (parameters will wrap if needed) || {{tlg|nowrapname=yes|example}} || | | nowrapname || Prevent word wrapping in the output of template name/link (parameters will wrap if needed) || {{tlg|nowrapname=yes|example}} || | ||
Line 50: | Line 47: | ||
| plaincode || Uses {{tag|code|params=style="border:none; background:transparent;"}} || {{tlg|plaincode=yes|example}} || {{tl|tltss}} | | plaincode || Uses {{tag|code|params=style="border:none; background:transparent;"}} || {{tlg|plaincode=yes|example}} || {{tl|tltss}} | ||
|- | |- | ||
| subst || Include a | | subst || Include a {{Wikipedia|Help:Substitution|subst:}} prefix before the template link/name || {{tlg|subst=yes|example}} || {{tl|tls}}, {{tl|tlxs}}, etc | ||
|- | |- | ||
| {{para|alttext|[text]}} || Use [text] as the label for the template link || {{tlg|alttext=Other|example}} || {{tl|tla}} | | {{para|alttext|[text]}} || Use [text] as the label for the template link || {{tlg|alttext=Other|example}} || {{tl|tla}} | ||
Line 60: | Line 57: | ||
====Unnamed (Positional)==== | ====Unnamed (Positional)==== | ||
This template can take any number of | This template can take any number of {{Wikipedia|unnamed parameter}}s as parameters accompanying the template link (or name); see Examples below. | ||
===Examples=== | ===Examples=== |
Latest revision as of 18:45, 15 September 2022
This is a documentation subpage for Template:Template link code. It contains usage information, categories and other content or metadata that is not part of the original template. |
This template, often abbreviated as {{tlc}}, is used to provide stylized formatting to template displays without actually using the template itself.
Parameters
With the exception of alttext, the named parameters are toggles that are either omitted (default in most cases) or activated (by being assigned a value such as "on", "yes", "true", "include", etc.). They may be included in any order (see Examples below). Certain templates have the parameter "on" by default; see the main table for all alternate options.
Parameter | Action | Use with {{Example}} |
Default active |
---|---|---|---|
Default (without accessory parameters) | {{example}} | ||
brace | Include braces as part of the template link | {{example}} | {{tlw}}/{{tn}} |
braceinside | Include innermost braces as part of the template link | {{example}} | |
bold | Renders the template link/name in bold | {{example}} | {{tlb}}, {{tlxb}} |
code | Display output using HTML <code>...</code> tags ( monospaced font) |
{{example}} |
{{tlc}}, {{Template link expanded}}, etc. |
italic | Display any parameters accompanying the template link/name in italics | {{example|param}} | {{tlxi}} |
kbd | Display output using HTML <kbd>...</kbd> tags (monospaced font) |
{{example}} | |
nolink | Don't render the template name as a link | {{example}} | {{tlf}}, {{Tnull}} |
nowrap | Prevent the insertion of line breaks ( word wrap) in the output | {{example}} | |
nowrapname | Prevent word wrapping in the output of template name/link (parameters will wrap if needed) | {{example}} | |
plaincode | Uses <code style="border:none; background:transparent;">...</code> |
{{example}} |
{{tltss}} |
subst | Include a subst: prefix before the template link/name | {{subst:example}} | {{tls}}, {{tlxs}}, etc |
alttext = [text] | Use [text] as the label for the template link | {{Other}} | {{tla}} |
_show_result | Will also display the result of the template. | {{Min|7|-5}} |
|
_expand | Will add a link to the expanded template page. | {{Min|7|-5}} |
Unnamed (Positional)
This template can take any number of unnamed parameters as parameters accompanying the template link (or name); see Examples below.
Examples
- Note
- On the source sister projects, en.wikipedia and Meta, X0, X1, X2, …, X9 are sandbox templates for experimentation on involved templates that need be in template space. An auto-cleansing software facility exists that might be used to duplicate the facility on other Sister projects.
Code | Output |
---|---|
{{tlg|long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}}
|
{{long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}} |
Code | Output |
---|---|
{{tlg|nowrap=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}}
|
{{long template name that would wrap to new line|long value for the 1st parameter that would wrap}} |
Code | Output |
---|---|
{{tlg|nowrapname=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}}
|
{{long template name that would wrap to new line|long value for the 1st parameter that would wrap}} |
See also
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=Foo 2=Foo
|
normal | DEFAULT | {{tlg}} {{tl}} {{tlp|1|2|...}} Template:Tlu |
{{tlf}} <template link> |
{{{ subst:tls}} Template:Tlsu |
Template:Tlsf <template link> |
{{tn}} | {{tla}} |
code
|
code=yes
|
{{tl2}} {{tlx}} Template:Tlxu |
{{tlc}} <template link> {{tnull}} <template link>
|
{{ subst:tlxs}}
|
Template:Tlsc <template link> |
— | |
monospace | plaincode=yes |
— | Template:Tltss |
— | |||
kbd | kbd=yes | ||||||
bold | bold=yes
|
{{tlb}} | — | ||||
bold+code
|
bold=yes
|
Template:Tlxb | |||||
italic+code
|
italic=yes
|
Template: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}}
|
Template:Tj | 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}}
|
Template:Tji | 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>}}
|
| ||
{{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}}
|
Template:Mfl | Similar to {{ml}}, but expects the function to be documented and creates a link to the corresponding section | |
{{mlx|Example|hello}}
|
Template:Mlx | Counterpart to {{tlx}} for linking to Lua modules | |
{{ml-lua|Module:Example|hello}}
|
Template:Ml-lua | 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}}
|
Template:Sclx | 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}}
|
Template:Dtl | Wikidata counterpart to {{tl}} | |
{{pf|if}} {{pf|if|{{{1}}}|true|false}}
|
{{#if}} {{#if:{{{1}}}|true|false}} |
Parser function equivalent to {{tl}} | |
{{magic word|uc:}}
|
Template:Magic word | 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}}
|
Template:T links |
{{tfd links|Hatnote}}
|
Template:Tfd links |
{{tetl|Hatnote}}
|
Template:Tetl |
{{tsetl|Hatnote}}
|
Template:Tsetl |
{{ti|Hatnote}}
|
Template:Ti |
{{tic|Hatnote}}
|
Template:Tic |
{{tim|Hatnote}}
|
Template:Hatnote |
{{tiw|Hatnote}}
|
Template:Hatnote (backlinks edit) |
{{tlt|Hatnote}}
|
{{Hatnote}} (talk) |
{{ttl|Hatnote}}
|
Template:Ttl |
{{twlh|Hatnote}}
|
Template:Twlh |