Template:Template link general/doc: Difference between revisions

From the Croc Wiki, the Croc encyclopedia
Jump to navigationJump to search
Content added Content deleted
m (→‎See also: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other)
 
(45 intermediate revisions by 15 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->
{{#ifeq:{{FULLPAGENAME}}|Template:Template link expanded|{{used in system}}|
{{lua|Module:Tlg}}
{{#ifexpr:{{#invoke:Transclusion count|fetch|0}} > 2000|{{high-use}}}}}}
{{tsh|{{{1|tlg}}}|{{{2|}}}}}
{{lua|Module:Template link general}}


This template, often abbreviated as {{tlf|{{#switch:{{lc:{{ROOTPAGENAME}}}}
{{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.
| tlg | template link general = tlg
| tlb | template link with bold = tlb
| tlc | template link code = tlc
| tlw ||template link with linked braces = tlw
| tlf | template link with link off = tlf
| tltss | template link with title span, subst = tltss
| tlx | template link expanded = tlx
| tlxb | template link expanded with bold = tlxb
| tlxi | template link expanded with italic = tlxi
| tlxs | template link expanded with subst = tlxs
| tls | template link with subst = tls
| tnull | template link null = tnull
| tlp | template link with parameters = tlp}}
}}, is used to provide stylized formatting to template displays without actually using the template itself.


===Parameters===
===Parameters===
With the exception of {{mono|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 ([[#Examples|see Examples below]]). Certain templates have the parameter "on" by default; see [[#General-purpose formatting|the main table]] for all alternate options.
====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"
{| class="wikitable"
! Parameter || Action || As in
! Parameter || Action || Use with<br>{{t|example}} || Default active
|-
|-
| brace || Include braces as part of the template link ||
| brace || Include braces as part of the template link || {{tlg|brace=yes|example}} || {{tl|tlw}}/{{tl|tn}}
|-
|-
| braceinside || Include innermost braces as part of the template link || {{tl|tlw}}
| braceinside || Include innermost braces as part of the template link || {{tlg|example|braceinside=yes}} ||
|-
|-
| bold<br/>boldlink<br/>boldname || Renders the template link/name in '''bold''' || {{tl|tlb}}, {{tl|tlx}}, etc.
| bold || Renders the template link/name in '''bold''' || {{tlg|bold=yes|example}} || {{tl|tlb}}, {{tl|tlxb}}
|-
|-
| code || Display output using HTML [[HTML element#code|{{tag|code}}]] tags ([[monospaced font]]) || {{tl|tlc}}, {{tl|tlx}}, etc.
| code || Display output using HTML [[HTML element#code|{{tag|code}}]] tags ([[monospaced font]]) || {{tlg|code=yes|example}} || {{tl|tlc}}, {{tl|Template link expanded}}, etc.
|-
|-
| italic || Display any parameters accompanying the template link/name in ''italics'' ||| {{tlg|italic=yes|example|param}} || {{tl|tlxi}}
| 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.
| kbd || Display output using HTML [[HTML element#kbd|{{tag|kbd}}]] tags (monospaced font) || {{tlg|kbd=yes|example}} ||
|-
|-
| 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 || {{tlg|nolink=yes|example}} || {{tl|tlf}}, {{t|tnull}}
|-
|-
| nolink || Don't render the template name as a link || {{tl|tlf}}
| nowrap || Prevent the insertion of line breaks ([[word wrap]]) in the output || {{tlg|nowrap=yes|example}} ||
|-
|-
| 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) || {{tlg|nowrapname=yes|example}} ||
|-
|-
| plaincode || Uses {{tag|code|params=style="border:none; background:transparent;"}} || {{tlg|plaincode=yes|example}} || {{tl|tltss}}
| 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}}
| subst || Include a [[Help:Substitution|subst:]] prefix before the template link/name || {{tlg|subst=yes|example}} || {{tl|tls}}, {{tl|tlxs}}, etc
|-
|-
| <nowiki>|alttext=[text]</nowiki> || Use [text] as the label for the template link || {{tl|tla}}
| {{para|alttext|[text]}} || Use [text] as the label for the template link || {{tlg|alttext=Other|example}} || {{tl|tla}}
|-
| _show_result || Will also display the result of the template. || {{tlx|Min|7|-5|_show_result=y}} ||
|}
|}


====Unnamed====
====Unnamed (Positional)====
{{tlf|tlg}} may take up to ten unnamed parameters as parameters accompanying the template link (or name); see Examples below.
This template can take any number of [[unnamed parameter]]s as parameters accompanying the template link (or name); see Examples below.


===Examples===
===Examples===
Line 43: Line 62:
; 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.
; 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.
}}
}}

{{Aligned table
{{Aligned table
|cols=3 |class=wikitable
|cols=3 |class=wikitable
|style=border:1;cellpadding:4;background-color:transparent;<!-- to see background of <code>...</code> -->
|style=background-color:transparent;<!-- to see background of <code>...</code> -->
| '''Code''' | '''Output''' | '''Remarks'''
| '''Code''' | '''Output''' | '''Remarks'''
| {{tlx|tlg|Abc}} | {{tlg|Abc}} |
| {{tlx|{{{1|tlg}}}|Banner}} | {{{{{1|tlg}}}|Banner}} | {{error|Banner}} template does not exist. Be aware with linking to non-existing templates, although desired.
| {{tlx|tlg|abC}} | {{tlg|abC}} | template names are case-sensitive
| {{tlx|{{{1|tlg}}}|ok}} | {{{{{1|tlg}}}|ok}} | ok template does exist
| {{tlx|{{{1|tlg}}}|convert|<nowiki>&lt;nowiki>14|m|ftin|abbr=out|sp=us&lt;/nowiki></nowiki>}} | {{{{{1|tlg}}}|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}} | Unlimited parameters as one {{tag|nowiki|link=yes}} [[Help:Wikitext#Nowiki|string]]
| {{tlx|tlg|abc}} | {{tlg|abc}} | first letter is case-insensitive though
| {{tlx|tlg|x0}} | {{tlg|x0}} |
| {{tlx|{{{1|tlg}}}|Abc}} | {{{{{1|tlg}}}|Abc}} |
| {{tlx|tlg|x0|code{{=}}on}} | {{tlg|x0|code=on}} | &lt;code&gt; style
| {{tlx|{{{1|tlg}}}|abC}} | {{{{{1|tlg}}}|abC}} | template names are case-sensitive
| {{tlx|tlg|x0|plaincode{{=}}on}} | {{tlg|x0|plaincode=on}} | plaincode style
| {{tlx|{{{1|tlg}}}|abc}} | {{{{{1|tlg}}}|abc}} | first letter is case-insensitive though
| {{tlx|{{{1|tlg}}}|abc|'''<nowiki>{{spaces}}</nowiki>'''{{{1}}}'''<nowiki>{{spaces}}</nowiki>'''}} | {{{{{1|tlg}}}|abc|{{spaces}}{{{1}}}{{spaces}}}}| Using {{tl|spaces}} before and after <nowiki>{{{1}}}</nowiki> parameter.
| {{tlx|tlg|x0|kbd{{=}}on}} | {{tlg|x0|kbd=on}} | &lt;kbd&gt; style
| {{tlx|tlg|x0|bold{{=}}on}} | {{tlg|x0|bold=on}} | bold link/name
| {{tlx|{{{1|tlg}}}|x0}} | {{{{{1|tlg}}}|x0}} |
| {{tlx|tlg|x1|one|italic{{=}}on}} | {{tlg|x1|one|italic=on}} | parameter/s in italics
| {{tlx|{{{1|tlg}}}|x0|code{{=}}on}} | {{{{{1|tlg}}}|x0|code=on}} | &lt;code&gt; style
| {{tlx|tlg|x0|nolink{{=}}on}} | {{tlg|x0|nolink=on}} |
| {{tlx|{{{1|tlg}}}|x0|plaincode{{=}}on}} | {{{{{1|tlg}}}|x0|plaincode=on}} | plaincode style
| {{tlx|tlg|x0|subst{{=}}on}} | {{tlg|x0|subst=on}} |
| {{tlx|{{{1|tlg}}}|x0|kbd{{=}}on}} | {{{{{1|tlg}}}|x0|kbd=on}} | &lt;kbd&gt; style
| {{tlx|tlg|x0|brace{{=}}on}} | {{tlg|x0|brace=on}} | all braces in link
| {{tlx|{{{1|tlg}}}|x0|bold{{=}}on}} | {{{{{1|tlg}}}|x0|bold=on}} | bold link/name
| {{tlx|tlg|x0|braceinside{{=}}on}} | {{tlg|x0|braceinside=on}} | inside braces in link
| {{tlx|{{{1|tlg}}}|x1|one|italic{{=}}on}} | {{{{{1|tlg}}}|x1|one|italic=on}} | parameter/s in italics
| {{tlx|tlg|x0|alttext{{=}}x0 link}} | {{tlg|x0|alttext=x0 link}} |
| {{tlx|{{{1|tlg}}}|x0|nolink{{=}}on}} | {{{{{1|tlg}}}|x0|nolink=on}} |
| {{tlx|tlg|x0|bold{{=}}on|code{{=}}on|brace{{=}}on}} | {{tlg|x0|bold=on|code=on|brace=on}} | No reason you can't combine multiple parameter settings
| {{tlx|{{{1|tlg}}}|x0|subst{{=}}on}} | {{{{{1|tlg}}}|x0|subst=on}} |
| {{tlx|tlg|x1|one}} | {{tlg|x1|one}} |
| {{tlx|{{{1|tlg}}}|x0|brace{{=}}on}} | {{{{{1|tlg}}}|x0|brace=on}} | all braces in link
| {{tlx|tlg|x2|one|two}} | {{tlg|x2|one|two}} |
| {{tlx|{{{1|tlg}}}|x0|braceinside{{=}}on}} | {{{{{1|tlg}}}|x0|braceinside=on}} | inside braces in link
| {{tlx|tlg|x2|bold{{=}}on|code{{=}}on|one|two}} | {{tlg|x2|bold=on|code=on|one|two}} | Can combine named and anonymous parameters …
| {{tlx|{{{1|tlg}}}|x0|alttext{{=}}x0 link}} | {{{{{1|tlg}}}|x0|alttext=x0 link}} |
| {{tlx|tlg|x2|one|two|bold{{=}}on|code{{=}}on}} | {{tlg|x2|one|two|bold=on|code=on}} | in any order
| {{tlx|{{{1|tlg}}}|x0|bold{{=}}on|code{{=}}on|brace{{=}}on}} | {{{{{1|tlg}}}|x0|bold=on|code=on|brace=on}} | No reason you can't combine multiple parameter settings
| {{tlx|tlg|x2|one|code{{=}}on|two|bold{{=}}on|three}} | {{tlg|x2|one|code=on|two|bold=on|three}} | even intermixed
| {{tlx|{{{1|tlg}}}|x1|one}} | {{{{{1|tlg}}}|x1|one}} |
| {{tlx|tlg|x2|one|code{{=}}on|two|bold{{=}}on|three|italic{{=}}on}} | {{tlg|x2|one|code=on|two|bold=on|three|italic=on}} | with many different configurations.
| {{tlx|{{{1|tlg}}}|x2|one|two}} | {{{{{1|tlg}}}|x2|one|two}} |
| {{tlx|tlg|x3|1|2|3|4|5|6|7|8|9&#124;10}} | {{tlg|x3|1|2|3|4|5|6|7|8|9|10}} |
| {{tlx|{{{1|tlg}}}|x2|bold{{=}}on|code{{=}}on|one|two}} | {{{{{1|tlg}}}|x2|bold=on|code=on|one|two}} | Can combine named and anonymous parameters
| {{tlx|tlg|x4|1|2|3|4|5|6|7|8|9&#124;10&#124;11}} | {{tlg|x4|1|2|3|4|5|6|7|8|9|10|11}} | up to 10 parameters, then
| {{tlx|{{{1|tlg}}}|x2|one|two|bold{{=}}on|code{{=}}on}} | {{{{{1|tlg}}}|x2|one|two|bold=on|code=on}} | in any order
| {{tlx|{{{1|tlg}}}|x2|one|code{{=}}on|two|bold{{=}}on|three}} | {{{{{1|tlg}}}|x2|one|code=on|two|bold=on|three}} | … even intermixed …
| {{tlx|tlg|x5|1|2|3|4|5|6|7|8|9&#124;10&amp;#124;11}} | {{tlg|x5|1|2|3|4|5|6|7|8|9|10&#124;11}} | {{align|right|<code>&amp;#124;</code> for more}}
| {{tlx|{{{1|tlg}}}|x2|one|code{{=}}on|two|bold{{=}}on|three|italic{{=}}on}} | {{{{{1|tlg}}}|x2|one|code=on|two|bold=on|three|italic=on}} | … with many different configurations.
| {{tlx|tlg}} | {{tlg}} | with no arguments, the current page name is substituted
| {{tlx|tlg|x1|x&#61;u}} | {{tlg|x1|x=u}} | '''{{=}}''' won't work
| {{tlx|{{{1|tlg}}}|x3|1|2|3|4|5|6|7|8|9|10}} | {{{{{1|tlg}}}|x3|1|2|3|4|5|6|7|8|9|10}} |
| {{tlx|tlg|x1|x&amp;#61;u}} | {{tlg|x1|x&#61;u}} | {{align|right|<code>&amp;#61;</code> is okay}}
| {{tlx|{{{1|tlg}}}}} | {{{1|tlg}}} | with no arguments, the current page name is substituted
| {{tlx|tlg|x1|x<nowiki>{{=}}</nowiki>u}} | {{tlg|x1|x{{=}}u}} | {{align|right|<code><nowiki>{{=}}</nowiki></code> is okay}}
| {{tlx|{{{1|tlg}}}|x1|x&#61;u}} | {{{{{1|tlg}}}|x1|x=u}} | '''{{=}}''' won't work
| {{tlx|tlg|x1|x&lt;nowiki&gt;&#61;&lt;/nowiki&gt;u}} | {{tlg|x1|x<nowiki>=</nowiki>u}} | {{align|right|sticky nowiki is okay}}
| {{tlx|{{{1|tlg}}}|x1|x&amp;#61;u}} | {{{{{1|tlg}}}|x1|x&#61;u}} | {{align|right|<code>&amp;#61;</code> is okay}}
| {{tlx|tlg|x2|<nowiki />|two|<nowiki />|<nowiki />}} | {{tlg|x2||two||}} | empty parameters work too, even at the end
| {{tlx|{{{1|tlg}}}|x1|x<nowiki>{{=}}</nowiki>u}} | {{{{{1|tlg}}}|x1|x{{=}}u}} | {{align|right|<code><nowiki>{{=}}</nowiki></code> is okay (see [[:template:=|template equal sign]])}}
| {{tlx|tlg|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}} | {{tlg|x2|3=two|2=one}} | {{align|right|right to left okay}}
| {{tlx|{{{1|tlg}}}|x1|x&lt;nowiki&gt;&#61;&lt;/nowiki&gt;u}} | {{{{{1|tlg}}}|x1|x<nowiki>=</nowiki>u}} | {{align|right|sticky nowiki is okay}}
| {{tlx|tlg|convert|<nowiki>&lt;nowiki>14|m|ftin|abbr=out|sp=us&lt;/nowiki></nowiki>}} | {{tlg|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}} | Unlimited parameters as one nowiki string
| {{tlx|{{{1|tlg}}}|x2|<nowiki />|two|<nowiki />|<nowiki />}} | {{{{{1|tlg}}}|x2||two||}} | empty parameters work too, even at the end
| {{tlx|{{{1|tlg}}}|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}} | {{{{{1|tlg}}}|x2|3=two|2=one}} | {{align|right|right to left okay}}
}}
}}


{| class="wikitable" |style="border:1; cellpadding:4; background-color:transparent;"
{| class="wikitable" |style="background-color:transparent;"
|+ style="text-align:left;" | Wrapping of long names (default)
|+ style="text-align:left;" | Wrapping of long names (default)
|-
|-
Line 87: Line 108:
! style="width:15em;" | Output
! 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}}
| {{tlx|{{{1|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}}
| {{{{{1|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;"
{| class="wikitable" |style="background-color:transparent;"
|+ style="text-align:left;" | Wrapping of long names (<kbd>nowrap=on</kbd>)
|+ style="text-align:left;" | Wrapping of long names (<kbd>nowrap=on</kbd>)
|-
|-
Line 97: Line 118:
! style="width:15em;" | Output
! 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}}
| {{tlx|{{{1|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}}
| {{{{{1|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;"
{| class="wikitable" |style="background-color:transparent;"
|+ style="text-align:left;" | Wrapping of long names (<kbd>nowrapname=on</kbd>)
|+ style="text-align:left;" | Wrapping of long names (<kbd>nowrapname=on</kbd>)
|-
|-
Line 107: Line 128:
! style="width:15em;" | Output
! 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}}
| {{tlx|{{{1|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}}
| {{{{{1|tlg}}}|nowrapname=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}}
|}
|}


Line 117: Line 138:
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
[[Category:Internal template-link templates]]
[[Category:Internal template-link templates]]
[[Category:Typing-aid templates]]
[[Category:Wikitext typing-aid templates]]
}}</includeonly>
}}</includeonly>

Latest revision as of 15:03, January 29, 2022

This template, often abbreviated as {{tlg}}, is used to provide stylized formatting to template displays without actually using the template itself.

Parameters

With the exception of Template:Mono, 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.

Parameter Action Use with
{{example}}
Default active
brace Include braces as part of the template link {{Template:!((:Template:Example|example]]}} {{tlw}}/{{tn}}
braceinside Include innermost braces as part of the template link Template:!((:Template:Example|{{example}}]]
bold Renders the template link/name in bold {{Template:!((:Template:Example|example]]}} {{tlb}}, {{tlxb}}
code Display output using HTML <code>...</code> tags (monospaced font) {{Template:!((:Template:Example|example]]}} {{tlc}}, {{Template link expanded}}, etc.
italic Display any parameters accompanying the template link/name in italics {{Template:!((:Template:Example|example]]|param}} {{tlxi}}
kbd Display output using HTML <kbd>...</kbd> tags (monospaced font) {{Template:!((:Template:Example|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 {{Template:!((:Template:Example|example]]}}
nowrapname Prevent word wrapping in the output of template name/link (parameters will wrap if needed) {{Template:!((:Template:Example|example]]}}
plaincode Uses <code style="border:none; background:transparent;">...</code> {{Template:!((:Template:Example|example]]}} {{tltss}}
subst Include a subst: prefix before the template link/name {{subst:Template:!((:Template:Example|example]]}} {{tls}}, {{tlxs}}, etc
|alttext=[text] Use [text] as the label for the template link {{Template:!((:Template:Example|Other]]}} {{tla}}
_show_result Will also display the result of the template. {{Min|7|-5}} → -5

Unnamed (Positional)

This template can take any number of unnamed parameters as parameters accompanying the template link (or name); see Examples below.

Examples

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.

Script error: No such module "aligned table".

Wrapping of long names (default)
Code Output
{{tlg|long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}} {{Template:!((:Template:Long template name that would wrap to new line|long template name that would wrap to new line]]|this is a long value for the 1st parameter that would wrap}}
Wrapping of long names (nowrap=on)
Code Output
{{tlg|nowrap=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} {{Template:!((:Template:Long template name that would wrap to new line|long template name that would wrap to new line]]|long value for the 1st parameter that would wrap}}
Wrapping of long names (nowrapname=on)
Code Output
{{tlg|nowrapname=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} {{Template:!((:Template:Long template name that would wrap to new line|long template name that would wrap to new line]]|long value for the 1st parameter that would wrap}}

See also

Template:Template-linking templates