Module:String2/doc
This is the documentation page for Module:String2
 |
This module is rated as ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing. |
The module String2 contains five case-related calls that convert strings to upper, lower, sentence or title case and two calls that are useful for working with substrings. There are two utility calls that strip leading zeros from padded numbers and transform text so that it is not interpreted as wikitext.
Functions
[alilan ya ing pikuwanan]upper
[alilan ya ing pikuwanan]The upper function simply converts all characters to upper case.
lower
[alilan ya ing pikuwanan]The lower function simply converts all characters to lower case.
title
[alilan ya ing pikuwanan]The title function capitalises the first letter of each word in the text, apart from a number of short words recommended by The U.S. Government Printing Office Style Manual: Template:Xt.
sentence
[alilan ya ing pikuwanan]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 {{#invoke:String2|sentence|[[action game]]}} -> Action game with {{ucfirst:{{lc:[[action game]]}}}} -> action game. Piped wiki-links are handled as well:
{{#invoke:String2|sentence|[[trimix (breathing gas)|trimix]]}}-> Trimix
So are lists:
{{#invoke:String2 |sentence |{{hlist ||[[apples]] |[[pears]] |[[oranges]]}}}}→
ucfirst
[alilan ya ing pikuwanan]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. label is an alias to this function for backward compatibility.
posnq
[alilan ya ing pikuwanan]- posnq (position, no quotes) returns the numerical start position of the first occurrence of one piece of text ("match") inside another ("str").
- It returns nil if no match is found, or if either parameter is blank.
- It takes the text to be searched in as the first unnamed parameter, which is trimmed.
- It takes the text to match as the second unnamed parameter, which is trimmed and any double quotes " are stripped out. That allows spaces at the beginning or end of the match string to be included in a consistent manner.
split
[alilan ya ing pikuwanan]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.
The Template:Stringsplit is a convenience wrapper for the split function.
stripZeros
[alilan ya ing pikuwanan]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" -> "940"; "Year: 0023" -> "Year: 23"; "00.12" -> "0.12"
nowiki
[alilan ya ing pikuwanan]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
[alilan ya ing pikuwanan]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
[alilan ya ing pikuwanan]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.
Usage
[alilan ya ing pikuwanan]{{#invoke:String2 | upper |…}}- Shifts all characters to uppercase{{#invoke:String2 | lower |…}}- Shifts all characters to lowercase{{#invoke:String2 | sentence |…}}- Capitalizes the first character and shifts the rest to lowercase- Although similar to magic words'
{{ucfirst:}}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 (Template:Tag) and any piped links that may be there.
- Although similar to magic words'
{{#invoke:String2 | ucfirst |…}}- Capitalizes the first alphabetic character and leaves the rest unaltered- Works with piped wiki-links and html lists
{{#invoke:String2 | title |…}}- Capitalizes all words, except fora,an,the,at,by,for,in,of,on,to,up,and,as,but,or, andnor.{{#invoke:String2 | stripZeros |…}}- Removes leading padding zeros from the first number it finds in the string{{#invoke:String2 | title |…}}- Renders the string as plain text without wikicode
Parameters
[alilan ya ing pikuwanan]These functions take one unnamed parameter comprising (or invoking as a string) the text to be manipulated:
- upper
- lower
- title
- sentence
- ucfirst
Examples
[alilan ya ing pikuwanan]| Input | Output |
|---|---|
| {{#invoke:String2| upper | abcd }} | ABCD |
| {{#invoke:String2| upper | abCD }} | ABCD |
| {{#invoke:String2| upper | ABcd }} | ABCD |
| {{#invoke:String2| upper | ABCD }} | ABCD |
| {{#invoke:String2| upper | }} | |
| {{#invoke:String2| lower | abcd }} | abcd |
| {{#invoke:String2| lower | abCD }} | abcd |
| {{#invoke:String2| lower | ABcd }} | abcd |
| {{#invoke:String2| lower | ABCD }} | abcd |
| {{#invoke:String2| lower | }} | |
| {{#invoke:String2| ucfirst | abcd }} | Abcd |
| {{#invoke:String2| ucfirst | abCD }} | AbCD |
| {{#invoke:String2| ucfirst | ABcd }} | ABcd |
| {{#invoke:String2| ucfirst | ABCD }} | ABCD |
| {{#invoke:String2| ucfirst | 123abcd }} | 123Abcd |
| {{#invoke:String2| ucfirst | }} | |
| {{#invoke:String2| ucfirst | human X chromosome }} | Human X chromosome |
| {{#invoke:String2| sentence | abcd }} | Abcd |
| {{#invoke:String2| sentence | abCD }} | Abcd |
| {{#invoke:String2| sentence | ABcd }} | Abcd |
| {{#invoke:String2| sentence | ABCD }} | Abcd |
| {{#invoke:String2| sentence | [[action game]] }} | Action game |
| {{#invoke:String2| sentence | [[trimix (breathing gas)|trimix]] }} | Trimix |
| {{#invoke:String2 | sentence | {{#invoke:WikidataIB |getValue |P136 |fetchwikidata=ALL |onlysourced=no |qid=Q1396889}} }} | Roman à clef, satirical fiction, fable, dystopian fiction 
|
| {{#invoke:String2 | sentence | {{#invoke:WikidataIB |getValue |P106 |fetchwikidata=ALL |list=hlist |qid=Q453196}} }} |
|
| {{#invoke:String2| sentence | }} | |
| {{#invoke:String2| title | abcd }} | Abcd |
| {{#invoke:String2| title | abCD }} | Abcd |
| {{#invoke:String2| title | ABcd }} | Abcd |
| {{#invoke:String2| title | ABCD }} | Abcd |
| {{#invoke:String2| title | }} | |
| {{#invoke:String2| title | the vitamins are in my fresh california raisins}} | The Vitamins Are in My Fresh California Raisins |
Posnq
[alilan ya ing pikuwanan]Template:Posnq is a convenience wrapper for the posnq function.
{{Posnq |This is a piece of text to be searched |piece of }}→ Template:Posnq{{Posnq |This is a piece oftext to be searched |piece of }}→ Template:Posnq{{Posnq |This is a piece of text to be searched |"piece of "}}→ Template:Posnq{{Posnq |This is a piece oftext to be searched |"piece of "}}→ Template:Posnq
Stringsplit
[alilan ya ing pikuwanan]Template:Stringsplit is a convenience wrapper for the split function.
{{Stringsplit |This is a piece of text to be split |" "}}→ Template:Stringsplit{{Stringsplit |This is a piece of text to be split |" "| 4}}→ Template:Stringsplit{{Stringsplit |This is a piece of text to be split |x| 2}}→ Template:Stringsplit
Modules may return strings with | as separators like this: {{#invoke:carousel | main | name = WPDogs | switchsecs = 5 }} → Script error: No such module "carousel".
{{Stringsplit |{{#invoke:carousel | main | name = WPDogs | switchsecs = 5 }}|{{!}}| 2}}→ Template:Stringsplit
Lua patterns can allow splitting at classes of characters such as punctuation:
{{Stringsplit |Apples, pears, oranges; Cats, dogs|"%p"| 2 |false}}→ Template:Stringsplit{{Stringsplit |Apples, pears, oranges; Cats, dogs|"%p"| 4 |false}}→ Template:Stringsplit
Or split on anything that isn't a letter (no is treated as false):
{{Stringsplit |Apples pears oranges; Cats dogs|"%A+"| 4 |no}}→ Template:Stringsplit
Named parameters force the trimming of leading and trailing spaces in the parameters and are generally clearer when used:
{{Stringsplit | txt=Apples pears oranges; Cats dogs | sep="%A+" | idx=3 | plain=false }}→ Template:Stringsplit
One2a
[alilan ya ing pikuwanan]Template:One2a is a convenience wrapper for the one2a function.
Capitalisation is kept. Aimed for usage with {{Convert}}.
{{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.}}→
{{convert|1|ft|spell=on}}→ 1 foot (){{one2a|{{convert|1|ft|spell=on}}}}→ Template:One2a{{convert|2.54|cm|0|disp=out|spell=on}}→ Template:Convert/LoffAoffDoutSoff{{one2a|{{convert|2.54|cm|0|disp=out|spell=on}}}}→ Template:One2a
See also
[alilan ya ing pikuwanan]Module:String for the following functions:
- len
- sub
- sublength
- match
- pos
- str_find
- find
- replace
- rep
Other templates Template:Case templates see also