Template:Tlxc/sandbox
{{Tlxc}}
This is the template sandbox page for Template:Tlxc (diff ). |
Note: This documentation for {{).
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
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,{{
braces – but in a monospaced font:{{tl|tl}}
produces: {{tl}}{{tlx|tl}}
produces:{{
tl}}
{{
will also not take nor display additional parameters.tl}}
- Named parameters
|subst=
- Setting this parameter to any non-blank value will prefix the string
subst:
linked totlxs|Welcome}} produces:}}.{{subst:Welcome
|SISTER=
- For an interwiki link to ), etc, facilitating interwiki template documentation and/or discussion.
|LANG=
- For a link to ), etc, facilitating cross-language template documentation and/or discussion.
Documentation
{{
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 |
{{ | {{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:Tlxc in articles based on its TemplateData.
TemplateData for Tlxc 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: namespacethat 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 ↓ | {{ |
Link style | |||||
---|---|---|---|---|---|---|---|
Linked | Unlinked | Linked with subst | Unlinked with subst | Linked including braces | Linked with alternative text | ||
{{ |
— | DEFAULT | nolink=yes
|
subst=yes
|
nolink=yes
|
braceinside=yes
|
alttext=Foo 2=Foo
|
normal | DEFAULT | {{ Template:tlu}}
|
{{tlf}} <template link> |
{{ Template:tlsu}}
|
{{subst:tlsf}} <template link> |
{{tn}}
|
{{ tla }}
|
code
|
code=yes
|
{{ |
{{tlc}} template link >
|
{{
|
{{subst:tlsc}} <template link> |
— | |
monospace | plaincode=yes |
— | {{ | — | |||
kbd | kbd=yes | ||||||
bold | bold=yes
|
{{ tlb }}
|
— | ||||
bold+code
|
bold=yes
|
{{
| |||||
italic+code
|
italic=yes
|
{{
|
- ^ tlg}} is the most general template, allowing any combination of text style and/or link style options.
- ^ a b c d e Prevents wrapping of text by placing it inside
<span class="nowrap">...</span>
tags. - ^ a b c Allows links to templates in any namespace.
- ^
{{tlg|plaincode=yes}}
uses<code style="border:none; background-color:transparent;">...</code>
. - ^ a b Displays monospaced font using
<span style="font-family:monospace;">...</span>
.
Other formatting templates
Code example | Effect | Notes |
---|---|---|
{{
|
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 |
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>}}
|
{{hatnote|lang=fr|Some text}}
|
Shows code and example |
{{
|
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 |
{{
|
{{#invoke:Example|hello}} | Counterpart to {{ tl }} for linking to Lua modules
|
{{
|
{{#invoke:Example|hello}} | Similar to {{ ml }}, but expects the function to be documented and creates a link to the corresponding section
|
{{
|
{{#invoke:Example|hello}} |
Counterpart to {{ tlx }} for linking to Lua modules
|
{{
|
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}}
|
[[ |
Takes a shortcut suffix in project namespace and displays it with brackets and the <code>...</code> |
{{tag|ref}} {{xtag|templatedata}}
|
<ref>...</ref> <templatedata> |
Formats [X]HTML tags; can add content, choose opening, closing, or self-closing |
{{
|
{{d:Ping project}} | Wikidata counterpart to {{ tl }}
|
{{
|
{{#if}} {{#if:{{{1}}}|true|false}} |
tl }}
|
{{magic word|uc:}}
|
{{uc:}} | 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}}
|
{{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}} |
{{tsetl|Hatnote}}
|
{{ subst:Hatnote}}
|
{{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) |