Template:Template link expanded/doc

Source: Wikipedia, the free encyclopedia.

This template is used to show example template usage without expanding the template itself.

Basic use

(Note: In the following examples, ellipses (groups of three dots) indicate where parameters have been omitted.)

{{
Template
|first parameter|second parameter|third parameter|...|tenth parameter}}

When you want to indicate setting a value to one or more parameters, you would normally use the equals-sign ("="). This doesn't work here; instead use {{=}}, like so:

{{
Template
|first=first value|second|third=third value}}

For more than ten parameters – with or without equals-signs – instead wrap the entire list of parameters and their values in <nowiki>...</nowiki> tags. When you do, you don't need to replace equals-signs. For instance:

{{
Template
|first|second|third=value|...|999th}}

Purpose and naming

Mnemonically, template link expanded (after

template link
).

This template allows an example of calling a template, accompanied by one or more parameters, to be displayed without also causing the template to be called.

Up to 20 of the template's parameters (numbered or nowiki-keywords) may be displayed as placeholders, while more than over 20 parameters can be displayed using a coded vertical bar (pipe) symbol, as in &#124;. A keyword parameter can be used with equals code &#61; or {{=}} or in nowiki-text: "<nowiki>size=10</nowiki>" or all parameters as a string in "<nowiki>" tags; see

this talk
page. If you use 21 or more parameters, all after the 20th will be replaced with a single |... at the end of the parameter list.

Exceptions

If the intended template lists numerous parameters, then perhaps this template should really not be used, and just hardcode the usage with <code><nowiki>. For example:

<code><nowiki>{{Anytemplate|arg1=23|size=250px|other parameters...}}</nowiki></code>.

If a vertical display, with parameters on their own lines, is desired, this can also be laid out manually in this manner, or more rapidly done with <pre>...</pre>.

Parameters

{{
tl
}}
will also not take nor display additional parameters.
Named parameters

|subst=

Setting this parameter to any non-blank value will prefix the string subst: linked to
tlxs|Welcome}} produces: {{subst:Welcome
}}.

|SISTER=

For an interwiki link to
other sister projects, such as: |SISTER=M: (Meta), |SISTER=Q: (WikiQuote), |SISTER=S: (WikiSource
), etc, facilitating interwiki template documentation and/or discussion.

|LANG=

For a link to
Wikipedias in other languages, such as: |LANG=de: (German), |LANG=sv: (Swedish
), etc, facilitating cross-language template documentation and/or discussion.

Documentation

{{

tlw
}}, which makes the click target bigger).

Usage

{{tlx|Templatename}}
{{tlx|Templatename|param}}
{{tlx|Templatename|1|2|3|4|5|6|7|8|9|10}}
{{tlx|Templatename|1|2|3|4|5|6|7|8|9|10&#124;more}}
{{tlx|Templatename|param&#61;value}}

There are up to 10 placeholders for parameters of the specified template.

Examples

Code Result Remarks
{{
tlx|x2|3=two|2=one}}
{{x2|one|two}}
irregular parameter order is okay
Unlimited parameters as one <nowiki>...</nowiki> string
{{
tlx
|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}

TemplateData

TemplateData documentation used by VisualEditor and other tools
See a monthly parameter usage report for Template:Template link expanded in articles based on its TemplateData.

TemplateData for Template link expanded

Show example template usage without expanding the template itself. {{tnull}} is similar without linking the template.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Template name1

Name of the template to link.

Example
Tlx
Templaterequired
1st parameter2

no description

Stringoptional
2nd parameter3

no description

Stringoptional
3rd parameter4

no description

Stringoptional
4th parameter5

no description

Stringoptional
5th parameter6

no description

Stringoptional
6th parameter7

no description

Stringoptional
7th parameter8

no description

Stringoptional
8th parameter9

no description

Stringoptional
9th parameter10

no description

Stringoptional
10th parameter11

no description

Stringoptional
11th parameter12

no description

Stringoptional
12th parameter13

no description

Stringoptional
13th parameter14

no description

Stringoptional
14th parameter15

no description

Stringoptional
15th parameter16

no description

Stringoptional
16th parameter17

no description

Stringoptional
17th parameter18

no description

Stringoptional
18th parameter19

no description

Stringoptional
19th parameter20

no description

Stringoptional
20th parameter21

no description

Stringoptional
Show subst:subst

Set to any value to show "subst:" before the template name

Example
true
Booleanoptional
LanguageLANG

The prefix for a link to Wikipedias in other languages.

Example
de:
Lineoptional
Sister projectSISTER

The prefix for an interwiki link to other sister projects

Example
M:
Lineoptional

See also

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 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 {{
Template:tlu}}[note 3]
{{tlf}}[note 2]
<template link>
{{
Template:tlsu}}[note 3]
{{subst:tlsf}}[note 2]
<template link>
{{tn}}
{{
tla
}}
code code=yes {{
Template:tlxu}}[note 3]
{{tlc}}
template link
>
{{
subst:tlxs
}}
{{subst:tlsc}}[note 2]
<template link>
monospace plaincode=yes[note 4] {{
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. ^
    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

Templates producing specialised formatting effects for given templates, modules or parameters
Code example Effect Notes
{{
Tj
|Hatnote|Some text|selfref: yes|category: no|lang: fr}}
{{Hatnote
| Some text
| selfref = yes
| category = no
| lang = fr
}}
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}}
{{Hatnote|Some text|selfref=yes|category=no|lang=fr}} Supports colors, placeholder texts, named and unnamed parameters
<syntaxhighlight lang="wikitext" inline>{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}</syntaxhighlight> {{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>}}
{{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
{{
mfl
|Example|hello}}
{{#invoke:Example|hello}} Similar to {{
ml
}}, but expects the function to be documented and creates a link to the corresponding section
{{
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
<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|{{{1}}}|true|false}}
{{#if}}
{{#if:{{{1}}}|true|false}}
tl
}}
{{magic word|uc:}} {{uc:}} Magic word links

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 (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)