Module:String2/doc

The module String2 contains 4 available calls that convert strings to upper, lower, sentence or title case.

The sentence case function finds the first letter and capitalises it, so 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.

The title case 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.

It would be useful to add further functions commonly used on strings.

Usage

• {{#invoke:String2 | upper |…}} - Shifts all characters to uppercase
• {{#invoke:String2 | lower |…}} - Shifts all characters to lowercase
• {{#invoke:String2 | label |…}} - Capitalizes the first character
  • 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.
  • As of 23 February 2018, it should now also recognise when it has an html list passed to it and capitalises the first alphabetic letter beyond the list item markup (<li>) and any piped links that may be there.
• {{#invoke:String2 | sentence |…}} - Capitalizes the first character and shifts the rest to lowercase
• {{#invoke:String2 | title |…}} - Capitalizes all words, except for a, an, the, at, by, for, in, of, on, to, up, and, as, but, or, and nor.

Parameters

The module takes one unnamed parameter comprising (or invoking as a string) the text to be converted.

Examples

Further information: Module:String2/testcases

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| label | abcd }}
{{#invoke:String2| label | abCD }}
{{#invoke:String2| label | ABcd }}
{{#invoke:String2| label | ABCD }}
{{#invoke:String2| label | }}
{{#invoke:String2| label | 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}} }}
{{#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

See also

Module:String for the following functions:

• len
• sub
• sublength
• match
• pos
• str_find
• find
• replace
• rep

Other templates

• {{Fixcaps}} – capitalizes or lowercases words (mostly used to repair paragraphs written by new editors in all-caps or all-lowercase {{fixcaps|pLAy/tHE/GamE}} → Play the Game
• {{Capitalization}} – banner-style template indicating an article needs capitalization cleanup
• {{R from other capitalisation}} – for categorizing WP:Redirects from titles to article (or other pages) where the redirect is just a different capitalization
• {{Template capitalization}} – ??
• Module:String2

Magic words that rewrite the output (copy-paste will get the text as displayed, not as entered):

• {{lc:}} – lower case output of the full text
• {{uc:}} – upper case output of the full text
• {{lcfirst:}} – lower case output of the first character only
• {{ucfirst:}} – upper case output of the first character only

This module "String2/doc" is from Wikipedia if otherwise notified