Reba inkomoko ya Inyandikorugero:String split/doc

{{Documentation subpage}}
{{Lua|Module:String2}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
[[Template:String split]] is a convenience wrapper for the <code>split</code> function in [[Module:String2]].

The <code>split</code> function splits text at boundaries specified by separator and returns the chunk for the index idx (starting at 1). It can use positional parameters or named parameters (but these should not be mixed):
* <code><nowiki>{{#invoke:String2 |split |text |separator |index |true/false}}</nowiki></code>
* <code><nowiki>{{#invoke:String2 |split |txt=text |sep=separator |idx=index |plain=true/false}}</nowiki></code>
Any double quotes (") in the separator parameter are stripped out, which allows spaces and wikitext like <code><nowiki>["[</nowiki></code> to be passed. Use <code>{{tl|!}}</code> for the pipe character <code>|</code>.

If the optional plain parameter is set to <code>false / no / 0</code> then separator is treated as a Lua pattern. The default is plain=true, i.e. normal text matching.

The index parameter is optional; it defaults to the first chunk of text. A negative parameter value counts chunks backward from the end of the text.

== Examples ==

* <code><nowiki>{{String split |This is a piece of text to be split |" "}}</nowiki></code> → {{Stringsplit |This is a piece of text to be split |" "}}
* <code><nowiki>{{String split |This is a piece of text to be split |" "| 4}}</nowiki></code> → {{Stringsplit |This is a piece of text to be split |" "| 4}}
* <code><nowiki>{{String split |This is a piece of text to be split |x| 2}}</nowiki></code> → {{Stringsplit |This is a piece of text to be split |x| 2}}
Modules may return strings with | as separators like this: <code><nowiki>{{#invoke:carousel | main | name = WPDogs | switchsecs = 5 }}</nowiki></code> → {{#invoke:carousel | main | name = WPDogs | switchsecs = 5 }}
* <code><nowiki>{{String split |{{#invoke:carousel | main | name = WPDogs | switchsecs = 5 }}|{{!}}| 2}}</nowiki></code> → {{Stringsplit |{{#invoke:carousel | main | name = WPDogs | switchsecs = 5 }}|{{!}}| 2}}
Lua patterns can allow splitting at classes of characters such as punctuation:
* <code><nowiki>{{String split |Apples, pears, oranges; Cats, dogs|"%p"| 2 |false}}</nowiki></code> → {{Stringsplit |Apples, pears, oranges; Cats, dogs|"%p"| 2 |false}}
* <code><nowiki>{{String split |Apples, pears, oranges; Cats, dogs|"%p"| 4 |false}}</nowiki></code> → {{Stringsplit |Apples, pears, oranges; Cats, dogs|"%p"| 4 |false}}
Or split on anything that isn't a letter (no is treated as false):
* <code><nowiki>{{String split |Apples pears oranges;  Cats  dogs|"%A+"| 4 |no}}</nowiki></code> → {{Stringsplit |Apples pears oranges;  Cats  dogs|"%A+"| 4 |no}}
Named parameters force the trimming of leading and trailing spaces in the parameters and are generally clearer when used:
* <code><nowiki>{{String split | txt=Apples pears oranges;  Cats  dogs | sep="%A+" | idx=3 | plain=false }}</nowiki></code> → {{Stringsplit | txt=Apples pears oranges;  Cats  dogs | sep="%A+" | idx=3 | plain=false }}
A negative index will count back from the end of the text:
* <code><nowiki>{{String split |txt=This is a piece of text to be split |sep=" " |idx=-1}}</nowiki></code> → {{Stringsplit |txt=This is a piece of text to be split |sep=" " |idx=-1}}
An easy mistake to make when using negative parameters is to forget that a trailing space in the text when passed as an unnamed parameter will induce an empty last chunk:
* <code><nowiki>{{String split |This is a piece of text to be split |" "|-1}}</nowiki></code> → {{Stringsplit |This is a piece of text to be split |" "|-1}}
* <code><nowiki>{{String split |This is a piece of text to be split|" "|-1}}</nowiki></code> → {{Stringsplit |This is a piece of text to be split|" "|-1}}

==See also==
{{String-handling templates}}

<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:String manipulation templates]]
}}</includeonly>