Module:String2

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 that, 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}} → "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.

Further functions commonly used on strings would be useful additions.

Usage

• {{#invoke:String2 | upper |…}} - Capitalizing the whole characters
• {{#invoke:String2 | lower |…}} - Lowering the whole characters
• {{#invoke:String2 | label |…}} - Capitalizing the first character. Although similar to magic word {{ucfirst:}}, this works even piped wiki-links.
• {{#invoke:String2 | sentence |…}} - Capitalizing the first character and lowering the rest
• {{#invoke:String2 | title |…}} - Capitalizing all words, except a, an, the, at, by, for, in, of, on, to, up, and, as, but, or, and nor.

Parameters

Just one unnamed parameter is used, representing the text to be converted to the required case.

Examples

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

---

local p = {}

p.upper = function(frame)
	local s = mw.text.trim(frame.args[1] or "")
	return string.upper(s)
end

p.lower = function(frame)
	local s = mw.text.trim(frame.args[1] or "")
	return string.lower(s)
end

p.sentence = function (frame )
	local s =  mw.text.trim( frame.args[1] or "" )
	if string.find(s, "^%[%[[^|]+|[^%]]+%]%]") then
		-- this is a piped wikilink, so we capitalise the text, not the pipe
		local b, c = string.find(s, "|%A*%a") -- find the first letter after the pipe
		return string.sub(s, 1, c-1) .. string.upper(string.sub(s, c, c)) .. string.sub(s, c+1)
	end
	local letterpos = string.find(s, '%a')
	if letterpos then
		local first = string.sub(s, 1, letterpos - 1)
		local letter = string.sub(s, letterpos, letterpos)
		local rest = string.sub(s, letterpos + 1)
		return first .. string.upper(letter) .. string.lower(rest)
	else
		return s
	end
end

p.title = function (frame )
	-- http://grammar.yourdictionary.com/capitalization/rules-for-capitalization-in-titles.html
	-- recommended by The U.S. Government Printing Office Style Manual:
	-- "Capitalize all words in titles of publications and documents,
	-- except a, an, the, at, by, for, in, of, on, to, up, and, as, but, or, and nor."
	local alwayslower = {['a'] = 1, ['an'] = 1, ['the'] = 1, 
		['and'] = 1, ['but'] = 1, ['or'] = 1, ['for'] = 1,
		['nor'] = 1, ['on'] = 1, ['in'] = 1, ['at'] = 1, ['to'] = 1,
		['from'] = 1, ['by'] = 1, ['of'] = 1, ['up'] = 1 }
	local res = ''
	local s =  mw.text.trim( frame.args[1] or "" )
	local words = mw.text.split( s, " ")
	for i, s in ipairs(words) do
		s = string.lower( s )
		if( i > 1 ) then
			if( alwayslower[s] ~= 1 ) then
				s = mw.getContentLanguage():ucfirst(s)
			end
		else
			s = mw.getContentLanguage():ucfirst(s)
		end
		words[i] = s
	end
	return table.concat(words, " ")
end

p.label = function (frame )
	-- Capitalizing only first letter for fetched Wikidata labels.
	-- Wikidata English labels generally begin with a lowercase letter. [[:d:Help:Label#Capitalization]]
	local s =  mw.text.trim( frame.args[1] or "" )
	if string.find(s, "^%[%[[^|]+|[^%]]+%]%]") then
		-- this is a piped wikilink, so we capitalise the text, not the pipe
		local b, c = string.find(s, "|%A*%a") -- find the first letter after the pipe
		return string.sub(s, 1, c-1) .. string.upper(string.sub(s, c, c)) .. string.sub(s, c+1)
	end
	local letterpos = string.find(s, '%a')
	if letterpos then
		local first = string.sub(s, 1, letterpos - 1)
		local letter = string.sub(s, letterpos, letterpos)
		local rest = string.sub(s, letterpos + 1)
		return first .. string.upper(letter) .. rest
	else
		return s
	end
end

return p