Template:Template link general/doc: Difference between revisions

From the Croc Wiki, the Croc encyclopedia
Jump to navigationJump to search

Template:Template link general/doc (view source)

Revision as of 15:03, January 29, 2022

1,449 bytes added ,  2 years ago
m
1 revision imported from wikipedia:Template:Template_link_general/doc
 
(29 intermediate revisions by 14 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 ([[Template:Tlg#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 ([[Template:Tlg#Examples|see Examples below]]):
{| class="wikitable"
! Parameter || Action || AsUse with<br>{{t|example}} || Default active in
|-
| braceinsidebrace || Include innermost braces as part of the template link || {{tlg|brace=yes|example}} || {{tl|tlw}}/{{tl|tn}}▼
|-
| bracebraceinside || 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''' || {{tlg|bold=yes|example}} || {{tl|tlb}}, {{tl|tlxtlxb}}, etc.▼
▲| braceinside || Include innermost braces as part of the template link || {{tl|tlw}}
|-
| code || Display output using HTML [[HTML element#code|{{tag|code}}]] tags ([[monospaced font]]) || {{tlg|code=yes|example}} || {{tl|tlc}}, {{tl|Template link expanded}}, etc.
▲| bold<br/>boldlink<br/>boldname || Renders the template link/name in '''bold''' || {{tl|tlb}}, {{tl|tlx}}, etc.
|-
| codeitalic || Display outputany usingparameters HTMLaccompanying [[HTMLthe element#code|{{tag|code}}]]template tagslink/name ([[monospacedin font]])''italics'' ||| {{tltlg|italic=yes|example|tlcparam}}, || {{tl|tlxtlxi}}, etc.
|-
| kbd || Display output using HTML [[HTML element#kbd|{{tag|kbd}}]] tags (monospaced font) || {{tlg|kbd=yes|example}} ||
| plaincode || Uses {{tag|code|params=style="border:none; background:transparent;"}} ||▼
|-
| kbdnolink || DisplayDon't outputrender usingthe HTMLtemplate [[HTMLname as a link element#kbd|| {{tagtlg|kbdnolink=yes|example}}]] tags (monospaced font) || {{tl|tltttlf}}, {{tlt|tltt2tnull}}, etc.
|-
| nowrap || Prevent the insertion of line breaks ([[word wrap]]) in the output || {{tltlg|tlpnowrap=yes|example}}, {{tl|tlf}}, etc.|▼
| italic<br/>italics || Display any parameters accompanying the template link/name in ''italic/s'' || {{tl|tlxi}}
|-
| nolinknowrapname || Don'tPrevent renderword wrapping in the output of template name/link as(parameters awill linkwrap if needed) || {{tltlg|tlfnowrapname=yes|example}} ||
|-
▲| plaincode || Uses {{tag|code|params=style="border:none; background:transparent;"}} || {{tlg|plaincode=yes|example}} || {{tl|tltss}}
▲| nowrap || Prevent the insertion of line breaks ([[word wrap]]) in the output || {{tl|tlp}}, {{tl|tlf}}, etc.
|-
| subst || Include a [[Help:Substitution|subst:]] prefix before the template link/name || {{tlg|subst=yes|example}} || {{tl|tls}}, {{tl|tlxs}}, etc
| nowrapname || Prevent word wrapping in the output of template name/link (parameters will wrap if needed) ||
|-
| subst{{para|alttext|[text]}} || IncludeUse a [[Help:Substitution|subst:]text] prefixas beforethe label for the template link/name || {{tlg|alttext=Other|example}} || {{tl|tlstla}}
|-
| <nowiki>|alttext=[text]</nowiki>_show_result || UseWill [text]also asdisplay the labelresult forof the template link . || {{tltlx|tlaMin|7|-5|_show_result=y}} ||
|}
 
====Unnamed (Positional)====
{{tlf|tlg}}This maytemplate can take upany tonumber tenof [[unnamed parameter]]s as parameters accompanying the template link (or name); see Examples below.
 
===Examples===
Line 46 ⟶ 65:
{{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}}}|TermometroBanner}} | {{{{{1|tlg}}}|TermometroBanner}} | {{error|TermometroBanner}} template does not exist. Be aware with linking to non-existing templates, although desired.
| {{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|{{{1|tlg}}}|Abc}} | {{{{{1|tlg}}}|Abc}} |
| {{tlx|{{{1|tlg}}}|abC}} | {{{{{1|tlg}}}|abC}} | template names are case-sensitive
| {{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|{{{1|tlg}}}|x0}} | {{{{{1|tlg}}}|x0}} |
| {{tlx|{{{1|tlg}}}|x0|code{{=}}on}} | {{{{{1|tlg}}}|x0|code=on}} | &lt;code&gt; style
| {{tlx|{{{1|tlg}}}|x0|plaincode{{=}}on}} | {{{{{1|tlg}}}|x0|plaincode=on}} | plaincode style
| {{tlx|{{{1|tlg}}}|x0|kbd{{=}}on}} | {{{{{1|tlg}}}|x0|kbd=on}} | &lt;kbd&gt; style
| {{tlx|{{{1|tlg}}}|x0|bold{{=}}on}} | {{{{{1|tlg}}}|x0|bold=on}} | bold link/name
| {{tlx|{{{1|tlg}}}|x1|one|italic{{=}}on}} | {{{{{1|tlg}}}|x1|one|italic=on}} | parameter/s in italics
| {{tlx|{{{1|tlg}}}|x0|nolink{{=}}on}} | {{{{{1|tlg}}}|x0|nolink=on}} |
| {{tlx|{{{1|tlg}}}|x0|subst{{=}}on}} | {{{{{1|tlg}}}|x0|subst=on}} |
| {{tlx|{{{1|tlg}}}|x0|brace{{=}}on}} | {{{{{1|tlg}}}|x0|brace=on}} | all braces in link
| {{tlx|{{{1|tlg}}}|x0|braceinside{{=}}on}} | {{{{{1|tlg}}}|x0|braceinside=on}} | inside braces in link
| {{tlx|{{{1|tlg}}}|x0|alttext{{=}}x0 link}} | {{{{{1|tlg}}}|x0|alttext=x0 link}} |
| {{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|{{{1|tlg}}}|x1|one}} | {{{{{1|tlg}}}|x1|one}} |
| {{tlx|{{{1|tlg}}}|x2|one|two}} | {{{{{1|tlg}}}|x2|one|two}} |
| {{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|{{{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|{{{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|{{{1|tlg}}}|x3|1|2|3|4|5|6|7|8|9&#124;|10}} | {{{{{1|tlg}}}|x3|1|2|3|4|5|6|7|8|9|10}} |
| {{tlx|{{{1|tlg}}}}} | {{{1|tlg}}} | with no arguments, the current page name is substituted
| {{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}}}|x1|x&#61;u}} | {{{{{1|tlg}}}|x1|x=u}} | '''{{=}}''' won't work
| {{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}} }|x1|x&amp;#61;u}} | {{{{{1|tlg}}}|x1|x&#61;u}} | {{align| with no arguments, the current page nameright|<code>&amp;#61;</code> is substitutedokay}}
| {{tlx|{{{1|tlg}}}|x1|x&#61;<nowiki>{{=}}</nowiki>u}} | {{{{{1|tlg}}}|x1|x{{=}}u}} | '''{{align|right|<code><nowiki>{{=}}'''</nowiki></code> won'tis workokay (see [[:template:=|template equal sign]])}}
| {{tlx|{{{1|tlg}}}|x1|x&amplt;nowiki&gt;&#61;&lt;/nowiki&gt;u}} | {{{{{1|tlg}}}|x1|x&#61;<nowiki>=</nowiki>u}} | {{align|right|<code>&amp;#61;</code>sticky nowiki is okay}}
| {{tlx|{{{1|tlg}}}|x1x2|x<nowiki />{{=}}|two|<nowiki />|<nowiki />u}} | {{tlg|x1|x{{={1|tlg}}u}|x2||two||}} | {{align|right|<code><nowiki>{{=}}</nowiki></code> isempty okayparameters work (seetoo, [[:template:=|templateeven equalat sign]])}}the end
| {{tlx|{{{1|tlg}}}|x1x2|x&lt;<nowiki&gt;&#61;&lt;>3=two</nowiki&gt;u>|<nowiki>2=one</nowiki>}} | {{{{{1|tlg}}}|x1x2|x<nowiki>3=</nowiki>utwo|2=one}} | {{align|right|stickyright nowikito isleft 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" |style="border:1; cellpadding:4; background-color:transparent;"
|+ style="text-align:left;" | Wrapping of long names (default)
|-
Line 91 ⟶ 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 101 ⟶ 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 111 ⟶ 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 121 ⟶ 138:
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
[[Category:Internal template-link templates]]
[[Category:TypingWikitext typing-aid templates]]
}}</includeonly>
Retrieved from "https://crocwiki.com/wiki/Special:MobileDiff/24799...25460"
Cookies help us deliver our services. By using our services, you agree to our use of cookies.
More information

Navigation menu