Template:Template link general/doc: Difference between revisions

From the Croc Wiki, the Croc encyclopedia
Jump to navigationJump to search
Content added Content deleted
No edit summary
 
(44 intermediate revisions by 15 users not shown)
Line 1:
{{Documentation subpage}}
<!-- 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:TlgTemplate 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===
With the exception of {{mono|alttext}}, {{tlf|tlg}}'sthe 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"
! Parameter || Action || AsUse with<br>{{t|example}} || Default active in
|-
| 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 || {{tltlg|tlwexample|braceinside=yes}} ||
|-
| bold<br/>boldlink<br/>boldname || Renders the template link/name in '''bold''' || {{tlg|bold=yes|example}} || {{tl|tlb}}, {{tl|tlxtlxb}}, etc.
|-
| code || Display output using HTML [[HTML element#code|{{tag|code}}]] tags ([[monospaced font]]) || {{tlg|code=yes|example}} || {{tl|tlc}}, {{tl|tlxTemplate 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) || {{tltlg|tlttkbd=yes|example}}, {{tl|tltt2}}, etc.|
|-
| italic<br/>italicsnolink || Display anyDon't parameters accompanyingrender the template link/name inas ''italic/s''a link || {{tlg|nolink=yes|example}} || {{tl|tlxitlf}}, {{t|tnull}}
|-
| nolinknowrap || Don't renderPrevent the templateinsertion nameof asline abreaks link([[word wrap]]) in the output || {{tltlg|tlfnowrap=yes|example}} ||
|-
| nowrapnowrapname || Prevent word wrapping in the insertionoutput of linetemplate breaksname/link ([[wordparameters will wrap]]) inif the outputneeded) || {{tltlg|tlpnowrapname=yes|example}}, {{tl|tlf}}, etc.|
|-
▲| 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 || {{tlg|subst=yes|example}} || {{tl|tls}}, {{tl|tlxs}}, etc
|-
| <nowiki>{{para|alttext=|[text]</nowiki>}} || 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 (Positional)====
{{tlf|tlg}}This maytemplate can take upany tonumber tenof [[unnamed parametersparameter]]s as parameters accompanying the template link (or name); see Examples below.
 
===Examples===
Line 43 ⟶ 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.
}}
 
