Difference between revisions of "Template:Tlg/doc"
From Summertime Saga Wiki
m |
m (→Examples) |
||
(5 intermediate revisions by the same user not shown) | |||
Line 16: | Line 16: | ||
; {{para|nowrapname}} : Prevent word wrapping in the output of template name/link (parameters will wrap if needed). | ; {{para|nowrapname}} : Prevent word wrapping in the output of template name/link (parameters will wrap if needed). | ||
; {{para|subst}} : Include a {{code|subst:}} prefix before the template link/name. | ; {{para|subst}} : Include a {{code|subst:}} prefix before the template link/name. | ||
− | ; {{para||alttext|{{var| | + | ; {{para||alttext|{{var|text}}}} : Use {{var|text}} as the label for the template link. |
=== Unnamed (positional) === | === Unnamed (positional) === | ||
Line 27: | Line 27: | ||
! Markup | ! Markup | ||
! Renders as | ! Renders as | ||
− | ! | + | ! Notes |
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| {{tlg|code=yes|nolink=yes|tlg|Template}} | | {{tlg|code=yes|nolink=yes|tlg|Template}} | ||
Line 43: | Line 39: | ||
| {{tlg|code=yes|nolink=yes|tlg|template}} | | {{tlg|code=yes|nolink=yes|tlg|template}} | ||
| {{tlg|template}} | | {{tlg|template}} | ||
− | | The first letter is | + | | The first letter is {{em|not}} case‐sensitive though. |
|- | |- | ||
| {{tlg|code=yes|nolink=yes|tlg|template|code{{=}}on}} | | {{tlg|code=yes|nolink=yes|tlg|template|code{{=}}on}} | ||
Line 144: | Line 140: | ||
! style="width:15em;" | Renders as | ! style="width:15em;" | Renders as | ||
|- | |- | ||
− | | {{tlg|code=yes|nolink=yes|tlg|long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}} | + | | {{tlg|code=yes|nolink=yes|tlg|nolink{{=}}yes|long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}} |
− | | {{tlg|long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}} | + | | {{tlg|nolink=yes|long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}} |
|} | |} | ||
{| class="wikitable" | {| class="wikitable" | ||
− | |+ Wrapping of long names ( | + | |+ Wrapping of long names ({{para|nowrap|yes}}) |
|- | |- | ||
! Markup | ! Markup | ||
! style="width:15em;" | Renders as | ! style="width:15em;" | Renders as | ||
|- | |- | ||
− | | {{tlg|code=yes|nolink=yes|tlg|nowrap{{=}} | + | | {{tlg|code=yes|nolink=yes|tlg|nowrap{{=}}yes|nolink{{=}}yes|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} |
− | | {{tlg|nowrap= | + | | {{tlg|nowrap=yes|nolink=yes|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} |
|} | |} | ||
{| class="wikitable" | {| class="wikitable" | ||
− | |+ Wrapping of long names ( | + | |+ Wrapping of long names ({{para|nowrapname|yes}}</kbd>) |
|- | |- | ||
! Markup | ! Markup | ||
! style="width:15em;" | Renders as | ! style="width:15em;" | Renders as | ||
|- | |- | ||
− | | {{tlg|code=yes|nolink=yes|tlg|nowrapname{{=}} | + | | {{tlg|code=yes|nolink=yes|tlg|nowrapname{{=}}yes|nolink{{=}}yes|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} |
− | | {{tlg|nowrapname= | + | | {{tlg|nowrapname=yes|nolink=yes|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} |
|} | |} | ||
[[Category:Templates]][[Category:Templates documentation]] | [[Category:Templates]][[Category:Templates documentation]] |
Latest revision as of 21:30, 22 July 2020
The template {{tlg}} (abbreviating “[t]emplate [l]ink (with) [g]eneral (options)”) is a generalised “template link” template.
Parameters
Named
With the exception of alttext, {{tlg}}
named parameters are toggles that are either omitted (default) or activated (by being assigned a value such as "on", "yes", "true", "include", etc.). They may be included in any order:
|bold=
- Renders the template link/name in bold.
|code=
- Display output using HTML
<code>…</code>
tags (monospaced font) |plaincode=
- Use
<code style="border:none; background:transparent;">…</code>
. |kbd=
- Display output using HTML
<kbd>…</kbd>
tags (monospaced font). |italic=
- Display any parameters accompanying the template link/name in italic.
|nolink=
- Don’t render the template name as a link.
|nowrap=
- Prevent the insertion of line breaks (word wrap) in the output.
|nowrapname=
- Prevent word wrapping in the output of template name/link (parameters will wrap if needed).
|subst=
- Include a
subst:
prefix before the template link/name. |alttext
- Use text as the label for the template link.
Unnamed (positional)
{{tlg}} may take up to ten unnamed parameters accompanying the template link (or name).
Examples
Markup | Renders as | Notes |
---|---|---|
{{tlg|Template}}
|
{{Template}} | “Template” template does exist. |
{{tlg|templatE}}
|
{{templatE}} | The template names are case‐sensitive. |
{{tlg|template}}
|
{{template}} | The first letter is not case‐sensitive though. |
{{tlg|template|code=on}}
|
{{template}}
|
Use <code> style.
|
{{tlg|template|plaincode=on}}
|
{{template}}
|
Use plaincode style. |
{{tlg|template|kbd=on}}
|
{{template}} | Use <kbd> style.
|
{{tlg|template|bold=on}}
|
{{template}} | Display link or name in bold. |
{{tlg|template|one|italic=on}}
|
{{template|one}} | Display parameters in italics. |
{{tlg|template|nolink=on}}
|
{{template}} | Do not link the template name presented |
{{tlg|template|subst=on}}
|
{{subst:template}} | |
{{tlg|template|alttext=template link}}
|
{{template link}} | |
{{tlg|template|bold=on|code=on|brace=on}}
|
{{template}}
|
Multiple parameter settings can be combined. |
{{tlg|template|one}}
|
{{template|one}} | |
{{tlg|template|one|two}}
|
{{template|one|two}} | |
{{tlg|template|bold=on|code=on|one|two}}
|
{{template|one|two}}
|
Named and unnamed parameters can be combined… |
{{tlg|template|one|two|bold=on|code=on}}
|
{{template|one|two}}
|
… in any order… |
{{tlg|template|one|code=on|two|bold=on|three}}
|
{{template|one|two|three}}
|
… even intermixed… |
{{tlg|template|one|code=on|two|bold=on|three|italic=on}}
|
{{template|one|two|three}}
|
… with many different configurations. |
{{tlg|template|1|2|3|4|5|6|7|8|9|10}}
|
{{template|1|2|3|4|5|6|7|8|9|10}} | |
{{tlg|template|1|2|3|4|5|6|7|8|9|10|11}}
|
{{template|1|2|3|4|5|6|7|8|9|10|…}} | Up to 10 parameters, then ellipsis. |
{{tlg}}
|
{{Template:Tlg/doc}} | With no arguments, the current page name is substituted |
{{tlg|template|x=u}}
|
{{template}} | Equals sign “=” won’t work |
{{tlg|template|x=u}}
|
{{template|x=u}} | &#61; Unicode is okay
|
{{tlg|template|x{{=}}u}}
|
{{template|x=u}} | {{=}} template is okay |
{{tlg|template|x<nowiki>=</nowiki>u}}
|
{{template|x=u}} | <nowiki>…</nowiki> tag is okay
|
{{tlg|template||two||}}
|
{{template||two||}} | Empty parameters work, even at the end. |
Markup | Renders as |
---|---|
{{tlg|nolink=yes|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}} |
Markup | Renders as |
---|---|
{{tlg|nowrap=yes|nolink=yes|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}} |
Markup | Renders as |
---|---|
{{tlg|nowrapname=yes|nolink=yes|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}} |