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,243 bytes added ,  2 years ago
m
1 revision imported from wikipedia:Template:Template_link_general/doc
 
(34 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 ([[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
|-
| 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 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|tlg|Termometro}} | {{tlg|Termometro}} | Termometro template does not exist. Be aware with linking to non-existing templates, although desired.▼
| {{tlx|tlg|ok}} | {{tlg|ok}} | ok template does exist▼
}}
 
{{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}} | Termometro{{error|Banner}} template does not exist. Be aware with linking to non-existing templates, although desired.
| {{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 [[Help:Wikitext#Nowiki|nowiki]] string▼
| {{tlx|{{{1|tlg}}}|Abcok}} | {{{{{1|tlg}}}|Abcok}} | 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|nowikistring]] string
| {{tlx|tlg|abC}} | {{tlg|abC}} | template names are case-sensitive
| {{tlx|{{{1|tlg}}}|abcAbc}} | {{{{{1|tlg}}}|abcAbc}} | first letter is case-insensitive though
▲ | {{tlx|{{{1|tlg}}}|okabC}} | {{{{{1|tlg}}}|okabC}} | ok | template doesnames are existcase-sensitive
| {{tlx|tlg|ok|'''<nowiki>{{spaces}}</nowiki>'''{{{1}}}'''<nowiki>{{spaces}}</nowiki>'''}} | {{tlg|ok|{{spaces}}{{{1}}}{{spaces}}}}| Using {{tl|spaces}} before and after <nowiki>{{{1}}}</nowiki> parameter.▼
| {{tlx|{{{1|tlg}}}|x0abc}} | {{{{{1|tlg}}}|x0abc}} | first letter is case-insensitive though
▲ | {{tlx|{{{1|tlg}}}|okabc|'''<nowiki>{{spaces}}</nowiki>'''{{{1}}}'''<nowiki>{{spaces}}</nowiki>'''}} | {{{{{1|tlg}}}|okabc|{{spaces}}{{{1}}}{{spaces}}}}| Using {{tl|spaces}} before and after <nowiki>{{{1}}}</nowiki> parameter.
| {{tlx|tlg|x0|code{{=}}on}} | {{tlg|x0|code=on}} | &lt;code&gt; style
| {{tlx|tlg|x0|plaincode{{={1|tlg}}on}|x0}} | {{{{{1|tlg}}}|x0|plaincode=on}} | plaincode style |
| {{tlx|{{{1|tlg}}}|x0|kbdcode{{=}}on}} | {{{{{1|tlg}}}|x0|kbdcode=on}} | &lt;kbdcode&gt; style
| {{tlx|{{{1|tlg}}}|x0|boldplaincode{{=}}on}} | {{{{{1|tlg}}}|x0|boldplaincode=on}} | boldplaincode link/namestyle
| {{tlx|tlg{{{1|x1tlg}}}|onex0|italickbd{{=}}on}} | {{{{{1|tlg}}}|x1|onex0|italickbd=on}} | parameter/s in italics | &lt;kbd&gt; style
| {{tlx|{{{1|tlg}}}|x0|nolinkbold{{=}}on}} | {{{{{1|tlg}}}|x0|nolinkbold=on}} | bold link/name
| {{tlx|{{{1|tlg}}}|x1|x0one|substitalic{{=}}on}} | {{{{{1|tlg}}}|x0x1|substone|italic=on}} | parameter/s in | italics
| {{tlx|{{{1|tlg}}}|x0|bracenolink{{=}}on}} | {{{{{1|tlg}}}|x0|bracenolink=on}} | all braces in link
| {{tlx|{{{1|tlg}}}|x0|braceinsidesubst{{=}}on}} | {{{{{1|tlg}}}|x0|braceinsidesubst=on}} | inside braces in link |
| {{tlx|{{{1|tlg}}}|x0|alttextbrace{{=}}x0 linkon}} | {{{{{1|tlg}}}|x0|alttextbrace=x0 linkon}} | all braces in link
| {{tlx|tlg|x0|bold{{={1|tlg}}}on|code{{=}}onx0|bracebraceinside{{=}}on}} | {{{{{1|tlg}}}|x0|bold=on|code=on|bracebraceinside=on}} | No reason you can't combineinside multiplebraces parameterin settingslink
| {{tlx|{{{1|tlg}}}|x1x0|onealttext{{=}}x0 link}} | {{{{{1|tlg}}}|x1x0|onealttext=x0 link}} |
| {{tlx|{{{1|tlg}}}|x2x0|onebold{{=}}on|twocode{{=}}on|brace{{=}}on}} | {{{{{1|tlg}}}|x2x0|onebold=on|twocode=on|brace=on}} | No reason you can't combine multiple parameter | settings
| {{tlx|tlg|x2|bold{{=}}on|code{{=1|tlg}}}on|onex1|twoone}} | {{{{{1|tlg}}}|x2|bold=on|code=onx1|one|two}} | Can combine named and anonymous parameters … |
| {{tlx|{{{1|tlg}}}|x2|one|two|bold{{=}}on |code {{={{{1|tlg}}on}} | {{tlg|x2|one|two|bold=on|code=on}} | … in any order … |
| {{tlx|{{{1|tlg}}}|x2|one|codebold{{=}}on|two|boldcode{{=}}on|threeone|two}} | {{{{{1|tlg}}}|x2|one|codebold=on|two|boldcode=on|threeone|two}} | …Can combine named and evenanonymous intermixedparameters …
| {{tlx|{{{1|tlg}}}|x2|one|code{{=}}on|two|bold{{=}}on|three|italiccode{{=}}on}} | {{{{{1|tlg}}}|x2|one|code=on|two|bold=on|three|italiccode=on}} | … within manyany differentorder configurations.…
| {{tlx|tlg|x3|{{{1|2tlg}}}|3x2|4one|5code{{=}}on|6two|7|8bold{{=}}on|9&#124;10three}} | {{tlg|x3|{{{1|2tlg}}}|3x2|4one|5code=on|6two|7bold=on|8|9|10three}} | … even intermixed | …
| {{tlx|tlg|x4|{{{1|2tlg}}}|3x2|4one|5code{{=}}on|6two|7bold{{=}}on|8three|9&#124;10&#124;11italic{{=}}on}} | {{tlg|x4|{{{1|2tlg}}}|3x2|4one|5code=on|6two|7bold=on|8three|9|10|11italic=on}} | up… towith 10many parameters,different then …configurations.
| {{tlx|{{{1|tlg}}}|x5x3|1|2|3|4|5|6|7|8|9&#124;|10&amp;#124;11}} | {{{{{1|tlg}}}|x5x3|1|2|3|4|5|6|7|8|9|10&#124;11}} | {{align |right|<code>&amp;#124;</code> for more}}
| {{tlx|{{{1|tlg}}}}} | {{{1|tlg}}} | with no arguments, the current page name is substituted
| {{tlx|{{{1|tlg}}}|x1|x&#61;u}} | {{{{{1|tlg}}}|x1|x=u}} | '''{{=}}''' won't work
| {{tlx|{{{1|tlg}}}|x1|x&amp;#61;u}} | {{{{{1|tlg}}}|x1|x&#61;u}} | {{align|right|<code>&amp;#61;</code> is okay}}
| {{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|{{{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|{{{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;"
|+ style="text-align:left;" | Wrapping of long names (default)
|-
Line 97 ⟶ 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 107 ⟶ 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 117 ⟶ 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 127 ⟶ 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/24794...25460"
Cookies help us deliver our services. By using our services, you agree to our use of cookies.
More information

Navigation menu