C: 1 revision imported

2025-11-15T02:44:18Z

1 revision imported

← Older revision	Revision as of 02:44, 15 November 2025
(No difference)

w>Bungle: space placeholder

2025-02-02T19:28:51Z

space placeholder

New page

{{Documentation subpage}}
{{Lua|Module:ArrayList}}
{{TOC right}}
This template will allow manipulation or retrieve properties of an array list using a delimiter. It handles five functions: count, get, pos, math and sort.

== Usage ==
<nowiki>{{Array|<Function>|<Array items>|<Delimiter>|<Property>|Parameters (optional)}}</nowiki>

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.
* {{tlx|Array|count|This is my array| }} → {{Array|count|This is my array| }}
* {{tlx|Array|count|An,array,separated,by,commas|,}} → {{Array|count|An,array,separated,by,commas|,}}
* {{tlx|Array|count|An,array,with,trailing,commas,|,}} → {{Array|count|An,array,with,trailing,commas,|,}}
;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.
* {{tlx|Array|get|My,wiki,test,array|,|3}} → {{Array|get|My,wiki,test,array|,|3}}
* {{tlx|Array|get|A.list.of.dot.separated.items|.|2}} → {{Array|get|A.list.of.dot.separated.items|.|2}}
* {{tlx|Array|get|The almost last item is nearly final| |-2}} → {{Array|get|The almost last item is nearly final| |-2}}
* {{tlx|Array|get|The last item is final| |last}} → {{Array|get|The last item is final| |last}}
* {{tlx|Array|get|Invalid input returns error| |foobar}} → {{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.

<nowiki>{{Array|Pos|<Array items>|<Delimiter>|<Search Term>|<Nth occurrence> (optional)}}</nowiki>
* {{tlx|Array|pos|A sentence of typical words| |sentence}} → {{Array|pos|A sentence of typical words| |sentence}}
* {{tlx|Array|pos|A.wiki.test.string.in.a.test.array|.|unmatched}} → {{Array|pos|My.wiki.test.string.in.a.test.array|.|unmatched}}
* {{tlx|Array|pos|A.wiki.test.string.in.a.test.array|.|test}} → {{Array|pos|A.wiki.test.string.in.a.test.array|.|test}}
* {{tlx|Array|pos|Position,of,the,second,test,in,a,test,array|,|test|2}} → {{Array|pos|Position,of,the,second,test,in,a,test,array|,|test|2}}
* {{tlx|Array|pos|2,4,6,6,7,11,12|,|7}} → {{Array|pos|2,4,6,6,7,11,12|,|7}}
* {{tlx|Array|pos|2,4,6,6,7,11,12|,|6|2}} → {{Array|pos|2,4,6,6,7,11,12|,|6|2}}

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

* {{tlx|Array|math|2,4,6,6,7,12|,|sum}} → {{Array|math|2,4,6,6,7,12|,|sum}}
* {{tlx|Array|math|2,4,6,6,7,12|,|max}} → {{Array|math|2,4,6,6,7,12|,|max}}
* {{tlx|Array|math|3.3.4.5.5.6|.|min}} → {{Array|math|3.3.4.5.5.6|.|min}}
* {{tlx|Array|math|3.3.f.5.5.q|.|min}} → {{Array|math|3.3.f.5.5.q|.|min}}

;Sort
Sort items in the array, default ascending/chronological, numeric first. Use parameter "a" to sort alpha first and/or "r" to reverse order

* {{tlx|Array|sort|2,9,6,8,7,12|,}} → {{Array|sort|2,9,6,8,7,12|,}}
* {{tlx|Array|sort|2,9,6,8,7,12|,|r}} → {{Array|sort|2,9,6,8,7,12|,|r}}
* {{tlx|Array|sort|2,9,6,d,8,7,a,12|,}} → {{Array|sort|2,9,6,d,8,7,a,12|,}}
* {{tlx|Array|sort|2,9,6,d,8,7,a,12|,|a}} → {{Array|sort|2,9,6,d,8,7,a,12|,|a}}
* {{tlx|Array|sort|3,9,6,d,8,7,a,12|,|ar}} → {{Array|sort|3,9,6,d,8,7,a,12|,|ar}} (alpha starts first from the right if reversing the sort order)
* {{tlx|Array|sort|is everything up mixed| }} → {{Array|sort|is everything up mixed| }}

===See also===
{{String-handling templates |anlys/tech}}

<includeonly>{{Sandbox other||

[[Category:String manipulation templates]]
[[Category:Wikipedia formatting templates]]
}}</includeonly>

Template:Array/doc - Revision history

C: 1 revision imported

w>Bungle: space placeholder