Raven.Familiar at 20:12, 31 August 2025

2025-08-31T20:12:37Z

← Older revision		Revision as of 20:12, 31 August 2025
Line 71:		Line 71:
	;Template in format example 1		;Template in format example 1
	<pre>{{Array\|Venti;Jean;Diluc\|;\|{{Character\|{item}\|50}}}}</pre>		<pre>{{Array\|Venti;Jean;Diluc\|;\|{{Character\|{item}\|50}}}}</pre>
	{{Array\|~~Venti~~;~~Jean~~;~~Diluc~~\|;\|{{Character\|{item}\|50}}}}		{{Array\|Nanafey;Kiana;Blade\|;\|{{Character\|{item}\|50}}}}

	;Template in format example 2		;Template in format example 2
	<pre>{{Array\|Venti;Jean;Diluc\|;\|²{Character¦{item}¦50}²\|template=1}}</pre>		<pre>{{Array\|Venti;Jean;Diluc\|;\|²{Character¦{item}¦50}²\|template=1}}</pre>
	{{Array\|~~Venti~~;~~Jean~~;~~Diluc~~\|;\|^2{Character¦{item}¦50}^2\|template=1}}		{{Array\|Nanafey;Kiana;Blade\|;\|^2{Character¦{item}¦50}^2\|template=1}}

	;Multi-character separator example		;Multi-character separator example

Sangodono at 21:24, 29 August 2025

2025-08-29T21:24:53Z

← Older revision		Revision as of 21:24, 29 August 2025
Line 1:		Line 1:
	{{Documentation/Header}}		{{Documentation/Header}}
	{{High ~~risk~~}}		{{High Risk}}
	{{Lua\|Array}}		{{Lua\|Array}}
	Divides a string into a formatted list of substrings.		Divides a string into a formatted list of substrings.

Kwwxis: Created page with "{{Documentation/Header}} {{High risk}} {{Lua|Array}} Divides a string into a formatted list of substrings. ==Syntax== '''Required Parameters:''' '''1''': arrayString - the input string, each item expected to be separated by the `separator` parameter. '''2''': separator - the character or substring to split on. `{newline}` is replaced with a newline. `{space}` is replaced with a space. '''Format Parameters:'''
If format is..."

2025-08-29T11:53:53Z

Created page with "{{Documentation/Header}} {{High risk}} {{Lua|Array}} Divides a string into a formatted list of substrings. ==Syntax== '''Required Parameters:''' *'''1''': arrayString - the input string, each item expected to be separated by the <code>separator</code> parameter. *'''2''': separator - the character or substring to split on. ** <code>{newline}</code> is replaced with a newline. ** <code>{space}</code> is replaced with a space. '''Format Parameters:'''<br /> If format is..."

New page

{{Documentation/Header}}
{{High risk}}
{{Lua|Array}}
Divides a string into a formatted list of substrings.

==Syntax==
'''Required Parameters:'''
*'''1''': arrayString - the input string, each item expected to be separated by the <code>separator</code> parameter.
*'''2''': separator - the character or substring to split on.
** <code>{newline}</code> is replaced with a newline.
** <code>{space}</code> is replaced with a space.

'''Format Parameters:'''<br />
If format is not specified, then the default format is <code>{item}</code>.
*'''3''': format - the resulting format of each substring.
** <code>{item}</code> is replaced with the item.
** <code>{itemLink}</code> is replaced with the item as a link.
** <code>{itemLinkSafe}</code> is replaced with the item as a link if the page exists otherwise is replaced with the item as text.
** <code>{index}</code> is replaced with the index.
** <code>{newline}</code> is replaced with a newline.
** <code>{space}</code> is replaced with a space. Useful if you need a leading/trailing space. You could also use <code>&nbsp;</code>
* '''format<index>''': custom format to override the <code>format</code> param for a particular substring by its index
** Index is 1-based. For example <code>format2</code> would be the format for the second item of the array.
** supports the same tokens (like <code>{itemLink}</code>) that <code>format</code> param does.
*'''noTrim''' (optional): set to 1 to not remove whitespace from items in the array.
*'''template''' (optional): set to 1 to allow escaped template syntax for complex returns
** escape {{F|<nowiki>{{</nowiki>}} as: {{F|²{}} or {{F|^2{}}.
** escape {{F|<nowiki>}}</nowiki>}} as: {{F|}²}} or {{F|}^2}}.
** escape {{F|<nowiki>|</nowiki>}} as: {{F|¦}} or {{F|¹}}.

