From Justapedia, unleashing the power of collective wisdom
Jump to navigation
Jump to search
 | This template uses Lua:
|
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
{{String split |This is a piece of text to be split |" "}} → This{{String split |This is a piece of text to be split |" "| 4}} → piece{{String split |This is a piece of text to be split |x| 2}} → t to be split
Modules may return strings with | as separators like this: {{#invoke:carousel | main | name = WPDogs | switchsecs = 5 }} → Lua error in package.lua at line 80: module 'Module:Carousel/WPDogs' not found.
{{String split |{{#invoke:carousel | main | name = WPDogs | switchsecs = 5 }}|{{!}}| 2}} →
Lua patterns can allow splitting at classes of characters such as punctuation:
{{String split |Apples, pears, oranges; Cats, dogs|"%p"| 2 |false}} → pears{{String split |Apples, pears, oranges; Cats, dogs|"%p"| 4 |false}} → Cats
Or split on anything that isn't a letter (no is treated as false):
{{String split |Apples pears oranges; Cats dogs|"%A+"| 4 |no}} → Cats
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 }} → oranges
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}} → split
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}} →{{String split |This is a piece of text to be split|" "|-1}} → split
See also
String-handling templates (help page) |
|---|
Substring (select chunk of string by its position) |
|---|
| {{str sub new}} | Select a substring based on starting and ending index counted in either direction. | | {{str left}} | Keep the first N characters of a string, or duplicate it to N characters. | | {{str crop}} | Return all but the last N characters of a string. | | {{str index}} | Return the N-th character of a string. |
| | {{str right}} | Return substring starting at N-th character to end of string. | | {{str rightc}} | Return the last N characters of a string; or a given value if empty. | | {{str sub old}} | Return substring of given length starting at N-th character. |
|
|
|
Trimming (select/remove chunk of string by character type) |
|---|
|
|
Select/remove specific item from string |
|---|
| | | {{ship prefix}} | Returns the length of a ship's name prefix, if listed (ship names). | | {{title year}} | Returns the 3-or-4-digit year from a pagename, if any. | | {{title decade}} | Returns the 4-digit decade (e.g. "1740s") from a pagename, if any. | | {{title number}} | Returns any number from a pagename. |
|
|
|
Insertion, replacement and length |
|---|
| {{loop}} | Repeat character string a specified number of times. | | {{replace}} | Returns the string, after replacing all occurrences of a specified string with another string. | | {{str rep}} | Returns the string, after replacing the first occurrence of a specified string with another string. | | {{digits}} | Returns the string, after removing all characters that are not digits 0–9 | | {{Nowiki}} | Displays wikitext as plain text. |
|
| {{str len}} | Returns a string's length. | | {{str ≥ len}} | Check if a string is "longer or equally long" or "shorter" than a given length. | | {{str ≤ len}} | Check if a string is "shorter or equally long" or "longer" than a given length. | | {{str ≠ len}} | Check if a string is "not equal" or "equal" to a given length. |
|
|
|
Analysis and searching |
|---|
{{str startswith}}
{{str endswith}} | Check if a string starts or ends with a given string. | | {{str find}}, {{strfind short}} | Returns the numerical location of a given string in a string. | | {{in string}} | Returns optional string when given string is not found | | {{str count}} | Count the number of occurrences of a pattern within a string. |
|
| {{a or an}} | Takes a noun and produces the appropriate indefinite article, based on whether the first letter is a vowel. | | {{Array}} | Array manipulation and retrieval. | | {{Font style}} | Returns bold or italic if the input value has either formatting. | | {{Isnumeric}} | Returns number when true, blank when not numeric. | | {{str letter}} | Returns the number of letters that begin a string. | | {{str number}} | Returns the number of numbers that begin a string. |
|
|
|
Modules and built-in functions |
|---|
|
|
|
Template documentation