{{Aligned table
|cols=3 |class=wikitable
|style=border:1;cellpadding:4;background-color:transparent;<!-- to see background of <code>...</code> -->
| '''Code''' | '''Output''' | '''Remarks'''
| {{tlx|{{{1|tlg}}}|AbcBanner}} | {{{{{1|tlg}}}|Banner}} | {{tlgerror|AbcBanner}} template does not exist. Be aware with linking to non-existing templates, although | desired.
| {{tlx|{{{1|tlg}}}|abCok}} | {{{{{1|tlg}}}|abCok}} | |ok template names aredoes case-sensitiveexist
| {{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|{{{1|tlg}}}|x0Abc}} | {{{{{1|tlg}}}|x0Abc}} |
| {{tlx|tlg|x0|code{{={1|tlg}}on}|abC}} | {{{{{1|tlg}}}|x0|code=onabC}} | &lt;code&gt;template names are stylecase-sensitive
| {{tlx|tlg|x0|plaincode{{={1|tlg}}on}|abc}} | {{tlg{{{1|x0tlg}}}|plaincode=onabc}} | plaincodefirst letter is case-insensitive stylethough
| {{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{{={1|tlg}}on}|x0}} | {{{{{1|tlg}}}|x0|bold=on}} | bold link/name |
| {{tlx|tlg{{{1|x1tlg}}}|onex0|italiccode{{=}}on}} | {{{{{1|tlg}}}|x1|onex0|italiccode=on}} | parameter/s in italics | &lt;code&gt; style
| {{tlx|{{{1|tlg}}}|x0|nolinkplaincode{{=}}on}} | {{{{{1|tlg}}}|x0|nolinkplaincode=on}} | plaincode | style
| {{tlx|{{{1|tlg}}}|x0|substkbd{{=}}on}} | {{{{{1|tlg}}}|x0|substkbd=on}} | &lt;kbd&gt; style
| {{tlx|{{{1|tlg}}}|x0|bracebold{{=}}on}} | {{{{{1|tlg}}}|x0|bracebold=on}} | all braces inbold link/name
| {{tlx|{{{1|tlg}}}|x1|x0one|braceinsideitalic{{=}}on}} | {{{{{1|tlg}}}|x1|x0one|braceinsideitalic=on}} | inside| bracesparameter/s in linkitalics
| {{tlx|{{{1|tlg}}}|x0|alttextnolink{{=}}x0 linkon}} | {{{{{1|tlg}}}|x0|alttextnolink=x0 linkon}} |
| {{tlx|tlg|x0|bold{{=}}on|code{{=1|tlg}}on}|x0|bracesubst{{=}}on}} | {{{{{1|tlg}}}|x0|bold=on|code=on|bracesubst=on}} | No reason you can't combine multiple parameter| settings
| {{tlx|{{{1|tlg}}}|x1x0|onebrace{{=}}on}} | {{{{{1|tlg}}}|x1x0|onebrace=on}} | all braces in | link
| {{tlx|{{{1|tlg}}}|x2x0|one|twobraceinside{{=}}on}} | {{{{{1|tlg}}}|x2x0|one|twobraceinside=on}} | inside braces in | link
| {{tlx|tlg|x2|bold{{={1|tlg}}on}|x0|codealttext{{=}}on|one|twox0 link}} | {{{{{1|tlg}}}|x2x0|boldalttext=on|code=on|one|twox0 link}} | Can combine named and anonymous parameters …
| {{tlx|tlg{{{1|x2|onetlg}}}|twox0|bold{{=}}on|code{{=}}on|brace{{=}}on}} | {{tlg{{{1|x2|onetlg}}}|twox0|bold=on|code=on|brace=on}} | …No reason you can't incombine anymultiple orderparameter …settings
| {{tlx|tlg|x2|one|code{{={1|tlg}}}on|twox1|bold{{=}}on|threeone}} | {{{{{1|tlg}}}|x2x1|one|code=on|two|bold=on|three}} | … even intermixed … |
| {{tlx|{{{1|tlg}}}|x2|one|code{{=two}}on|two |bold {{=}}on|three|italic{{=}{1|tlg}on}} | {{tlg|x2|one|code=on|two|bold=on|three|italic=on}} | … with many different configurations. |
| {{tlx|tlg|x3|{{{1|2tlg}}}|3x2|4bold{{=}}on|5code{{=}}on|6one|7|8|9&#124;10two}} | {{tlg|x3|{{{1|2tlg}}}|3x2|4bold=on|5code=on|6one|7|8|9|10two}} | Can combine named and |anonymous parameters …
| {{tlx|tlg|x4|{{{1|2tlg}}}|3x2|4one|5two|6|7|8bold{{=}}on|9&#124;10&#124;11code{{=}}on}} | {{tlg|x4|{{{1|2tlg}}}|3x2|4one|5two|6bold=on|7|8|9|10|11code=on}} | up to… 10in parameters,any thenorder …
| {{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|{{{1|tlg}}}|x1x3|x&#61;u1|2|3|4|5|6|7|8|9|10}} | {{{{{1|tlg}}}|x3|x11|x=u2|3|4|5|6|7|8|9|10}} | '''{{=}}''' won't work
| {{tlx|tlg{{{1|x1|x&amp;#61;utlg}}}}} | {{tlg{1|x1|x&#61;utlg}}} | {{align |right|<code>&amp;#61;</code> with no arguments, the current page name is okay}}substituted
| {{tlx|{{{1|tlg}}}|x1|x<nowiki>{{=}}</nowiki>&#61;u}} | {{{{{1|tlg}}}|x1|x{{=}}u}} | {{align|right|<code><nowiki>'''{{=}}</nowiki></code>''' iswon't okay (see [[:template:=|template equal sign]])}}work
| {{tlx|{{{1|tlg}}}|x1|x&ltamp;nowiki&gt;&#61;&lt;/nowiki&gt;u}} | {{{{{1|tlg}}}|x1|x<nowiki>=</nowiki>&#61;u}} | {{align|right|sticky nowiki<code>&amp;#61;</code> is okay}}
| {{tlx|{{{1|tlg}}}|x2x1|x<nowiki />|two|{{=}}<nowiki />|<nowiki />u}} | {{{{{1|tlg}}}|x2||two|x1|x{{=}}u}} | {{align|right|<code><nowiki>{{=}}</nowiki></code> emptyis parametersokay work too,(see even[[:template:=|template atequal the endsign]])}}
| {{tlx|{{{1|tlg}}}|x2x1|<x&lt;nowiki>3=two<&gt;&#61;&lt;/nowiki>|<nowiki>2=one</nowiki>&gt;u}} | {{{{{1|tlg}}}|x2x1|3x<nowiki>=two|2=one</nowiki>u}} | {{align|right|rightsticky tonowiki leftis okay}}
| {{tlx|{{{1|tlg}}}|convertx2|<nowiki />&lt;nowiki>14|mtwo|ftin|abbr=out|sp=us&lt;/<nowiki />|</nowiki />}} | {{{{{1|tlg}}}|convertx2|<nowiki>14|mtwo|ftin|abbr=out|sp=us</nowiki>}} | Unlimitedempty parameters aswork onetoo, nowikieven at the stringend
| {{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;"
|+ style="text-align:left;" | Wrapping of long names (default)
|-
Line 87 ⟶ 108:
! style="width:15em;" | Output
|-
| {{tlx|{{{1|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;"
|+ style="text-align:left;" | Wrapping of long names (<kbd>nowrap=on</kbd>)
|-
Line 97 ⟶ 118:
! style="width:15em;" | Output
|-
| {{tlx|{{{1|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;"
|+ style="text-align:left;" | Wrapping of long names (<kbd>nowrapname=on</kbd>)
|-
Line 107 ⟶ 128:
! style="width:15em;" | Output
|-
| {{tlx|{{{1|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 ⟶ 138:
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
[[Category:Internal template-link templates]]
[[Category:TypingWikitext typing-aid templates]]
}}</includeonly>

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

Shortcut

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


Retrieved from "https://crocwiki.com/wiki/Template:Template_link_general/doc?oldid=25460"