Template:Template link code: Difference between revisions
Jump to navigation
Jump to search
(Created page with "<includeonly>{{#Invoke:Template link general|main|nolink=yes|code=yes|nowrap=yes}}</includeonly><noinclude> {{Documentation|1=Template:Tlg/doc |content = {{tlg/doc|tlc}} }} <!-- Add categories to the /doc subpage, not here! --> </noinclude>") |
m (1 revision imported) |
(No difference)
|
Latest revision as of 21:31, 11 June 2022
This template is used on approximately 837,000 pages, or roughly 79037% of all pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
This template uses Lua: |
This template, often abbreviated as {{tlc}}, is used to provide stylized formatting to template displays without actually using the template itself.
Parameters[edit source]
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}} → -5 |
Unnamed (Positional)[edit source]
This template can take any number of unnamed parameters as parameters accompanying the template link (or name); see Examples below.
Examples[edit source]
- 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 | Remarks |
{{tlc|Banner}} | {{Banner}} | Banner template does not exist. Be aware with linking to non-existing templates, although desired. |
{{tlc|ok}} | {{ok}} | ok template does exist |
{{tlc|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}} | {{convert|14|m|ftin|abbr=out|sp=us}} | Unlimited parameters as one <nowiki>...</nowiki> string |
{{tlc|Abc}} | {{Abc}} | |
{{tlc|abC}} | {{abC}} | template names are case-sensitive |
{{tlc|abc}} | {{abc}} | first letter is case-insensitive though |
{{tlc|abc|{{spaces}}tlc{{spaces}}}} | {{abc| tlc }} | Using {{spaces}} before and after {{{1}}} parameter. |
{{tlc|x0}} | {{x0}} | |
{{tlc|x0|code=on}} | {{x0}} | <code> style |
{{tlc|x0|plaincode=on}} | {{x0}} | plaincode style |
{{tlc|x0|kbd=on}} | {{x0}} | <kbd> style |
{{tlc|x0|bold=on}} | {{x0}} | bold link/name |
{{tlc|x1|one|italic=on}} | {{x1|one}} | parameter/s in italics |
{{tlc|x0|nolink=on}} | {{x0}} | |
{{tlc|x0|subst=on}} | {{x0}} | |
{{tlc|x0|brace=on}} | x0 | all braces in link |
{{tlc|x0|braceinside=on}} | x0 | inside braces in link |
{{tlc|x0|alttext=x0 link}} | {{x0}} | |
{{tlc|x0|bold=on|code=on|brace=on}} | x0 | No reason you can't combine multiple parameter settings |
{{tlc|x1|one}} | {{x1|one}} | |
{{tlc|x2|one|two}} | {{x2|one|two}} | |
{{tlc|x2|bold=on|code=on|one|two}} | {{x2|one|two}} | Can combine named and anonymous parameters … |
{{tlc|x2|one|two|bold=on|code=on}} | {{x2|one|two}} | … in any order … |
{{tlc|x2|one|code=on|two|bold=on|three}} | {{x2|one|two|three}} | … even intermixed … |
{{tlc|x2|one|code=on|two|bold=on|three|italic=on}} | {{x2|one|two|three}} | … with many different configurations. |
{{tlc|x3|1|2|3|4|5|6|7|8|9|10}} | {{x3|1|2|3|4|5|6|7|8|9|10}} | |
{{tlc}} | tlc | with no arguments, the current page name is substituted |
{{tlc|x1|x=u}} | {{x1}} | = won't work |
{{tlc|x1|x=u}} | {{x1|x=u}} | = is okay |
{{tlc|x1|x{{=}}u}} | {{x1|x=u}} | {{=}} is okay (see template equal sign) |
{{tlc|x1|x<nowiki>=</nowiki>u}} | {{x1|x=u}} | sticky nowiki is okay |
{{tlc|x2||two||}} | {{x2|two}} | empty parameters work too, even at the end |
{{tlc|x2|3=two|2=one}} | {{x2|one|two}} | right to left okay |
Code | Output |
---|---|
{{tlc|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 |
---|---|
{{tlc|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 |
---|---|
{{tlc|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[edit source]
General-purpose formatting[edit source]
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 |
N/A | 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}} {{subst:Template:tlsu}} |
{{tlsf}} <template link> |
{{tn}} | {{tla}} |
code
|
code=yes
|
{{tl2}} {{tlx}} {{Template:tlxu}} |
{{tlc}} <template link> {{tnull}} <template link>
|
{{subst:tlxs}}
|
{{subst:tlsc}} <template link> |
N/A | |
monospace | plaincode=yes |
N/A | {{subst:tltss}} |
N/A | |||
kbd | kbd=yes | ||||||
bold | bold=yes
|
{{tlb}} | N/A | ||||
bold+code
|
bold=yes
|
{{tlxb}}
| |||||
italic+code
|
italic=yes
|
{{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[edit source]
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>}}
|
{{hatnote|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 |
{{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 source]
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 · delete) |
{{tetl|Hatnote}}
|
{{Hatnote}} |
{{tsetl|Hatnote}}
|
{{subst:Hatnote}} |
{{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) |