'''Join Parameters:'''<br />
These three parameters are mutually exclusive (meaning you can only have one of these three):
*'''4''': join (optional) - separator between each element to join. Default no separator.
** <code>{newline}</code> is replaced with a newline.
** <code>{space}</code> is replaced with a space. Useful if you need a leading/trailing space. You could also use <code>&nbsp;</code>
*'''sentence''' (optional): set to 1 to format as a sentence (commas with an "and" for the last element).
**'''sentence_join''' (optional): sentence join character, defaults to <code>,</code>
**'''sentence_last''' (optional): sentence join last word, defaults to <code> and </code>
*'''prefix''' (optional): Text added to start of result.
*'''suffix''' (optional): Text added to end of result.

'''Filter/Sort Parameters:'''<br />
These parameters are checked/applied in the order as shown below:
*'''removeEmpty''' (optional): set to 1 to remove empty elements.
*'''dedupe''' (optional): set to 1 to remove duplicate items in the array.
*'''sort''' (optional): set to 1 to sort the items in the array in ascending order, -1 for descending.
*'''firstItemOnly''' (optional): set to 1 to only display the first element of the array.
** You could also do <code>offsetStart=1|offsetEnd=1</code> but this is a shortcut.
*'''offsetStart''' (optional): only keep elements of the array at and after this index (inclusive).
*'''offsetEnd''' (optional): only keep elements of the array at and before this index (inclusive).

Knowing this order, you can use these parameters to achieve various effects. Such as: <code>removeEmpty=1|offsetStart=1|offsetEnd=1</code> to get the first non-empty element of the input array string.

==Examples==
;Simple example
<pre>{{Array|1,2,3,4,5|,|*''{item}''|{newline} }}</pre>
{{Array|1,2,3,4,5|,|*''{item}''|{newline} }}

;Dedupe example
<pre>{{Array|1,2,2,2,3,4,5|,|*''{item}''|{newline}|dedupe=1}}</pre>
{{Array|1,2,2,2,3,4,5|,|*''{item}''|{newline}|dedupe=1}}

;Remove empty example
<pre>{{Array|1,2,,, ,3,4,5|,|*''{item}''|{newline}|removeEmpty=1}}</pre>
{{Array|1,2,,, ,3,4,5|,|*''{item}''|{newline}|removeEmpty=1}}

;Sort example
<pre>{{Array|Oranges;Apples;Bananas;Mangos;Blueberries|;|*{item}|{newline}|sort=1}}</pre>
{{Array|Oranges;Apples;Bananas;Mangos;Blueberries|;|*{item}|{newline}|sort=1}}

;Template in format example 1
<pre>{{Array|Venti;Jean;Diluc|;|{{Character|{item}|50}}}}</pre>
{{Array|Venti;Jean;Diluc|;|{{Character|{item}|50}}}}

;Template in format example 2
<pre>{{Array|Venti;Jean;Diluc|;|²{Character¦{item}¦50}²|template=1}}</pre>
{{Array|Venti;Jean;Diluc|;|^2{Character¦{item}¦50}^2|template=1}}

;Multi-character separator example
<pre>{{Array|a&&b&&c&&d&&e|&&|{index}: {item}|,{space} }}</pre>
{{Array|a&&b&&c&&d&&e|&&|{index}: {item}|,{space} }}

;Sentence example
<pre>{{Array|Oranges;Apples;Bananas;Mangos;Blueberries|;|{item}|sentence=1}}</pre>
{{Array|Oranges;Apples;Bananas;Mangos;Blueberries|;|{item}|sentence=1}}

;First item only example
<pre>{{Array|Oranges;Apples;Bananas;Mangos;Blueberries|;|{item}|firstItemOnly=1}}</pre>
{{Array|Oranges;Apples;Bananas;Mangos;Blueberries|;|{item}|firstItemOnly=1}}

