Template:Template link with parameters
| This template is used on approximately 68,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
| This template uses Lua: |
This template, often abbreviated as {{tlp}}, is used to provide stylized formatting to template displays without actually using the template itself. The code generated will be displayed inline.
Parameters
[kolera mu 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. If a row renders identically to a previous row, it means the current template does not support that option and {{tlg}} needs to be used instead.
| 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}} | {{tlf}}, {{tlp}} |
| 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] | Replace [text] with the actual label to be displayed for the template link | {{Other}} | {{tla}} |
| _show_result | Will also display the result of the template | Lua error: expandTemplate: template "Template:Min" does not exist. | |
| _expand | Will add a link to the expanded template page | {{Min|7|-5}} | |
| a | will add an asterisk before the template code | * {{Min|7|-5}} |
Unnamed (Positional)
[kolera mu edit source]This template can take any number of unnamed parameters as parameters accompanying the template link (or name); see Examples below.
Examples
[kolera mu edit source]Use the displayed value in the code column, not the underlying source code.
| Code | Output | Remarks |
|---|---|---|
{{tlp|Banner}} | {{Banner}} | Template:Banner does not exist. (Non-existent template is redlinked.) |
{{tlp|Abc}} | {{Abc}} | Template:Abc exists. |
{{tlp|abC}} | {{abC}} | Template names are case-sensitive |
{{tlp|abc}} | {{abc}} | (but the first letter is case-insensitive). |
{{tlp|x0}} | {{x0}} | no parameters |
{{tlp|x1|one}} | {{x1|one}} | one parameter |
{{tlp|x2|one|two}} | {{x2|one|two}} | two parameters |
{{tlp|x2|2=one=1|3=two=2}} | {{x2|one=1|two=2}} | two parameters, assigned values |
{{tlp|x3|1|2|3|4|5|6|7|8|9|10}} | {{x3|1|2|3|4|5|6|7|8|9|10}} | ten parameters |
{{tlp|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. |
{{tlp|x2|two}} | {{x2|two}} | Empty parameters are discarded. |
{{tlp|x0|code=on}} | {{x0}} | <code> style |
{{tlp|x0|plaincode=on}} | {{x0}} | plaincode style |
{{tlp|x0|kbd=on}} | {{x0}} | <kbd> style |
{{tlp|x0|bold=on}} | {{x0}} | bold link/name |
{{tlp|x1|one|italic=on}} | {{x1|one}} | parameter(s) in italics |
{{tlp|x0|nolink=on}} | {{x0}} | |
{{tlp|x0|subst=on}} | {{subst:x0}} | |
{{tlp|x0|brace=on}} | {{x0}} | all braces in link |
{{tlp|x0|braceinside=on}} | {{x0}} | inside braces in link |
{{tlp|x0|alttext=x0 link}} | {{x0 link}} | |
{{tlp|x0|bold=on|code=on|brace=on}} | {{x0}} | Combine multiple parameter settings. |
{{tlp|abc|{{spaces}}one{{spaces}}}} | {{abc| one }} | Using {{spaces}} before and after a parameter. |
{{tlp|x2|bold=on|code=on|one|two}} | {{x2|one|two}} | Can combine named and anonymous parameters ... |
{{tlp|x2|one|two|bold=on|code=on}} | {{x2|one|two}} | ... in any order ... |
{{tlp|x2|one|code=on|two|bold=on|three}} | {{x2|one|two|three}} | ... even intermixed ... |
{{tlp|x2|one|code=on|two|bold=on|three|italic=on}} | {{x2|one|two|three}} | ... with many configurations. |
{{tlp|x1|x=u}} | {{x1}} | = won't work |
{{tlp|x1|x=u}} | {{x1|x=u}} | = is okay |
{{tlp|x1|x{{=}}u}} | {{x1|x=u}} | {{=}} is okay (see Template:=) |
{{tlp|x1|2=x=u}} | {{x1|x=u}} | Numbered parameter is okay |
{{tlp|x1|x=u}} | {{x1|x=u}} | Sticky nowiki is okay. |
{{tlp|x2|3=two|2=one}} | {{x2|one|two}} | Right-to-left is okay |
{{tlp}} | tlp | With no arguments, it emits the current page name without braces. |
{{tlp|x2|3=one|4=two}} | {{x2}} | Null parameter stops parsing. |
| Code | Output |
|---|---|
{{tlp|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 |
|---|---|
{{tlp|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 |
|---|---|
{{tlp|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}} |
TemplateData
[kolera mu edit source]TemplateData for Template link with parameters
This template, often abbreviated as {{tlg}}, is used to provide stylized formatting to template displays without actually using the template itself. The code generated will be displayed inline.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Template name | 1 | no description | String | required |
| First parameter | 2 | First parameter of the template | Content | suggested |
| Second parameter | 3 | Second parameter of the template | Content | suggested |
| Third parameter | 4 | Third parameter of the template | Content | optional |
| Fourth parameter | 5 | Fourth parameter of the template | Content | optional |
| Fifth parameter | 6 | Fifth parameter of the template | Content | optional |
| Sixth parameter | 7 | Sixth parameter of the template | Content | optional |
| Seventh parameter | 8 | Seventh parameter of the template | Content | optional |
| Eigth parameter | 9 | Eigth parameter of the template | Content | optional |
| Ninth parameter | 10 | Ninth parameter of the template | Content | optional |
| brace | brace | Include braces as part of the template link | Boolean | optional |
| braceinside | braceinside | Include innermost braces as part of the template link | Boolean | optional |
| bold | bold | Renders the template link/name in bold | Boolean | optional |
| code | code | Display output using HTML <code>…</code> tags (monospaced font) | Boolean | optional |
| italic | italic | Display any parameters accompanying the template link/name in italics | Boolean | optional |
| kbd | kbd | Display output using HTML <kbd>...</kbd> tags (monospaced font) | Boolean | optional |
| nolink | nolink | Don't render the template name as a link | Boolean | optional |
| nowrap | nowrap | Prevent the insertion of line breaks (word wrap) in the output | Boolean | optional |
| nowrapname | nowrapname | Prevent word wrapping in the output of template name/link (parameters will wrap if needed) | Boolean | optional |
| plaincode | plaincode | Uses <code style="border:none; background:transparent;">...</code> | Boolean | optional |
| subst | subst | Include a subst: prefix before the template link/name | Boolean | optional |
| alttext | alttext | Label to be displayed for the template link | String | optional |
| _show_result | _show_result | Display the result of the template | Boolean | optional |
| _expand | _expand | Add a link to the expanded template page | Boolean | optional |
| a | a | Add an asterisk before the template code | Boolean | optional |
See also
[kolera mu edit source]Template:Template-linking templates Template:Semantic markup templates