View source for Module:String2/doc

{{high-use}}
{{module rating|release}}
{{Lua|Module:GetParameters}}
{{Lmd|String2}}

The module '''String2''' contains a number of string manipulation functions that are much less commonly used than those in [[Module:String]]. Because Module:String is cascade-protected (some of its functions are used on the Main Page), it cannot be edited or maintained by template editors, only by admins. While it is true that string-handling functions rarely need maintenance, it is useful to allow that by template editors where possible, so this module may be used by template editors to develop novel functionality.

The module contains three case-related calls that convert strings to first letter uppercase, sentence case or title case and two calls that are useful for working with substrings. There are other utility calls that strip leading zeros from padded numbers and transform text so that it is not interpreted as wikitext, and several other calls that solve specific problems for template developers such as finding the position of a piece of text on a given page.

The functions are designed with the possibility of working with text returned from Wikidata in mind. However, a call to Wikidata may return empty, so the functions should generally fail gracefully if supplied with a missing or blank input parameter, rather than throwing an error.

== Functions ==
=== trim ===
The trim function simply trims whitespace characters from the start and end of the string.

=== title ===
The title function capitalises the first letter of each word in the text, apart from a number of short words listed in [[s:U.S. Government Printing Office Style Manual/Capitalization Rules#3.49|The U.S. Government Printing Office Style Manual §3.49 "Center and side heads"]]: {{xt|a, an, the, at, by, for, in, of, on, to, up, and, as, but, or, and nor}}.

This is a very simplistic algorithm; see [[:Template:Title case/doc]] for some of its limitations.

=== sentence ===
The sentence function finds the first letter and capitalises it, then renders the rest of the text in lower case. It works properly with text containing wiki markup. Compare <code><nowiki>{{#invoke:String2|sentence|[[action game]]}}</nowiki></code> &rarr; {{#invoke:String2|sentence|[[action game]]}} with <code><nowiki>{{ucfirst:{{lc:[[action game]]}}}}</nowiki></code> &rarr; {{ucfirst:{{lc:[[action game]]}}}}. Piped wiki-links are handled as well:
* <code><nowiki>{{#invoke:String2|sentence|[[trimix (breathing gas)|trimix]]}}</nowiki></code> &rarr; {{#invoke:String2|sentence|[[trimix (breathing gas)|trimix]]}}
So are lists:
* <code><nowiki>{{#invoke:String2 |sentence |{{hlist ||[[apples]] |[[pears]] |[[oranges]]}}}}</nowiki></code> → {{#invoke:String2 |sentence |{{hlist |[[apples]] |[[pears]] |[[oranges]]}}}}

=== ucfirst ===
The ucfirst function is similar to sentence; it renders the first alphabetical character in upper case, but leaves the capitalisation of the rest of the text unaltered. This is useful if the text contains proper nouns, but it will not regularise sentences that are ALLCAPS, for example. It also works with text containing piped wiki-links and with html lists.

=== findlast ===
* Function findlast finds the last item in a list.
* The first unnamed parameter is the list. The list is trimmed of leading and trailing whitespace
* The second, optional unnamed parameter is the list separator (default = comma space). The separator is ''not'' trimmed of leading and trailing whitespace (so that leading or trailing spaces can be used).
* It returns the whole list if the separator is not found.

One potential issue is that using Lua special pattern characters (<code>^$()%.[]*+-?</code>) as the separator will probably cause problems.

{| class="wikitable"
|+ Examples
|-
! scope="col" | Case
! scope="col" | Wikitext
! scope="col" | Output
|-
| Normal usage || <code><nowiki>{{#invoke:String2 |findlast | 5, 932, 992,532, 6,074,702, 6,145,291}}</nowiki></code> || {{#invoke:String2 |findlast | 5, 932, 992,532, 6,074,702, 6,145,291}}
|-
| Space as separator || <code><nowiki>{{#invoke:String2 |findlast | 5 932 992,532 6,074,702 6,145,291 }}</nowiki></code> || {{#invoke:String2 |findlast | 5 932 992,532 6,074,702 6,145,291 }}
|-
| One item list || <code><nowiki>{{#invoke:String2 |findlast | 6,074,702 }}</nowiki></code> || {{#invoke:String2 |findlast | 6,074,702 }}
|-
| Separator not found || <code><nowiki>{{#invoke:String2 |findlast | 5, 932, 992,532, 6,074,702, 6,145,291 |;}}</nowiki></code> || {{#invoke:String2 |findlast | 5, 932, 992,532, 6,074,702, 6,145,291 |;}}
|-
| List missing || <code><nowiki>{{#invoke:String2 |findlast |}}</nowiki></code> || {{#invoke:String2 |findlast |}}
|}

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

; Usage
: <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.

The {{tl|string split}} is a convenience wrapper for the split function.

=== stripZeros ===
The stripZeros functions finds the first number in a string of text and strips leading zeros, but retains a zero which is followed by a decimal point. For example: "0940" &rarr; "940"; "Year: 0023" &rarr; "Year: 23"; "00.12" &rarr; "0.12"

=== nowiki ===
The nowiki function ensures that a string of text is treated by the MediaWiki software as just a string, not code. It trims leading and trailing whitespace.

=== val2percent ===
The val2percent functions scans through a string, passed as either the first unnamed parameter or |txt=, and converts each number it finds into a percentage, then returns the resulting string.

=== one2a ===
The one2a function scans through a string, passed as either the first unnamed parameter or |txt=, and converts each occurrence of 'one ' into either 'a ' or 'an ', then returns the resultant string.

The [[Template:One2a]] is a convenience wrapper for the one2a function.

=== findpagetext ===
The findpagetext function returns the position of a piece of text in the wikitext source of a page. It takes up to four parameters:
* First positional parameter or |text is the text to be searched for.
* Optional parameter |title is the page title, defaults to the current page.
* Optional parameter |plain is either true for a plain search (default), or false for a [[mw:Extension:Scribunto/Lua reference manual #Patterns|Lua pattern]] search.
* Optional parameter |nomatch is the value returned when no match is found; default is nothing.

; Examples
: <code><nowiki>{{#invoke:String2 |findpagetext |text=Youghiogheny}}</nowiki></code> → {{#invoke:String2 |findpagetext |text=Youghiogheny}}
: <code><nowiki>{{#invoke:String2 |findpagetext |text=Youghiogheny |nomatch=not found}}</nowiki></code> → {{#invoke:String2 |findpagetext |text=Youghiogheny |nomatch=not found}}
: <code><nowiki>{{#invoke:String2 |findpagetext |text=Youghiogheny |title=Boston Bridge |nomatch=not found}}</nowiki></code> → {{#invoke:String2 |findpagetext |text=Youghiogheny |title=Boston Bridge |nomatch=not found}}
: <code><nowiki>{{#invoke:String2 |findpagetext |text=river |title=Boston Bridge |nomatch=not found}}</nowiki></code> → {{#invoke:String2 |findpagetext |text=river |title=Boston Bridge |nomatch=not found}}
: <code><nowiki>{{#invoke:String2 |findpagetext |text=[Rr]iver |title=Boston Bridge |plain=false |nomatch=not found}}</nowiki></code> → {{#invoke:String2 |findpagetext |text=[Rr]iver |title=Boston Bridge |plain=false |nomatch=not found}}
: <code><nowiki>{{#invoke:String2 |findpagetext |text=%[%[ |title=Boston Bridge |plain=f |nomatch=not found}}</nowiki></code> → {{#invoke:String2 |findpagetext |text=%[%[ |title=Boston Bridge |plain=f |nomatch=not found}}
: <code><nowiki>{{#invoke:String2 |findpagetext |text=%{%{[Cc]oord |title=Boston Bridge |plain=f |nomatch=not found}}</nowiki></code> → {{#invoke:String2 |findpagetext |text=%{%{coord |title=Boston Bridge |plain=f |nomatch=not found}}
The search is case-sensitive, so Lua pattern matching is needed to find <code>river</code> or <code>River</code>. The last example finds <code><nowiki>{{coord</nowiki></code> and <code><nowiki>{{Coord</nowiki></code>. The penultimate example finds a wiki-link.

The [[Template:Findpagetext]] is a convenience wrapper for this function.

=== strip ===

The strip function strips the first positional parameter of the characters or pattern supplied in the second positional parameter.

; Usage
: <code><nowiki>{{#invoke:String2|strip|</nowiki><var>source_string</var>|<var>characters_to_strip</var>|<var>plain_flag</var>}}</code>
: <code><nowiki>{{#invoke:String2|strip|</nowiki>source=|chars=|plain=}}</code>

; Examples
: <code><nowiki>{{#invoke:String2|strip|abc123def|123}}</nowiki></code> → {{#invoke:String2|strip|abc123def|123}}
: <code><nowiki>{{#invoke:String2|strip|abc123def|%d+|false}}</nowiki></code> → {{#invoke:String2|strip|abc123def|%d+|false}}
: <code><nowiki>{{#invoke:String2|strip|source=abc123def|chars=123}}</nowiki></code> → {{#invoke:String2|strip|source=abc123def|chars=123}}
: <code><nowiki>{{#invoke:String2|strip|source=abc123def|chars=%d+|plain=false}}</nowiki></code> → {{#invoke:String2|strip|source=abc123def|chars=%d+|plain=false}}

=== matchAny ===
{{for|a function to replace multiple patterns|Module:MultiReplace}}

The matchAny function returns the index of the first positional parameter to match the ''source'' parameter. If the ''plain'' parameter is set to false (default true) then the search strings are Lua patterns. This can usefully be put in a switch statement to pick a switch case based on which pattern a string matches. Returns the empty string if nothing matches, for use in {{pf|if}}.

<code>{{((}}#invoke:String2|matchAny|123|abc|source=abc 124}}</code> returns 2.

=== hyphen2dash ===
Extracted hyphen_to_dash() function from [[Special:Permalink/1017669505|Module:Citation/CS1]].

Converts a hyphen to a dash under certain conditions.  The hyphen must separate like items; unlike items are returned unmodified.  These forms are modified:
* 	letter - letter (A - B)
* 	digit - digit (4-5)
* 	digit separator digit - digit separator digit (4.1-4.5 or 4-1-4-5)
* 	letterdigit - letterdigit (A1-A5) (an optional separator between letter and digit is supported – a.1-a.5 or a-1-a-5)
* 	digitletter - digitletter (5a - 5d) (an optional separator between letter and digit is supported – 5.a-5.d or 5-a-5-d)

Any other forms are returned unmodified.

The input string may be a comma- or semicolon-separated list. Semicolons are converted to commas.

<code><nowiki>{{</nowiki>#invoke:String2|hyphen2dash|1=1-2<nowiki>}}</nowiki></code> returns {{#invoke:String2|hyphen2dash|1=1-2}}.

<code><nowiki>{{</nowiki>#invoke:String2|hyphen2dash|1=1-2; 4–10<nowiki>}}</nowiki></code> returns {{#invoke:String2|hyphen2dash|1=1-2; 4–10}}.

[[Help:Citation Style 1#Accept-this-as-written markup|Accept-this-as-written markup]] is supported, e.g. <code><nowiki>{{</nowiki>#invoke:String2|hyphen2dash|1=((1-2)); 4–10<nowiki>}}</nowiki></code> returns {{#invoke:String2|hyphen2dash|1=((1-2)); 4–10}}.

By default, a normal space is inserted after the separating comma in lists. An optional second parameter allows to change this to a different character (i.e. a thin space or hair space).

===startswith===
A startswith function similar to {{ml|string|endswith}}. Both parameters are required, although they can be blank. Leading and trailing whitespace ''is'' counted, use named parameters to avoid this if required. Outputs "yes" for true and blank for false so may be passed directly to #if.

{{markup|
<nowiki>{{#invoke:string2|startswith|search|se}}</nowiki>|{{#invoke:string2|startswith|search|se}}|
<nowiki>{{#invoke:string2|startswith|search|ch}}</nowiki>|{{#invoke:string2|startswith|search|ch}}}}<!-- Template:Mra -->

== Usage ==

* <code><nowiki>{{#invoke:String2 | sentence |…}}</nowiki></code> - Capitalizes the first character and shifts the rest to lowercase
** Although similar to [[Help:Magic_words#Formatting|magic words]]' <code><nowiki>{{ucfirst:}}</nowiki></code> function, this call works even with piped wiki-links because it searches beyond leading brackets and other non-alphanumeric characters.
** It now also recognises when it has an html list passed to it and capitalises the first alphabetic letter beyond the list item markup ({{tag|li|o}}) and any piped links that may be there.
* <code><nowiki>{{#invoke:String2 | ucfirst |…}}</nowiki></code> - Capitalizes the first alphabetic character and leaves the rest unaltered
** Works with piped wiki-links and html lists
* <code><nowiki>{{#invoke:String2 | title |…}}</nowiki></code> - Capitalizes all words, except for <code>a</code>, <code>an</code>, <code>the</code>, <code>at</code>, <code>by</code>, <code>for</code>, <code>in</code>, <code>of</code>, <code>on</code>, <code>to</code>, <code>up</code>, <code>and</code>, <code>as</code>, <code>but</code>, <code>or</code>, and <code>nor</code>.
* <code><nowiki>{{#invoke:String2 | stripZeros |…}}</nowiki></code> - Removes leading padding zeros from the first number it finds in the string
* <code><nowiki>{{#invoke:String2 | title |…}}</nowiki></code> - Renders the string as plain text without wikicode

=== Parameters ===
These functions take one unnamed parameter comprising (or invoking as a string) the text to be manipulated:
* title
* sentence
* ucfirst

== Examples ==

{| class="wikitable"
! scope="col" | Input
! scope="col" | Output
|-
| <nowiki>{{#invoke:String2| ucfirst | abcd }}</nowiki>
| {{#invoke:String2| ucfirst | abcd }}
|-
| <nowiki>{{#invoke:String2| ucfirst | abCD }}</nowiki>
| {{#invoke:String2| ucfirst | abCD }}
|-
| <nowiki>{{#invoke:String2| ucfirst | ABcd }}</nowiki>
| {{#invoke:String2| ucfirst | ABcd }}
|-
| <nowiki>{{#invoke:String2| ucfirst | ABCD }}</nowiki>
| {{#invoke:String2| ucfirst | ABCD }}
|-
| <nowiki>{{#invoke:String2| ucfirst | 123abcd }}</nowiki>
| {{#invoke:String2| ucfirst | 123abcd }}
|-
| <nowiki>{{#invoke:String2| ucfirst | }}</nowiki>
| {{#invoke:String2| ucfirst | }}
|-
| <nowiki>{{#invoke:String2| ucfirst | human X chromosome }}</nowiki>
| {{#invoke:String2| ucfirst | human X chromosome}}
|-
| <nowiki>{{#invoke:String2 | ucfirst | {{#invoke:WikidataIB |getValue</nowiki><br /><nowiki>| P136 |fetchwikidata=ALL |onlysourced=no |qid=Q1396889}} }}</nowiki>
| {{#invoke:String2 | ucfirst | {{#invoke:WikidataIB |getValue |P136 |fetchwikidata=ALL |onlysourced=no |qid=Q1396889}} }}
|-
| <nowiki>{{#invoke:String2 | ucfirst | {{#invoke:WikidataIB |getValue</nowiki><br /><nowiki>| P106 |fetchwikidata=ALL |list=hlist |qid=Q453196}} }}</nowiki>
| {{#invoke:String2 | ucfirst | {{#invoke:WikidataIB |getValue |P106 |fetchwikidata=ALL |list=hlist |qid=Q453196}} }}
|-
| &nbsp;
| 
|-
| <nowiki>{{#invoke:String2| sentence | abcd }}</nowiki>
| {{#invoke:String2| sentence | abcd }}
|-
| <nowiki>{{#invoke:String2| sentence | abCD }}</nowiki>
| {{#invoke:String2| sentence | abCD }}
|-
| <nowiki>{{#invoke:String2| sentence | ABcd }}</nowiki>
| {{#invoke:String2| sentence | ABcd }}
|-
| <nowiki>{{#invoke:String2| sentence | ABCD }}</nowiki>
| {{#invoke:String2| sentence | ABCD }}
|-
| <nowiki>{{#invoke:String2| sentence | [[action game]] }}</nowiki>
| {{#invoke:String2| sentence | [[action game]] }}
|-
| <nowiki>{{#invoke:String2| sentence | [[trimix (breathing gas)|trimix]] }}</nowiki>
| {{#invoke:String2| sentence | [[trimix (breathing gas)|trimix]] }}
|-
| <nowiki>{{#invoke:String2| sentence | }}</nowiki>
| {{#invoke:String2| sentence | }}
|-
| &nbsp;
| 
|-
| <nowiki>{{#invoke:String2| title | abcd }}</nowiki>
| {{#invoke:String2| title | abcd }}
|-
| <nowiki>{{#invoke:String2| title | abCD }}</nowiki>
| {{#invoke:String2| title | abCD }}
|-
| <nowiki>{{#invoke:String2| title | ABcd }}</nowiki>
| {{#invoke:String2| title | ABcd }}
|-
| <nowiki>{{#invoke:String2| title | ABCD }}</nowiki>
| {{#invoke:String2| title | ABCD }}
|-
| <nowiki>{{#invoke:String2| title | }}</nowiki>
| {{#invoke:String2| title | }}
|-
| <nowiki>{{#invoke:String2| title | the vitamins are in my fresh california raisins}}</nowiki>
| {{#invoke:String2| title | the vitamins are in my fresh california raisins}}
|-
|}

=== String split ===
[[Template:String split]] is a convenience wrapper for the split function.
* <code><nowiki>{{String split |This is a piece of text to be split |" "}}</nowiki></code> → {{String split |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> → {{String split |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> → {{String 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>{{String split |{{#invoke:carousel | main | name = WPDogs | switchsecs = 5 }}|{{!}}| 2}}</nowiki></code> → {{String split |{{#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> → {{String split |Apples, pears, oranges; Cats, dogs|"%p"| 2 |false}}
* <code><nowiki>{{String split |Apples, pears, oranges; Cats, dogs|"%p"| 4 |false}}</nowiki></code> → {{String 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>{{String split |Apples pears oranges;  Cats  dogs|"%A+"| 4 |no}}</nowiki></code> → {{String 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>{{String split | txt=Apples pears oranges;  Cats  dogs | sep="%A+" | idx=3 | plain=false }}</nowiki></code> → {{String split | txt=Apples pears oranges;  Cats  dogs | sep="%A+" | idx=3 | plain=false }}

=== One2a ===
[[Template:One2a]] is a convenience wrapper for the one2a function. 

Capitalisation is kept. Aimed for usage with {{tl|Convert}}.
* <code><nowiki>{{one2a |One foot. One mile. One kilometer. One inch.One amp. one foot. one mile. one inch. Alone at last. Onely the lonely. ONE ounce. One monkey.}}</nowiki></code> →
:{{one2a |One foot. One mile. One kilometer. One inch.One amp. one foot. one mile. one inch. Alone at last. Onely the lonely. ONE ounce. One monkey.}}
* <code><nowiki>{{convert|1|ft|spell=on}}</nowiki></code> → {{convert|1|ft|spell=on}}
* <code><nowiki>{{one2a|{{convert|1|ft|spell=on}}}}</nowiki></code> → {{one2a|{{convert|1|ft|spell=on}}}}
* <code><nowiki>{{convert|2.54|cm|0|disp=out|spell=on}}</nowiki></code> → {{convert|2.54|cm|0|disp=out|spell=on}}
* <code><nowiki>{{one2a|{{convert|2.54|cm|0|disp=out|spell=on}}}}</nowiki></code> → {{one2a|{{convert|2.54|cm|0|disp=out|spell=on}}}}

== See also ==
[[Module:String]] for the following functions:
* len
* sub
* sublength
* match
* pos
* str_find
* find
* replace
* rep

Templates and modules related to capitalization
{{Case templates see also}}

Templates that implement {{tag|nowiki|o}}
* {{tl|nowiki}}
* {{tl|nowiki2}}
<includeonly>{{Sandbox other||
[[Category:Modules that manipulate strings|*]]
}}</includeonly>