Template:Template link general/doc
| This is a documentation subpage for Template:Template link general. It contains usage information, categories and other content that is not part of the original template page. |
| File:Lua-Logo.svg | This template uses Lua: |
| Warning | This template is used on approximately 7,500 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, often abbreviated as Template:Tlnull, is used to provide stylized formatting to template displays without actually using the template itself. The code generated will be displayed inline.
Parameters
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 | {{Min|7|-5}} | |
| _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)
This template can take any number of unnamed parameters as parameters accompanying the template link (or name); see Examples below.
Examples
Use the displayed value in the code column, not the underlying source code.
- Note
- On the source sister projects, en.wikipedia and Meta, 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.
| Code | Output | Remarks |
|---|---|---|
{{tlg|Banner}} | {{Banner}} | Template:Banner does not exist. (Non-existent template is redlinked.) |
{{tlg|Abc}} | {{Abc}} | Template:Abc exists. |
{{tlg|abC}} | {{abC}} | Template names are case-sensitive |
{{tlg|abc}} | {{abc}} | (but the first letter is case-insensitive). |
{{tlg|x0}} | {{x0}} | no parameters |
{{tlg|x1|one}} | {{x1|one}} | one parameter |
{{tlg|x2|one|two}} | {{x2|one|two}} | two parameters |
{{tlg|x2|2=one=1|3=two=2}} | {{x2|one=1|two=2}} | two parameters, assigned values |
{{tlg|x3|1|2|3|4|5|6|7|8|9|10}} | {{x3|1|2|3|4|5|6|7|8|9|10}} | ten parameters |
{{tlg|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. |
{{tlg|x2|two}} | {{x2||two||}} | Empty parameters are discarded. |
{{tlg|x0|code=on}} | {{x0}} | <code> style |
{{tlg|x0|plaincode=on}} | {{x0}} | plaincode style |
{{tlg|x0|kbd=on}} | {{x0}} | <kbd> style |
{{tlg|x0|bold=on}} | {{x0}} | bold link/name |
{{tlg|x1|one|italic=on}} | {{x1|one}} | parameter(s) in italics |
{{tlg|x0|nolink=on}} | {{x0}} | |
{{tlg|x0|subst=on}} | {{subst:x0}} | |
{{tlg|x0|brace=on}} | {{x0}} | all braces in link |
{{tlg|x0|braceinside=on}} | {{x0}} | inside braces in link |
{{tlg|x0|alttext=x0 link}} | {{x0 link}} | |
{{tlg|x0|bold=on|code=on|brace=on}} | {{x0}} | Combine multiple parameter settings. |
{{tlg|abc|Template:((spaces}}oneTemplate:((spaces}}}} | {{abc|<span class="nowrap"> </span>one<span class="nowrap"> </span>}} | Using {{spaces}} before and after a parameter. |
{{tlg|x2|bold=on|code=on|one|two}} | {{x2|one|two}} | Can combine named and anonymous parameters ... |
{{tlg|x2|one|two|bold=on|code=on}} | {{x2|one|two}} | ... in any order ... |
{{tlg|x2|one|code=on|two|bold=on|three}} | {{x2|one|two|three}} | ... even intermixed ... |
{{tlg|x2|one|code=on|two|bold=on|three|italic=on}} | {{x2|one|two|three}} | ... with many configurations. |
{{tlg|x1|x=u}} | {{x1}} | = won't work |
{{tlg|x1|x=u}} | {{x1|x=u}} | = is okay |
{{tlg|x1|x{{=}}u}} | {{x1|x=u}} | {{=}} is okay (see Template:=) |
{{tlg|x1|2=x=u}} | {{x1|x=u}} | Numbered parameter is okay |
{{tlg|x1|x<nowiki>=</nowiki>u}} | {{x1|x=u}} | Sticky nowiki is okay. |
{{tlg|x2|3=two|2=one}} | {{x2|one|two}} | Right-to-left is okay |
{{tlg}} | tlg | With no arguments, it emits the current page name without braces. |
{{tlg|x2|3=one|4=two}} | {{x2|one|two}} | Null parameter stops parsing. |
{{tlg|x1||two}} | {{x1||two}} | Empty parameters are not diplayed. |
{{tlg|x2|2=|3=two}} | {{x2||two}} | Empty parameters are not diplayed. |
| Code | Output |
|---|---|
{{tlg|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 |
|---|---|
{{tlg|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 |
|---|---|
{{tlg|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
TemplateData for Template link general
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
Template:Template-linking templates Template:Semantic markup templates