Template:Tlg/doc: Difference between revisions
no edit summary
(Created page with "<includeonly><!-- -->{{#if:{{{nowrap|}}} |<span class="nowrap">}}<!-- -->{{#if:{{{code|{{{tt|}}}}}} |<code> |{{#if:{{{plaincode|}}}|<code style="border:none;backgroun...") |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
Line 1:
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->
{{tl|tlg}} (abbreviating "[t]emplate [l]ink {{small|(with)}} [g]eneral {{small|(options)}}") is a generalised version of the {{tl|tl}} ("template link") template. It can be used to replace or implement {{tlf|tl}} and related templates such as {{tl|tlb}}, {{tl|tlx}}, etc.
===Parameters===
====Named====
With the exception of {{mono|alttext}}, {{tlf|tlg}}'s 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 (see Examples below):
{| class="wikitable"
! Parameter || Action || As in
|-
| braceinside || Include innermost braces as part of the template link || {{tl|tlw}}
|-
| bold<br/>boldlink<br/>boldname || Renders the template link/name in '''bold''' || {{tl|tlb}}, {{tl|tlx}}, etc.
|-
| code || Display output using HTML [[HTML element#code|{{tag|code}}]] tags ([[monospaced font]]) || {{tl|tlc}}, {{tl|tlx}}, etc.
|-
| plaincode || Uses {{tag|code|params=style="border:none; background:transparent;"}} ||
|-
| kbd || Display output using HTML [[HTML element#kbd|{{tag|kbd}}]] tags (monospaced font) || {{tl|tltt}}, {{tl|tltt2}}, etc.
|-
| italic<br/>italics || Display any parameters accompanying the template link/name in ''italic/s'' || {{tl|tlxi}}
|-
| nolink || Don't render the template name as a link || {{tl|tln}}
|-
| nowrap || Prevent the insertion of line breaks ([[word wrap]]) in the output || {{tl|tlp}}, {{tl|tlf}}, etc.
|-
| nowrapname || Prevent word wrapping in the output of template name/link (parameters will wrap if needed) ||
|-
| subst || Include a [[Help:Substitution|subst:]] prefix before the template link/name || {{tl|tls}}
|-
| <nowiki>|alttext=[text]</nowiki> || Use [text] as the label for the template link || {{tl|tla}}
|}
====Unnamed====
{{tlf|tlg}} may take up to ten unnamed parameters as parameters accompanying the template link (or name); see Examples below.
===Examples===
{{#switch:{{SITENAME}} |Wikipedia|Meta= |
; 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.
}}
{| class="wikitable" |style="border:1; cellpadding:4; background-color:transparent;"
|+ style="text-align:left;" | Wrapping of long names (default)
|-
! Code
! style="width:15em;" | Output
|-
| {{tlx|tlg|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}}
|}
{| class="wikitable" |style="border:1; cellpadding:4; background-color:transparent;"
|+ style="text-align:left;" | Wrapping of long names (<kbd>nowrap=on</kbd>)
|-
! Code
! style="width:15em;" | Output
|-
| {{tlx|tlg|nowrap{{=}}on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}}
| {{tlg|nowrap=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}}
|}
{| class="wikitable" |style="border:1; cellpadding:4; background-color:transparent;"
|+ style="text-align:left;" | Wrapping of long names (<kbd>nowrapname=on</kbd>)
|-
! Code
! style="width:15em;" | Output
|-
| {{tlx|tlg|nowrapname{{=}}on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}}
| {{tlg|nowrapname=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}}
|}
== See also ==
{{Template-linking templates}}
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
[[Category:Internal template-link templates]]
[[Category:Typing-aid templates]]
}}</includeonly>
| |||