Module:String2/doc: Difference between revisions

Content deleted Content added
Stringsplit: Redirect
Line 226:
|}
 
=== StringsplitString split ===
[[Template:StringsplitString split]] is a convenience wrapper for the split function.
* <code><nowiki>{{StringsplitString split |This is a piece of text to be split |" "}}</nowiki></code> → {{StringsplitString split |This is a piece of text to be split |" "}}
* <code><nowiki>{{StringsplitString split |This is a piece of text to be split |" "| 4}}</nowiki></code> → {{StringsplitString split |This is a piece of text to be split |" "| 4}}
* <code><nowiki>{{StringsplitString split |This is a piece of text to be split |x| 2}}</nowiki></code> → {{StringsplitString split |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>{{StringsplitString split |{{#invoke:carousel | main | name = WPDogs | switchsecs = 5 }}|{{!}}| 2}}</nowiki></code> → {{StringsplitString split |{{#invoke:carousel | main | name = WPDogs | switchsecs = 5 }}|{{!}}| 2}}
Lua patterns can allow splitting at classes of characters such as punctuation:
* <code><nowiki>{{StringsplitString split |Apples, pears, oranges; Cats, dogs|"%p"| 2 |false}}</nowiki></code> → {{StringsplitString split |Apples, pears, oranges; Cats, dogs|"%p"| 2 |false}}
* <code><nowiki>{{StringsplitString split |Apples, pears, oranges; Cats, dogs|"%p"| 4 |false}}</nowiki></code> → {{StringsplitString split |Apples, pears, oranges; Cats, dogs|"%p"| 4 |false}}
Or split on anything that isn't a letter (no is treated as false):
* <code><nowiki>{{StringsplitString split |Apples pears oranges; Cats dogs|"%A+"| 4 |no}}</nowiki></code> → {{StringsplitString split |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>{{StringsplitString split | txt=Apples pears oranges; Cats dogs | sep="%A+" | idx=3 | plain=false }}</nowiki></code> → {{StringsplitString split | txt=Apples pears oranges; Cats dogs | sep="%A+" | idx=3 | plain=false }}
 
=== One2a ===