This is an old revision of this page, as edited by Fabartus (talk | contribs) at 03:37, 15 February 2007 (install /doc page w/merged documentation). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.
Revision as of 03:37, 15 February 2007 by Fabartus (talk | contribs) (install /doc page w/merged documentation)(diff) ← Previous revision | Latest revision (diff) | Newer revision → (diff)Note: This documentation for {{]}} is also transcluded by its derivatives {{]}}, {{]}} (edit · master page).
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|...}} produces: {{]|first parameter|second parameter|third 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}} produces: {{]|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|<nowiki>''first''|''second''|''third=value''|...|''999th''</nowiki>}} produces: {{]|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 |
. A keyword parameter can be used with equals code = or {{=}} or in nowiki-text: "<nowiki>size=10</nowiki>
" or all parameters as a string in "<nowiki>
" tags; see Examples at bottom. For more details, 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
- If the only parameter supplied is
{{{1}}}
, i.e. a template's name, {{]}}'s output is the same as {{]}} – i.e. a link within braces – but in a monospaced font:{{tl|tl}}
produces: {{tl}}{{tlx|tl}}
produces: {{]}}
- {{]}} 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 Help:Substitution. This is useful to indicate when a template should be substituted. For example, {{]|Welcome|subst=Y}} produces: {{]}}. This is similar to the action of the {{]}} template: {{]|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
{{Tlx}} is a generalization of {{tl}}, {{tlp}} etc., with output that is arguably more legible. This depends on the browser, but narrow gaps between characters such as " { ", " | ", " } " and links can be hard to read when not monospaced (and hard to click on; for uses like {{!}}
, see {{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|more}}
{{tlx|Templatename|param=value}}
There are up to 10 placeholders for parameters of the specified template.
Examples
Code | Result | Remarks |
{{]|x0}} | {{]}} | |
{{]|Abc}} | {{]}} | |
{{]|ABC}} | {{]}} | |
{{]|AbC}} | {{]}} | |
{{]|x1|one}} | {{]|one}} | |
{{]|x2|one|two}} | {{]|one|two}} | |
{{]|x3|1|2|3|...}} | {{]|1|2|3|4|...}} | |
{{]|x4|1|2|3|...}} | {{]|1|2|3|4|...}} | up to 10 parameters... |
{{]|x5|1|2|3|...}} | {{]|1|2|3|4|...}} | ...| for more |
{{]|x1|x=u}} | {{]}} | the straightforward equals-sign won't work... |
{{]|x1|x=u}} | {{]|x=u}} | ...but = is okay |
{{]|x1|x{{=}}u}} | {{]|x=u}} | ...and {{=}} is okay |
{{]|x1|<nowiki>x=u</nowiki>}} | {{]|x=u}} | sticky nowiki also okay |
{{]|x2| |two}} | {{]|two}} | empty won't work... |
{{]|x2| |two}} | {{]| |two}} | ...but   is okay |
{{]|x2| |two}} | {{]| |two}} | ... is also okay |
{{]|x2|<nowiki /> |two}} | {{]||two}} | <nowiki /> handles the space |
{{]|x2| | two}} | {{]| | two}} | | is okay |
{{]|x2| {{!}} two}} | {{]| | two}} | {{!}} is dubious |
{{]|x2|2=|3=two}} | {{]|two}} | empty really doesn't work |
{{]|x2|2=one|two}} | {{]|two}} | "two" overrides "2=one" |
{{]|x2|3=two|2=one}} | {{]|one|two}} | irregular parameter order is okay |
- Unlimited parameters as one
<nowiki>...</nowiki>
string - {{]|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.
|
See also
- {{tlxb}}, a version of {{tlx}} where the template name is shown in bold.
- {{tlb}}, a version of {{tl}} where the template name is shown in bold.
- {{temt}}, a version of {{tlx}} that handles templates whose names include "Template:" and pages outside the Template: namespace that are treated as templates.
- {{para}}, for the presentation of template parameters and values (e.g.
|paraname=val
,|another=
). - {{tnull}}, like
{{tlx}}
without linking the template.
General-purpose formatting
Text style ↓ | {{]}} options to achieve text style |
Link style | |||||
---|---|---|---|---|---|---|---|
Linked | Unlinked | Linked with subst | Unlinked with subst | Linked including braces | Linked with alternative text | ||
{{]}} options 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}} |
{{subst:tls}} {{subst:Template:tlsu}} |
{{subst:tlsf}} |
{{tn}} | {{tla}} |
code
|
code=yes
|
{{tl2}} {{]}} {{Template:tlxu}} |
{{tlc}} {{tnull}}
|
{{subst:tlxs}}
|
{{subst:tlsc}} |
— | |
monospace | plaincode=yes |
— | {{subst:tltss}} |
— | |||
kbd | kbd=yes | ||||||
bold | bold=yes
|
{{tlb}} | — | ||||
bold+code
|
bold=yes
|
{{tlxb}}
| |||||
italic+code
|
italic=yes
|
{{tlxi}}
|
- ^ {{]}} is the most general template, allowing any combination of text style and/or link style options.
- ^ Prevents wrapping of text by placing it inside
<span class="nowrap">...</span>
tags. - ^ Allows links to templates in any namespace.
-
{{tlg|plaincode=yes}}
uses<code style="border:none; background-color:transparent;">...</code>
. - ^ Displays monospaced font using
<span style="font-family:monospace;">...</span>
.
Other formatting templates
Code example | Effect | Notes |
---|---|---|
{{]|Hatnote|Some text|selfref: yes|category: no|...}} | {{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 |
{{]|Hatnote|Some text|selfref: yes|category: no|...}} | {{Hatnote |
Supports colors, placeholder texts, named and unnamed parameters |
|
{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}
|
Same as above |
{{]|Hatnote|lang=fr}} | {{hatnote}} |
Supports linking to sister projects (e.g., fr:Hatnote) |
{{]|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}} | {{hatnote|lang=fr|Some text}}Some text |
Shows code and example |
{{]|Hatnote}} | Template:Hatnote | Produces a normal link to the template |
{{]|Template:Hatnote}} {{]|Template:Hatnote|Hatnote}} |
] ] |
Formats wikilink, with optional piped link text and blended suffix |
{{]|Example|hello}} | {{#invoke:Example|hello}} | Counterpart to {{tl}} for linking to Lua modules |
{{]|Example|hello}} | {{#invoke:Example|hello}} | Similar to {{ml}}, but expects the function to be documented and creates a link to the corresponding section |
{{]|Example|hello}} | {{#invoke:Example|hello}} |
Counterpart to {{tlx}} for linking to Lua modules |
{{]|Module:Example}} | require('Module:Example') |
Link to Lua modules and built-in libraries, showing Lua code. |
{{]|title|<var>book title</var>}} | |title=book title |
Formats template parameters for display, with or without values |
{{]|LASTING}} | ] |
Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a <code>...</code> tag.
|
{{]|ref}} {{]|templatedata}} |
<ref>...</ref> <templatedata> |
Formats HTML tags; can add content, choose opening, closing, or self-closing |
{{]|Ping project}} | {{d:Ping project}} | Wikidata counterpart to {{tl}} |
{{]|if}} {{]|if|{{{1}}}|true|false}} |
{{#if}} {{#if:{{{1}}}|true|false}} |
Parser function equivalent to {{tl}} |
{{]|uc:}} | {{uc:}} | Magic word links |
With utility links
Code example | Effect |
---|---|
{{]|Hatnote}} | Template:Hatnote (edit | talk | history | links | watch | logs) |
{{]|Hatnote}} | Template:Hatnote(edit talk links history) |
{{]|Hatnote}} | {{Hatnote}} (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test) |
{{]|Hatnote}} | Template:Hatnote (talk · history · transclusions · logs · subpages) |
{{]|Hatnote}} | {{Hatnote}} links talk edit |
{{]|Hatnote}} | {{subst:Hatnote}} links talk edit |
{{]|Hatnote}} | Template:Hatnote (talk · links · edit) |
{{]|Hatnote}} | Template:Hatnote (talk links edit) |
{{]|Hatnote}} | m:Template:Hatnote (backlinks edit) |
{{]|Hatnote}} | Template:Hatnote (backlinks edit) |
{{]|Hatnote}} | {{Hatnote}} (talk) |
{{]|Hatnote}} | Template:Hatnote (links, talk) |
{{]|Hatnote}} | Template:Hatnote (links, talk) |