Template:String split/doc

From WikiLaw, the free legal repository
Jump to navigation Jump to search

Template:Mbox Template:String split is a convenience wrapper for the split function in Module:String2.

The split 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):

  • {{#invoke:String2 |split |text |separator |index |true/false}}
  • {{#invoke:String2 |split |txt=text |sep=separator |idx=index |plain=true/false}}

Any double quotes (") in the separator parameter are stripped out, which allows spaces and wikitext like ["[ to be passed. Use {{!}} for the pipe character |.

If the optional plain parameter is set to false / no / 0 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[edit]

  • {{String split |This is a piece of text to be split |" "}}Script error: No such module "String2".
  • {{String split |This is a piece of text to be split |" "| 4}}Script error: No such module "String2".
  • {{String split |This is a piece of text to be split |x| 2}}Script error: No such module "String2".

Modules may return strings with | as separators like this: {{#invoke:carousel | main | name = WPDogs | switchsecs = 5 }}Script error: No such module "carousel".

  • {{String split |{{#invoke:carousel | main | name = WPDogs | switchsecs = 5 }}|{{!}}| 2}}Script error: No such module "String2".

Lua patterns can allow splitting at classes of characters such as punctuation:

  • {{String split |Apples, pears, oranges; Cats, dogs|"%p"| 2 |false}}Script error: No such module "String2".
  • {{String split |Apples, pears, oranges; Cats, dogs|"%p"| 4 |false}}Script error: No such module "String2".

Or split on anything that isn't a letter (no is treated as false):

  • {{String split |Apples pears oranges; Cats dogs|"%A+"| 4 |no}}Script error: No such module "String2".

Named parameters force the trimming of leading and trailing spaces in the parameters and are generally clearer when used:

  • {{String split | txt=Apples pears oranges; Cats dogs | sep="%A+" | idx=3 | plain=false }}Script error: No such module "String2".

A negative index will count back from the end of the text:

  • {{String split |txt=This is a piece of text to be split |sep=" " |idx=-1}}Script error: No such module "String2".

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:

  • {{String split |This is a piece of text to be split |" "|-1}}Script error: No such module "String2".
  • {{String split |This is a piece of text to be split|" "|-1}}Script error: No such module "String2".

See also[edit]

Template:Navbox with collapsible groups