Template:Template link expanded/doc: Difference between revisions
ENWIKIIMPORT>Primefac m (Primefac moved page Template:Template link expanded/doc to Template:Template link expanded/doc: expand name, make it more obvious) |
m (1 revision imported) |
(No difference)
|
Revision as of 02:25, 14 December 2021
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.)
- {{tlxTemplate:\sandbox|tlx|Template|first parameter|second parameter|third parameter|...|tenth parameter}} produces: {{tlxTemplate:\sandbox|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 Template:Tlf, like so:
- {{tlxTemplate:\sandbox|tlx|Template|first{{=}}first value|second|third{{=}}third value}} produces: {{tlxTemplate:\sandbox|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:
- {{tlxTemplate:\sandbox|tlx|Template|<nowiki>''first''|''second''|''third=value''|...|''999th''</nowiki>}} produces: {{tlxTemplate:\sandbox|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 |
. 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 Template:Para at the end of the parameter list.
- Exceptions
If the intended template lists numerous parameters, then perhaps this template should really Template:Em 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 Template:Param, i.e. a template's name,
{{tlx}}
's output is the same as{{tl}}
– i.e. a link within braces – but in a monospaced font:{{tl|tl}}
produces: {{tl}}{{tlx|tl}}
produces: {{tlxTemplate:\sandbox|tl}}
{{tl}}
will also not take nor display additional parameters.
- Named parameters
- 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, {{tlxTemplate:\sandbox|tlx|Welcome|3=subst=Y}} produces: {{tlxTemplate:\sandbox|Welcome|subst=Y}}. This is similar to the action of the {{tlxTemplate:\sandbox|tlxs}} template: {{tlxTemplate:\sandbox|tlxs|Welcome}} produces: Template:Tlxs.
- For an interwiki link to other sister projects, such as: Template:Para (Meta), Template:Para (WikiQuote), Template:Para (WikiSource), etc, facilitating interwiki template documentation and/or discussion.
- For a link to Wikipedias in other languages, such as: Template:Para (German), Template:Para (Swedish), etc, facilitating cross-language template documentation and/or discussion.
Documentation
{{Template:Template link expanded}} 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 "Template:Thin space{Template:Thin space", "Template:Thin space|Template:Thin space", "Template:Thin space}Template:Thin space" 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
- Note
- At the en.wikipedia and Meta sites, 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.
- Unlimited parameters as one
<nowiki>...</nowiki>
string - {{tlxTemplate:\sandbox|tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}
TemplateData
Template:Collapse top Template:TemplateData header
Show example template usage without expanding the template itself. {{tnull}} is similar without linking the template.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Template name | 1 | Name of the template to link.
| Template | required |
1st parameter | 2 | no description | String | optional |
2nd parameter | 3 | no description | String | optional |
3rd parameter | 4 | no description | String | optional |
4th parameter | 5 | no description | String | optional |
5th parameter | 6 | no description | String | optional |
6th parameter | 7 | no description | String | optional |
7th parameter | 8 | no description | String | optional |
8th parameter | 9 | no description | String | optional |
9th parameter | 10 | no description | String | optional |
10th parameter | 11 | no description | String | optional |
11th parameter | 12 | no description | String | optional |
12th parameter | 13 | no description | String | optional |
13th parameter | 14 | no description | String | optional |
14th parameter | 15 | no description | String | optional |
15th parameter | 16 | no description | String | optional |
16th parameter | 17 | no description | String | optional |
17th parameter | 18 | no description | String | optional |
18th parameter | 19 | no description | String | optional |
19th parameter | 20 | no description | String | optional |
20th parameter | 21 | no description | String | optional |
Show subst: | subst | Set to any value to show "subst:" before the template name
| Boolean | optional |
Language | LANG | The prefix for a link to Wikipedias in other languages.
| Line | optional |
Sister project | SISTER | The prefix for an interwiki link to other sister projects
| Line | optional |
See also
- {{tlxb}}, a version of Template:Tlf where the template name is shown in bold.
- {{tlb}}, a version of Template:Tlf where the template name is shown in bold.
- {{temt}}, a version of Template:Tlf 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. Template:Para, Template:Para).
- {{tnull}}, like Template:Tnull without linking the template.