Amycjgrace: Created page with "{{module rating|beta}} The module '''{{BASEPAGENAME}}''' contains five general purpose calls that convert strings to upper, lower, sentence or title case. There are also two u..."

2018-07-24T21:46:37Z

Created page with "{{module rating|beta}} The module '''{{BASEPAGENAME}}''' contains five general purpose calls that convert strings to upper, lower, sentence or title case. There are also two u..."

New page

{{module rating|beta}}
The module '''{{BASEPAGENAME}}''' contains five general purpose calls that convert strings to upper, lower, sentence or title case. There are also two utility calls that strip leading zeros from padded numbers and transform text so that it is not interpreted as wikitext.

== Functions ==
=== upper ===
The upper function simply converts all characters to upper case.

=== lower ===
The upper function simply converts all characters to upper case.

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

=== 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> -> {{#invoke:String2|sentence|[[action game]]}} with <code><nowiki>{{ucfirst:{{lc:[[action game]]}}}}</nowiki></code> -> {{ucfirst:{{lc:[[action game]]}}}}. Piped wiki-links are handled as well: <code><nowiki>{{#invoke:String2|sentence|[[trimix (breathing gas)|trimix]]}}</nowiki></code> -> {{#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. <code>label</code> is an alias to this function for backward compatibility.

=== 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" -> "940"; "Year: 0023" -> "Year: 23"; "00.12" -> "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.

== Usage ==
* <code><nowiki>{{#invoke:String2 | upper |…}}</nowiki></code> - Shifts all characters to uppercase
* <code><nowiki>{{#invoke:String2 | lower |…}}</nowiki></code> - Shifts all characters to lowercase
* <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 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 ===
The module takes one unnamed parameter comprising (or invoking as a string) the text to be manipulated.

== Examples ==
{{Further|Module:{{BASEPAGENAME}}/testcases}}

{| class="wikitable"
! scope="col" | Input
! scope="col" | Output
|-
| <nowiki>{{#invoke:String2| upper | abcd }}</nowiki>
| {{#invoke:String2| upper | abcd }}
|-
| <nowiki>{{#invoke:String2| upper | abCD }}</nowiki>
| {{#invoke:String2| upper | abCD }}
|-
| <nowiki>{{#invoke:String2| upper | ABcd }}</nowiki>
| {{#invoke:String2| upper | ABcd }}
|-
| <nowiki>{{#invoke:String2| upper | ABCD }}</nowiki>
| {{#invoke:String2| upper | ABCD }}
|-
| <nowiki>{{#invoke:String2| upper | }}</nowiki>
| {{#invoke:String2| upper | }}
|-
|  
|
|-
| <nowiki>{{#invoke:String2| lower | abcd }}</nowiki>
| {{#invoke:String2| lower | abcd }}
|-
| <nowiki>{{#invoke:String2| lower | abCD }}</nowiki>
| {{#invoke:String2| lower | abCD }}
|-
| <nowiki>{{#invoke:String2| lower | ABcd }}</nowiki>
| {{#invoke:String2| lower | ABcd }}
|-
| <nowiki>{{#invoke:String2| lower | ABCD }}</nowiki>
| {{#invoke:String2| lower | ABCD }}
|-
| <nowiki>{{#invoke:String2| lower | }}</nowiki>
| {{#invoke:String2| lower | }}
|-
|  
|
|-
| <nowiki>{{#invoke:String2| label | abcd }}</nowiki>
| {{#invoke:String2| label | abcd }}
|-
| <nowiki>{{#invoke:String2| label | abCD }}</nowiki>
| {{#invoke:String2| label | abCD }}
|-
| <nowiki>{{#invoke:String2| label | ABcd }}</nowiki>
| {{#invoke:String2| label | ABcd }}
|-
| <nowiki>{{#invoke:String2| label | ABCD }}</nowiki>
| {{#invoke:String2| label | ABCD }}
|-
| <nowiki>{{#invoke:String2| label | }}</nowiki>
| {{#invoke:String2| label | }}
|-
| <nowiki>{{#invoke:String2| label | human X chromosome }}</nowiki>
| {{#invoke:String2| label | human X chromosome}}
|-
|  
|
|-
| <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 | {{#invoke:WikidataIB |getValue |P136 |fetchwikidata=ALL |onlysourced=no |qid=Q1396889}} }}</nowiki>
| {{#invoke:String2 | sentence | {{#invoke:WikidataIB |getValue |P136 |fetchwikidata=ALL |onlysourced=no |qid=Q1396889}} }}
|-
| <nowiki>{{#invoke:String2 | sentence | {{#invoke:WikidataIB |getValue |P106 |fetchwikidata=ALL |list=hlist |qid=Q453196}} }}</nowiki>
| {{#invoke:String2 | sentence | {{#invoke:WikidataIB |getValue |P106 |fetchwikidata=ALL |list=hlist |qid=Q453196}} }}
|-
| <nowiki>{{#invoke:String2| sentence | }}</nowiki>
| {{#invoke:String2| sentence | }}
|-
|  
|
|-
| <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}}
|-
|}

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

Other templates
{{Case templates see also}}

Module:String2/doc - Revision history

Amycjgrace: Created page with "{{module rating|beta}} The module '''{{BASEPAGENAME}}''' contains five general purpose calls that convert strings to upper, lower, sentence or title case. There are also two u..."