మాడ్యూల్:String2/sandbox
This is the module sandbox page for మాడ్యూల్:String2 (diff). |
This module is rated as ready for general use. It has reached a mature form and is thought to be relatively 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
[మార్చు]upper
[మార్చు]The upper function simply converts all characters to upper case.
lower
[మార్చు]The lower function simply converts all characters to lower case.
title
[మార్చు]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: 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 {{#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
[మార్చు]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. (now obselete)
label
is an alias to this function for backward compatibility.
posnq
[మార్చు]- 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
[మార్చు]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.
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
[మార్చు]{{#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 (
<li>
) and any piped links that may be there.
- Although similar to magic words'
{{#invoke:String2 | ucfirst |…}}
- Capitalizes the first 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
[మార్చు]These functions take one unnamed parameter comprising (or invoking as a string) the text to be manipulated.
Examples
[మార్చు]Input | Output |
---|---|
{{#invoke:String2| upper | abcd }} | Script error: The function "upper" does not exist. |
{{#invoke:String2| upper | abCD }} | Script error: The function "upper" does not exist. |
{{#invoke:String2| upper | ABcd }} | Script error: The function "upper" does not exist. |
{{#invoke:String2| upper | ABCD }} | Script error: The function "upper" does not exist. |
{{#invoke:String2| upper | }} | Script error: The function "upper" does not exist. |
{{#invoke:String2| lower | abcd }} | Script error: The function "lower" does not exist. |
{{#invoke:String2| lower | abCD }} | Script error: The function "lower" does not exist. |
{{#invoke:String2| lower | ABcd }} | Script error: The function "lower" does not exist. |
{{#invoke:String2| lower | ABCD }} | Script error: The function "lower" does not exist. |
{{#invoke:String2| lower | }} | Script error: The function "lower" does not exist. |
{{#invoke:String2| ucfirst | abcd }} | Abcd |
{{#invoke:String2| ucfirst | abCD }} | AbCD |
{{#invoke:String2| ucfirst | ABcd }} | ABcd |
{{#invoke:String2| ucfirst | ABCD }} | ABCD |
{{#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
[మార్చు]Template:Posnq is a convenience wrapper for the posnq function.
{{Posnq |This is a piece of text to be searched |piece of }}
→ Script error: The function "posnq" does not exist.{{Posnq |This is a piece oftext to be searched |piece of }}
→ Script error: The function "posnq" does not exist.{{Posnq |This is a piece of text to be searched |"piece of "}}
→ Script error: The function "posnq" does not exist.{{Posnq |This is a piece oftext to be searched |"piece of "}}
→ Script error: The function "posnq" does not exist.
Stringsplit
[మార్చు]Template:Stringsplit is a convenience wrapper for the split function.
{{Stringsplit |This is a piece of text to be split |" "}}
→ This{{Stringsplit |This is a piece of text to be split |" "| 4}}
→ piece{{Stringsplit |This is a piece of text to be split |x| 2}}
→ t to be split
Modules may return strings with | as separators like this: {{#invoke:carousel | main | name = WPDogs | switchsecs = 5 }}
→ YellowLabradorLooking new.jpg | Yellow Labrador Retriever
{{Stringsplit |{{#invoke:carousel | main | name = WPDogs | switchsecs = 5 }}|{{!}}| 2}}
→ Yellow Labrador Retriever
Lua patterns can allow splitting at classes of characters such as punctuation:
{{Stringsplit |Apples, pears, oranges; Cats, dogs|"%p"| 2 |false}}
→ pears{{Stringsplit |Apples, pears, oranges; Cats, dogs|"%p"| 4 |false}}
→ Cats
Or split on anything that isn't a letter (no is treated as false):
{{Stringsplit |Apples pears oranges; Cats dogs|"%A+"| 4 |no}}
→ Cats
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 }}
→ oranges
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
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 )
frame.args[1] = string.lower(frame.args[1])
return p.ucfirst(frame)
end
p.ucfirst = function (frame )
local s = mw.text.trim( frame.args[1] or "" )
local s1 = ""
-- if it's a list chop off and (store as s1) everything up to the first <li>
local lipos = string.find(s, "<li>" )
if lipos then
s1 = string.sub(s, 1, lipos + 3)
s = string.sub(s, lipos + 4)
end
-- s1 is either "" or the first part of the list markup, so we can continue
-- and prepend s1 to the returned string
local letterpos
if string.find(s, "^%[%[[^|]+|[^%]]+%]%]") then
-- this is a piped wikilink, so we capitalise the text, not the pipe
local _
_, letterpos = string.find(s, "|%A*%a") -- find the first letter after the pipe
else
letterpos = string.find(s, '%a')
end
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 s1 .. first .. string.upper(letter) .. rest
else
return s1 .. 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 and alwayslower[s] == 1) then
-- leave in lowercase
else
s = mw.getContentLanguage():ucfirst(s)
end
words[i] = s
end
return table.concat(words, " ")
end
-- stripZeros finds the first number and strips leading zeros (apart from units)
-- e.g "0940" -> "940"; "Year: 0023" -> "Year: 23"; "00.12" -> "0.12"
p.stripZeros = function(frame)
local s = mw.text.trim(frame.args[1] or "")
local n = tonumber( string.match( s, "%d+" ) ) or ""
s = string.gsub( s, "%d+", n, 1 )
return s
end
-- nowiki ensures that a string of text is treated by the MediaWiki software as just a string
-- it takes an unnamed parameter and trims whitespace, then removes any wikicode
p.nowiki = function(frame)
local str = mw.text.trim(frame.args[1] or "")
return mw.text.nowiki(str)
end
-- 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.
p.posnq = function(frame)
local str = mw.text.trim(frame.args[1] or "")
local match = mw.text.trim(frame.args[2] or ""):gsub('"', '')
if str == "" or match == "" then return nil end
-- just take the start position
local pos = str:find(match, 1, true)
return pos
end
-- split splits text at boundaries specified by separator
-- and returns the chunk for the index idx (starting at 1)
-- #invoke:String2 |split |text |separator |index |true/false
-- #invoke:String2 |split |txt=text |sep=separator |idx=index |plain=true/false
-- if plain is false/no/0 then separator is treated as a Lua pattern - defaults to plain=true
p.split = function(frame)
local args = frame.args
if not(args[1] or args.txt) then args = frame:getParent().args end
local txt = args[1] or args.txt or ""
if txt == "" then return nil end
local sep = (args[2] or args.sep or ""):gsub('"', '')
local idx = tonumber(args[3] or args.idx) or 1
local plain = (args[4] or args.plain or "true"):sub(1,1)
plain = (plain ~= "f" and plain ~= "n" and plain ~= "0")
local splittbl = mw.text.split( txt, sep, plain )
if idx < 0 then idx = #splittbl + idx + 1 end
return splittbl[idx]
end
-- val2percent scans through a string, passed as either the first unnamed parameter or |txt=
-- it converts each number it finds into a percentage and returns the resultant string.
p.val2percent = function(frame)
local args = frame.args
if not(args[1] or args.txt) then args = frame:getParent().args end
local txt = mw.text.trim(args[1] or args.txt or "")
if txt == "" then return nil end
local function v2p (x)
x = (tonumber(x) or 0) * 100
if x == math.floor(x) then x = math.floor(x) end
return x .. "%"
end
txt = txt:gsub("%d[%d%.]*", v2p) -- store just the string
return txt
end
return p