;Offset start and end examples
<pre>{{Array|A,B,C,D,E,F,G,H,I,J,K|,|{item}|join=,{space}|offsetStart=2}}</pre>
{{Array|A,B,C,D,E,F,G,H,I,J,K|,|{item}|join=,{space}|offsetStart=2}}

<pre>{{Array|A,B,C,D,E,F,G,H,I,J,K|,|{item}|join=,{space}|offsetStart=2|offsetEnd=5}}</pre>
{{Array|A,B,C,D,E,F,G,H,I,J,K|,|{item}|join=,{space}|offsetStart=2|offsetEnd=5}}

<pre>{{Array|A,B,C,D,E,F,G,H,I,J,K|,|{item}|join=,{space}|offsetStart=2|offsetEnd=2}}</pre>
{{Array|A,B,C,D,E,F,G,H,I,J,K|,|{item}|join=,{space}|offsetStart=2|offsetEnd=2}}

<pre>{{Array|A,B,C,D,E,F,G,H,I,J,K|,|{item}|join=,{space}|offsetStart=2|offsetEnd=-2}}</pre>
{{Array|A,B,C,D,E,F,G,H,I,J,K|,|{item}|join=,{space}|offsetStart=2|offsetEnd=-2}}

<pre>{{Array|A,B,C,D,E,F,G,H,I,J,K|,|{item}|join=,{space}|offsetStart=-2}}</pre>
{{Array|A,B,C,D,E,F,G,H,I,J,K|,|{item}|join=,{space}|offsetStart=-2}}

<pre>{{Array|A,B,C,D,E,F,G,H,I,J,K|,|{item}|join=,{space}|offsetStart=-1}}</pre>
{{Array|A,B,C,D,E,F,G,H,I,J,K|,|{item}|join=,{space}|offsetStart=-1}}

;Item Specific Format
<pre>{{Array|Item A,Item B,Item C|,|*''{item}''|{newline} |format2=*Item 2 specific format: '''{item}'''}}</pre>
{{Array|1,2,3,4,5|,|*''{item}''|{newline} |format2=*Item 2 specific format: '''{item}'''}}

==Template Data==
<templatedata>
{
"params": {
"1": {
"label": "Array String",
"description": "The input string, each item expected to be separated by the \"separator\" parameter.",
"example": "Item 1;Item 2;Item 3",
"type": "string",
"required": true
},
"2": {
"aliases": [
"sep",
"separator"
],
"label": "Separator",
"description": "The character or substring to split on.",
"example": ";",
"type": "string",
"required": true
},
"3": {
"aliases": [
"format"
],
"label": "Format",
"description": "The resulting format of each substring. See the template documentation page for more info.",
"required": true,
"type": "string"
},
"4": {
"aliases": [
"join"
],
"label": "Join",
"description": "The separator between each element to join.",
"type": "string",
"default": "(no separator)"
},
"sentence": {
"label": "Join as sentence",
"description": "Set to 1 to format as a sentence (commas with an \"and\" for the last element).",
"type": "boolean",
"default": "0"
},
"firstItemOnly": {
"label": "First item only",
"description": "Set to 1 to only display the first element of the array.",
"type": "boolean",
"default": "0"
},
"sort": {
"label": "Sort",
"description": "Set to 1 to sort the items in the array in ascending order, -1 for descending.",
"type": "number"
},
"dedupe": {
"label": "Dedupe?",
"description": "Set to 1 to remove duplicate items in the array.",
"type": "boolean"
},
"removeEmpty": {
"label": "Remove Empty Items",
"description": "Set to 1 to remove empty elements.",
"type": "boolean"
},
"offsetStart": {
"label": "Offset Start",
"description": "Only keep elements of the array at and after this index.",
"type": "number"
},
"offsetEnd": {
"label": "Offset End",
"description": "Only keep elements of the array at and before this index.",
"type": "number"
}
},
"description": "Divides a string into a formatted list of substrings."
}
</templatedata>

Template:Array/doc - Revision history

Raven.Familiar at 20:12, 31 August 2025

Sangodono at 21:24, 29 August 2025