Module:Params/doc/examples/array/doc

This example template is an almost-exact clone of the {{Array}} template, written using Module:Params. It handles five functions: count, get, pos, math and sort.

Usage

{{module:params/doc/examples/array|<Function>|<Array items>|<Delimiter>|<Property>|Parameters (optional)}}

5th parameter only valid with pos function when limiting multiple outputs to a single position.

Functions

Count

Will count the total number of items in the array using the designated separator. Leading or trailing separators are stripped.

• {{Module:Params/doc/examples/array|count|This is my array| }} → 4
• {{Module:Params/doc/examples/array|count|An,array,separated,by,commas|,}} → 5
• {{Module:Params/doc/examples/array|count|An,array,with,trailing,commas,|,}} → 5

Get

Will get the Nth item in the array, numeric value only. Can use negative value to work backwards. Last or -1 will get end item. Invalid value returns error.

• {{Module:Params/doc/examples/array|get|My,wiki,test,array|,|3}} → test
• {{Module:Params/doc/examples/array|get|A.list.of.dot.separated.items|.|2}} → list
• {{Module:Params/doc/examples/array|get|The almost last item is nearly final| |-1}} → nearly
• {{Module:Params/doc/examples/array|get|The last item is final| |0}} → final
• {{Module:Params/doc/examples/array|get|Invalid input returns error| |foobar}} →

Pos

Will retrieve the position in array of the search item. If duplicates are found, will output all positions delimited by comma. Output can be limited by specifying a 5th parameter.

{{module:params/doc/examples/array|Pos|<Array items>|<Delimiter>|<Search Term>|<Nth occurrence> (optional)}}

• {{Module:Params/doc/examples/array|pos|A sentence of typical words| |sentence}} → 2
• {{Module:Params/doc/examples/array|pos|A.wiki.test.string.in.a.test.array|.|unmatched}} →
• {{Module:Params/doc/examples/array|pos|A.wiki.test.string.in.a.test.array|.|test}} → 3.7
• {{Module:Params/doc/examples/array|pos|Position,of,the,second,test,in,a,test,array|,|test|2}} → 8
• {{Module:Params/doc/examples/array|pos|2,4,6,6,7,11,12|,|7}} → 5
• {{Module:Params/doc/examples/array|pos|2,4,6,6,7,11,12|,|6|2}} → 4

Math

Will do calculations on the array items if all numeric. Options are sum (sum of all item numbers), min and max.

• {{Module:Params/doc/examples/array|math|2,4,6,6,7,12|,|sum}} → 37
• {{Module:Params/doc/examples/array|math|2,4,6,6,7,12|,|max}} → 12
• {{Module:Params/doc/examples/array|math|3.3.4.5.5.6|.|min}} → 3
• {{Module:Params/doc/examples/array|math|3.3.f.5.5.q|.|min}} → 3

Sort

Sort items in the array, ascending/chronological, numeric first.

• {{Module:Params/doc/examples/array|sort|3,9,6,d,8,7,a,12|,}} → 3,6,7,8,9,12,a,d

See also

• {{Array}}