Template:Template link general/doc: Difference between revisions
Template page
More actions
Update `name` parameter and add `shorthand=tlg` to {{TemplateBox}} |
Update page name of TemplateData localization values |
||
| Line 1: | Line 1: | ||
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> | <!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> | ||
{{TemplateBox | {{TemplateBox|name=Template link general|shorthand=Tlg|namespace=all|usergroup=all|useTemplateData=TNT:Template link general|1=1|1stat=required | ||
| name = | | mbox = <div style="float: right;"> | ||
| shorthand = | |||
| mbox = | |||
<div style="float:right;"> | |||
{{Uses TemplateStyles|Template:Mono/styles.css|Template:Nowrap/styles.css}} | {{Uses TemplateStyles|Template:Mono/styles.css|Template:Nowrap/styles.css}} | ||
{{Lua|Module:Template link general}} | {{Lua|Module:Template link general}}</div> | ||
</div> | {{Template shortcut|Tlg}} | ||
{{ | | desc-en = {{Tl|Tlg}} (abbreviating "[T]emplate [l]ink {{small|(with)}} [g]eneral {{small|(options)}}") is a generalized 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. | ||
| desc-en = | |||
{{ | |||
}} | }} | ||
=== Parameters === | === Parameters === | ||
==== Named ==== | ==== Named ==== | ||
With the exception of {{ | 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 ([[Template:Tlg#Examples|see Examples below]]): | ||
{| class="wikitable" | {| class="wikitable" | ||
! Parameter || Action || As in | ! Parameter || Action || As in | ||
|- | |- | ||
| brace || Include braces as part of the template link || | | brace || Include braces as part of the template link || | ||
|- | |- | ||
| braceinside || Include innermost braces as part of the template link || {{ | | braceinside || Include innermost braces as part of the template link || {{Tl|Tlw}} | ||
|- | |- | ||
| bold<br/>boldlink<br/>boldname || Renders the template link/name in '''bold''' || {{ | | 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|{{ | | code || Display output using HTML [[HTML element#code|{{Tag|code}}]] tags ([[monospaced font]]) || {{Tl|Tlc}}, {{Tl|Tlx}}, etc. | ||
|- | |- | ||
| plaincode || Uses {{ | | plaincode || Uses {{Tag|code|params=style="background-color: var(--background-color-base, #f8f9fa); border: none;"}} || | ||
|- | |- | ||
| kbd || Display output using HTML [[HTML element#kbd|{{ | | 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 | | italic<br/>italics || Display any parameters accompanying the template link/name in ''italic type'' || {{Tl|Tlxi}} | ||
|- | |- | ||
| nolink || Don't render the template name as a link || {{ | | nolink || Don't render the template name as a link || {{Tl|Tlf}} | ||
|- | |- | ||
| nowrap || Prevent the insertion of line breaks ([[word wrap]]) in the output || {{ | | 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) || | | 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 || {{ | | subst || Include a [[Help:Substitution|subst:]] prefix before the template link/name || {{Tl|Tls}} | ||
|- | |- | ||
| alttext={{Var|text}} || Use {{Var|text}} as the label for the template link || {{Tl|Tla}} | |||
|} | |} | ||
==== Unnamed (Positional) ==== | ==== Unnamed (Positional) ==== | ||
{{ | {{Tlf|Tlg}} may take up to ten [[unnamed parameter]]s as parameters accompanying the template link (or name); see Examples below. | ||
== Examples == | == Examples == | ||
{{#switch:{{SITENAME}} |Wikipedia|Meta= | | {{#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. | ; 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|style=background-color: var(--background-color-base, #f8f9fa); border-width: 1px; color: var(--color-base, #000);<!-- to see background of <code>...</code> --> | ||
| '''Code''' | '''Output''' | '''Remarks''' | | '''Code''' | '''Output''' | '''Remarks''' | ||
| {{ | | {{Tlx|Tlg|Termometro}} | {{Tlg|Termometro}} | {{Error|Termometro}} template does not exist. Be aware with linking to non-existing templates, although desired. | ||
| {{ | | {{Tlx|Tlg|Ok}} | {{Tlg|Ok}} | Ok template does exist | ||
| {{ | | {{Tlx|Tlg|Convert|<nowiki><nowiki>14|m|ftin|abbr=out|sp=us</nowiki></nowiki>}} | {{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}} | | ||
| {{ | | {{Tlx|Tlg|abC}} | {{Tlg|abC}} | Template names are case-sensitive | ||
| {{ | | {{Tlx|Tlg|abc}} | {{Tlg|abc}} | The first letter of a template's name is case-insensitive, though | ||
| {{ | | {{Tlx|Tlg|Abc|'''<nowiki>{{spaces}}</nowiki>'''{{{1}}}'''<nowiki>{{spaces}}</nowiki>'''}} | {{Tlg|Abc|{{spaces}}{{{1}}}{{spaces}}}}| Using {{Tl|Spaces}} before and after <nowiki>{{{1}}}</nowiki> parameter. | ||
| {{ | | {{Tlx|Tlg|X0}} | {{Tlg|X0}} | | ||
| {{ | | {{Tlx|Tlg|X0|code{{=}}on}} | {{Tlg|X0|code=on}} | <code> style | ||
| {{ | | {{Tlx|Tlg|X0|plaincode{{=}}on}} | {{Tlg|X0|plaincode=on}} | plaincode style | ||
| {{ | | {{Tlx|Tlg|X0|kbd{{=}}on}} | {{Tlg|X0|kbd=on}} | <kbd> style | ||
| {{ | | {{Tlx|Tlg|X0|bold{{=}}on}} | {{Tlg|X0|bold=on}} | bold link/name | ||
| {{ | | {{Tlx|Tlg|X1|one|italic{{=}}on}} | {{Tlg|X1|one|italic=on}} | parameter/s in italics | ||
| {{ | | {{Tlx|Tlg|X0|nolink{{=}}on}} | {{Tlg|X0|nolink=on}} | | ||
| {{ | | {{Tlx|Tlg|X0|subst{{=}}on}} | {{Tlg|X0|subst=on}} | | ||
| {{ | | {{Tlx|Tlg|X0|brace{{=}}on}} | {{Tlg|X0|brace=on}} | all braces in link | ||
| {{ | | {{Tlx|Tlg|X0|braceinside{{=}}on}} | {{Tlg|X0|braceinside=on}} | inside braces in link | ||
| {{ | | {{Tlx|Tlg|X0|alttext{{=}}x0 link}} | {{Tlg|X0|alttext=x0 link}} | | ||
| {{ | | {{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|Tlg|X1|one}} | {{Tlg|X1|one}} | | ||
| {{ | | {{Tlx|Tlg|X2|one|two}} | {{Tlg|X2|one|two}} | | ||
| {{ | | {{Tlx|Tlg|X2|bold{{=}}on|code{{=}}on|one|two}} | {{Tlg|X2|bold=on|code=on|one|two}} | Can combine named and anonymous parameters … | ||
| {{ | | {{Tlx|Tlg|X2|one|two|bold{{=}}on|code{{=}}on}} | {{Tlg|X2|one|two|bold=on|code=on}} | … in any order … | ||
| {{ | | {{Tlx|Tlg|X2|one|code{{=}}on|two|bold{{=}}on|three}} | {{Tlg|X2|one|code=on|two|bold=on|three}} | … even intermixed … | ||
| {{ | | {{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|Tlg|X3|1|2|3|4|5|6|7|8|9|10}} | {{Tlg|X3|1|2|3|4|5|6|7|8|9|10}} | | ||
| {{ | | {{Tlx|Tlg|X4|1|2|3|4|5|6|7|8|9|10|11}} | {{Tlg|X4|1|2|3|4|5|6|7|8|9|10|11}} | up to 10 parameters, then … | ||
| {{ | | {{Tlx|Tlg|X5|1|2|3|4|5|6|7|8|9|10&#124;11}} | {{Tlg|X5|1|2|3|4|5|6|7|8|9|10|11}} | {{Align|right|<code>&#124;</code> for more}} | ||
| {{ | | {{Tlx|Tlg}} | {{Tlg}} | with no arguments, the current page name is substituted | ||
| {{ | | {{Tlx|Tlg|X1|x=u}} | {{Tlg|X1|x=u}} | '''{{=}}''' won't work | ||
| {{ | | {{Tlx|Tlg|X1|x&#61;u}} | {{Tlg|X1|x=u}} | {{Align|right|<code>&#61;</code> is okay}} | ||
| {{ | | {{Tlx|Tlg|X1|x<nowiki>{{=}}</nowiki>u}} | {{Tlg|X1|x{{=}}u}} | {{Align|right|<code><nowiki>{{=}}</nowiki></code> is okay (see [[Template:=|equality symbol template]])}} | ||
| {{ | | {{Tlx|Tlg|X1|x<nowiki>=</nowiki>u}} | {{Tlg|X1|x<nowiki>=</nowiki>u}} | {{Align|right|sticky nowiki is okay}} | ||
| {{ | | {{Tlx|Tlg|X2|<nowiki />|two|<nowiki />|<nowiki />}} | {{Tlg|X2||two||}} | empty parameters work too, even at the end | ||
| {{ | | {{Tlx|Tlg|X2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}} | {{Tlg|X2|3=two|2=one}} | {{Align|right|right to left okay}} | ||
}} | }} | ||
{| class="wikitable" | {| class="wikitable" style="background-color: var(--background-color-base, #f8f9fa); border-width: 1px;" | ||
|+ style="text-align:left;" | Wrapping of long names (default) | |+ style="text-align: left;" | Wrapping of long names (default) | ||
! Code | |||
! Code | ! 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}} | ||
| {{ | | {{Tlg|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" style="background-color: var(--background-color-base, #f8f9fa); border-width: 1px;" | ||
|+ style="text-align:left;" | Wrapping of long names (<kbd>nowrap=on</kbd>) | |+ style="text-align: left;" | Wrapping of long names (<kbd>nowrap=on</kbd>) | ||
! Code | |||
! Code | ! 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}} | ||
| {{ | | {{Tlg|nowrap=on|Long template name that would wrap to new line|long value for the 1st parameter that would wrap}} | ||
| {{ | |||
|} | |} | ||
{| class="wikitable" | {| class="wikitable" style="background-color: var(--background-color-base, #f8f9fa); border-width: 1px;" | ||
|+ style="text-align:left;" | Wrapping of long names (<kbd>nowrapname=on</kbd>) | |+ style="text-align: left;" | Wrapping of long names (<kbd>nowrapname=on</kbd>) | ||
! Code | |||
! Code | ! 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}} | ||
| {{ | | {{Tlg|nowrapname=on|Long template name that would wrap to new line|long value for the 1st parameter that would wrap}} | ||
| {{ | |||
|} | |} | ||
== See also == | == See also == | ||
{{Template-linking templates}} | {{Template-linking templates}} | ||
<includeonly>{{Sandbox other|| | <includeonly>{{Sandbox other||<!-- Categories below this line; interwikis at Wikidata --> | ||
<!-- Categories below this line; interwikis at Wikidata --> | |||
[[Category:Internal template-link templates]] | [[Category:Internal template-link templates]] | ||
[[Category:Typing-aid templates]] | [[Category:Typing-aid templates]] | ||
}}</includeonly> | }}</includeonly> | ||