Template:Template link general/doc
Appearance
This is a documentation subpage for Template:Template link general It may contain usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
This template, often abbreviated as {{Tlg}}, is used to provide stylized formatting to template displays without actually using the template itself.
Parameters
[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 below for all alternate options.
Parameter | Action | Use with {{Example}} |
Default active |
---|---|---|---|
Default (without accessory parameters) | {{Example}} | ||
brace | Include braces as part of the template link | {{Example}} | |
braceinside | Include innermost braces as part of the template link | {{Example}} | |
bold | Renders the template link/name in bold | {{Example}} | |
code | Display output using HTML <code>...</code> tags (monospaced font) |
{{Example}} |
{{Template link expanded}} |
italic | Display any parameters accompanying the template link/name in italics | {{Example|param}} | |
kbd | Display output using HTML <kbd>...</kbd> tags (monospaced font) |
{{Example}} | |
nolink | Don't render the template name as a link | {{Example}} | {{Tlf}} |
nowrap | Prevent the insertion of line breaks (word wrap) in the output | {{Example}} | |
nowrapname | Prevent word wrapping in the output of template name/link (parameters will wrap if needed) | {{Example}} | |
plaincode | Uses <code style="background: transparent; border: none;">...</code> |
{{Example}} |
|
subst | Include a subst: prefix before the template link/name | {{subst:Example}} | {{Tls}}, {{Tlxs}}, etc. |
|alttext=[text] |
Use [text] as the label for the template link | {{Other}} | |
_show_result | Will also display the result of the template. | {{Min|7|-5}} → -5 |
|
_expand | Will add a link to the expanded template page. | {{Min|7|-5}} [1] |
Unnamed (Positional)
[edit source]This template can take any number of unnamed parameters as parameters accompanying the template link (or name); see Examples below.
Examples
[edit source]Code | Output | Remarks |
{{Template link general|Banner}} | {{Banner}} | Banner template does not exist. Be aware with linking to non-existing templates. |
{{Template link general|Ok}} | {{Ok}} | Ok template does exist |
{{Template link general|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 |
{{Template link general|Abbr}} | {{Abbr}} | |
{{Template link general|AbbR}} | {{AbbR}} | Template names are case-sensitive. |
{{Template link general|abbr}} | {{abbr}} | The first letter in template names is case-insensitive, though. |
{{Template link general|Abbr|{{Spaces}}{{{1}}}{{Spaces}}}} | {{Abbr| {{{1}}} }} | Using {{Spaces}} before and after {{{1}}} parameter. |
{{Template link general|XCode}} | {{XCode}} | |
{{Template link general|XCode|code=on}} | {{XCode}} | <code> style |
{{Template link general|XCode|plaincode=on}} | {{XCode}} | Plaincode style |
{{Template link general|XCode|kbd=on}} | {{XCode}} | <kbd> style |
{{Template link general|XCode|bold=on}} | {{XCode}} | Bold link/name |
{{Template link general|XCode|one|italic=on}} | {{XCode|one}} | Parameter(s) in italics |
{{Template link general|XCode|nolink=on}} | {{XCode}} | |
{{Template link general|XCode|subst=on}} | {{subst:XCode}} | |
{{Template link general|XCode|brace=on}} | {{XCode}} | All braces in link |
{{Template link general|XCode|braceinside=on}} | {{XCode}} | Only inside braces in link |
{{Template link general|XCode|alttext=XCode link}} | {{XCode link}} | |
{{Template link general|XCode|bold=on|code=on|brace=on}} | {{XCode}} | No reason you can't combine multiple parameter settings. |
{{Template link general|XCode|one}} | {{XCode|one}} | |
{{Template link general|XCode|one|two}} | {{XCode|one|two}} | |
{{Template link general|XCode|bold=on|code=on|one|two}} | {{XCode|one|two}} | Can combine named and positional/unnamed parameters without issue… |
{{Template link general|XCode|one|two|bold=on|code=on}} | {{XCode|one|two}} | …in any order… |
{{Template link general|XCode|one|code=on|two|bold=on|three}} | {{XCode|one|two|three}} | …even intermixed… |
{{Template link general|XCode|one|code=on|two|bold=on|three|italic=on}} | {{XCode|one|two|three}} | …with many different configurations. |
{{Template link general|XCode|1|2|3|4|5|6|7|8|9|10}} | {{XCode|1|2|3|4|5|6|7|8|9|10}} | |
{{Template link general}} | Template link general | With no arguments, the current page name is substituted. |
{{Template link general|XCode|x=u}} | {{XCode}} | Using = won't work. |
{{Template link general|XCode|x=u}} | {{XCode|x=u}} | But = works fine. |
{{Template link general|XCode|x{{=}}u}} | {{XCode|x=u}} | The common shortcut {{=}} is okay too. (See Template equal sign) |
{{Template link general|XCode|x<nowiki>=</nowiki>u}} | {{XCode|x=u}} | Sticky nowiki is okay, too. |
{{Template link general|XCode||two||}} | {{XCode|two}} | Empty parameters work too, even at the end! |
{{Template link general|XCode|3=two|2=one}} | {{XCode|one|two}} | Even right-to-left is A-okay. |
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}} |