Difference between revisions of "Template:Max/doc"

From blackwiki
Jump to navigation Jump to search
imported>Droll
(conform to evolving style)
imported>Colonies Chris
(minor fixes)
 
(27 intermediate revisions by 22 users not shown)
Line 1: Line 1:
 
{{documentation subpage}}
 
{{documentation subpage}}
Evaluates and returns the maximum of a list of numeric values (with up to 3 parameters). The parameters can be numeric expressions that will be evaluated. Empty or missing parameters are ignored.
+
{{high-use|230,000+}}
 +
{{lua|Module:Math}}
 +
 
 +
Evaluates and returns the maximum of a list of numeric values. The parameters can be numeric expressions that will be evaluated. Empty or missing parameters are ignored.
  
 
=== Usage ===
 
=== Usage ===
  
; Syntax<nowiki>:</nowiki>
+
; Syntax
: <tt><nowiki>{{max|</nowiki></tt>''[value1]''<tt><nowiki>|</nowiki></tt>''[value2]''<tt><nowiki>|</nowiki></tt>''[value3]''<tt><nowiki>}}</nowiki></tt>
+
:<code><nowiki>{{max | value1 | value2 | value3 | value4 | ... }}</nowiki></code>
 +
 
 +
; Examples
 +
: <code><nowiki>{{max}}</nowiki></code> → {{max}}
 +
: <code><nowiki>{{max|}}</nowiki></code> → {{max|}}
 +
: <code><nowiki>{{max|-7}}</nowiki></code> → {{max|-7}}
 +
: <code><nowiki>{{max|-7|}}</nowiki></code> → {{max|-7|}}
 +
: <code><nowiki>{{max|-7|5}}</nowiki></code> → {{max|-7|5}}
 +
: <code><nowiki>{{max|-7|5|}}</nowiki></code> → {{max|-7|5|}}
 +
: <code><nowiki>{{max|-7|5|8}}</nowiki></code> → {{max|-7|5|8}}
 +
: <code><nowiki>{{max|40*41|300+30}}</nowiki></code> → {{max|40*41|300+30}}
 +
: <code><nowiki>{{max|100+10|300+30|200+20}}</nowiki></code> → {{max|100+10|300+30|200+20}}
  
; Examples<nowiki>:</nowiki>
+
=== TemplateData===
: <tt><nowiki>{{max}}</nowiki></tt> {{max}}
+
{{TemplateData header}}
: <tt><nowiki>{{max|}}</nowiki></tt> → {{max|}}
+
<templatedata>{
: <tt><nowiki>{{max|-7}}</nowiki></tt> → {{max|-7}}
+
"description": "Evaluates and returns the maximum of a list of numeric values.",
: <tt><nowiki>{{max|-7|}}</nowiki></tt> → {{max|-7|}}
+
"params": {
: <tt><nowiki>{{max|-7|5}}</nowiki></tt> → {{max|-7|5}}
+
  "1": {
: <tt><nowiki>{{max|-7|5|}}</nowiki></tt> → {{max|-7|5|}}
+
    "label": "First value",
: <tt><nowiki>{{max|-7|5|8}}</nowiki></tt> → {{max|-7|5|8}}
+
    "description": "The first value, a number or expression, e.g. '10*20+30'",
: <tt><nowiki>{{max|40*41|300+30}}</nowiki></tt> → {{max|40*41|300+30}}
+
    "type": "string",
: <tt><nowiki>{{max|100+10|300+30|200+20}}</nowiki></tt> → {{max|100+10|300+30|200+20}}
+
    "required": true
 +
  },
 +
  "2": {
 +
    "label": "Second value",
 +
    "description": "The second value, many more parameters can be specified",
 +
    "type": "string",
 +
    "required": false
 +
  }
 +
}}</templatedata>
  
 
=== See also ===
 
=== See also ===
* {{tl|Min}}
+
* [[Template:Min]] - for a minimum value, used the same way.
  
<includeonly>
+
<includeonly>{{Sandbox other||
 
[[Category:Mathematical function templates|Max]]
 
[[Category:Mathematical function templates|Max]]
  
[[eo:Ŝablono:Max]]
+
}}</includeonly>
[[fr:Template:Max]]
 
[[hsb:Předłoha:Max]]
 
[[ia:Patrono:Max]]
 
[[it:Template:Max]]
 
[[nl:Sjabloon:Max]]
 
[[ja:Template:Max]]
 
[[ka:თარგი:Max]]
 
[[pl:Szablon:Max]]
 
[[pt:Predefinição:Max]]
 
[[ro:Format:Max]]
 
[[sk:Šablóna:Max]]
 
[[sl:Predloga:Max]]
 
[[sv:Mall:Högsta]]
 
[[zh:Template:Max]]
 
</includeonly>
 

Latest revision as of 17:52, 28 August 2020

Evaluates and returns the maximum of a list of numeric values. The parameters can be numeric expressions that will be evaluated. Empty or missing parameters are ignored.

Usage

Syntax
{{max | value1 | value2 | value3 | value4 | ... }}
Examples
{{max}}
{{max|}}
{{max|-7}} → -7
{{max|-7|}} → -7
{{max|-7|5}} → 5
{{max|-7|5|}} → 5
{{max|-7|5|8}} → 8
{{max|40*41|300+30}} → 1640
{{max|100+10|300+30|200+20}} → 330

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Max

Evaluates and returns the maximum of a list of numeric values.

Template parameters

ParameterDescriptionTypeStatus
First value1

The first value, a number or expression, e.g. '10*20+30'

Stringrequired
Second value2

The second value, many more parameters can be specified

Stringoptional

See also