Module:Text

Module documentation[view] [edit] [history] [purge]

Text – Module containing methods for the manipulation of text, wikimarkup and some HTML.

Functions for templates

All methods have an unnamed parameter containing the text.

The return value is an empty string if the parameter does not meet the conditions. When the condition is matched or some result is successfully found, strings of at least one character are returned.

char

Creates a string from a list of character codes.

1

Space-separated list of character codes

*

Number of repetitions of the list in parameter 1; (Default 1).

errors

0 – Silence errors

concatParams

Combine any number of elements into a list, like table.concat() in Lua.

From a template:

1

First element; missing and empty elements are ignored.

2 3 4 5 6 …

Further list elements

From Lua

args

table (sequence) of the elements

apply

Separator between elements; defaults to |

adapt

optional formatting, which will be applied to each element; must contain %s.

containsCJK

Returns whether the input string contains any CJK characters

• Returns nothing if there are no CJK characters

removeDelimited

Remove all text between delimiters, including the delimiters themselves.

getPlain

Remove wikimarkup (except templates): comments, tags, bold, italic, nbsp

isLatinRange

Returns some content, unless the string contains a character that would not normally be found in Latin text.

• Returns nothing if there is a non-Latin string.

isQuote

Returns some content if the parameter passed is a single character, and that character is a quote, such as '.

• Returns nothing for multiple characters, or if the character passed is not a quote.

listToText

Formats list elements analogously to mw.text.listToText().

The elements are separated by a comma and space ; the word "and" appears between the first and last.

Unnamed parameters become the list items.

Optional parameters for #invoke:

• format – Every list element will first be formatted with this format string; see here for how to construct this string. The string must contain at least one %s sequence.
• template=1 – List elements should be taken from the calling template.

Returns the resulting string.

quote

Wrap the string in quotes; quotes can be chosen for a specific language.

1

Input text (will be automatically trimmed); may be empty.

2

(optional) the ISO 639 language code for the quote marks; should be one of the supported languages(in German)

3

(optional)2 for second level quotes. This means the single quote marks in a statement such as: Jack said, “Jill said ‘fish’ last Tuesday.”

quoteUnquoted

Wrap the string in quotes; quotes can be chosen for a specific language. Will not quote an empty string, and will not quote if there is a quote at the start or end of the (trimmed) string.

1

Input text (will be automatically trimmed); may be empty.

2

(optional) the ISO 639 language code for the quote marks; should be one of the supported languages(in German)

3

(optional)2 for second level quotes. This means the single quote marks in a statement such as: Jack said, “Jill said ‘fish’ last Tuesday.”

removeDiacritics

Removes all diacritical marks from the input.

1

Input text

sentenceTerminated

Is this sentence terminated? Should work with CJK, and allows quotation marks to follow.

• Returns nothing if the sentence is unterminated.

ucfirstAll

The first letter of every recognized word is converted to upper case. This contrasts with the parser function {{ucfirst:}} which changes only the first character of the whole string passed.

A few common HTML entities are protected; the implementation of this may mean that numerical entities passed (e.g. &) are converted to & form

uprightNonlatin

Takes a string. Italicized non-Latin characters are un-italicized, unless they are a single Greek letter.

zip

Combines a tuple of lists by convolution. This is easiest to explain by example: given two lists, list1 = "a,b,c" and list2 = "1,2,3", then
zip(list1, list2, sep = ",", isep = "-", osep = "/")
outputs
a-1/b-2/c-3

• 1, 2, 3, … – Lists to be combined
• sep – A separator (in Lua regex form) used to split the lists. If empty, the lists are split into individual characters.
• sep1, sep2, sep3, … – Allows a different separator to be used for each list.
• isep – Output separator; placed between elements which were at the same index in their lists.
• osep – Output separator; placed between elements which had different original indices; i.e. between the groups joined with isep

split

Splits a string into chunks at the specified delimiter, and returns the first (or user-specified) chunk. This is non-Unicode-aware implementation of mw.text.split which, for ASCII-only text, can be up to 60 times faster.

• 1 (or text) – the text to be split
• 2 (or pattern) – the pattern to use when splitting the text. By default, this can be a string library pattern.
• 3 (or plain) – if set to "true", pattern will be interpreted as plain text, not a pattern.
• 4 (or index) – The chunk to return. If omitted, the first chunk will be returned. Can be set to a negative number to count from the end (e.g. -1 will return the last chunk).

Examples and test page

There are tests available(in German) to illustrate this in practice.

Use in another Lua module

All of the above functions can be called from other Lua modules. Use require(); the below code checks for errors loading it:

locallucky,Text=pcall(require,"Module:Text")iftype(Text)=="table"thenText=Text.Text()else-- In the event of errors, Text is an error message.return"<span class=\"error\">"..Text.."</span>"end

You may then call:

• Text.char( apply, again, accept )
• Text.concatParams( args, separator, format )
• Text.containsCJK( s )
• Text.removeDelimited( s )
• Text.getPlain( s )
• Text.isLatinRange( s )
• Text.isQuote( c )
• Text.listToText( table, format )
• Text.quote( s, lang, mode )
• Text.quoteUnquoted( s, lang, mode )
• Text.removeDiacritics( s )
• Text.sentenceTerminated( s )
• Text.split( text, pattern, plain ) – non Unicode version of mw.text.split
• Text.gsplit( text, pattern, plain ) – non Unicode version of mw.text.gsplit
• Text.ucfirstAll( s )
• Text.uprightNonlatin( s )

Usage

This is a general library; use it anywhere.

Dependencies

• Module:Yesno
• Module:Text/data --- Lua patterns and information about quotes

See also

The above documentation is transcluded from Module:Text/doc. (edit | history)
Editors can experiment in this module's sandbox(edit | diff) and testcases(edit | run) pages.
Subpages of this module.

localyesNo=require("Module:Yesno")localText={serial="2024-09-21",suite="Text"}--[=[Text utilities]=]localfunctionfiatQuote(apply,alien,advance)-- Quote text-- Parameter:-- apply -- string, with text-- alien -- string, with language code-- advance -- number, with level 1 or 2localr=applyandtostring(apply)or""alien=alienor"en"advance=tonumber(advance)or0localsuitelocaldata=mw.loadData('Module:Text/data')localQuoteLang=data.QuoteLanglocalQuoteType=data.QuoteTypelocalslang=alien:match("^(%l+)-")suite=QuoteLang[alien]orslangandQuoteLang[slang]orQuoteLang["en"]ifsuitethenlocalquotes=QuoteType[suite]ifquotesthenlocalspaceifquotes[3]thenspace="&#160;"elsespace=""endquotes=quotes[advance]ifquotesthenr=mw.ustring.format("%s%s%s%s%s",mw.ustring.char(quotes[1]),space,apply,space,mw.ustring.char(quotes[2]))endelsemw.log("fiatQuote() "..suite)endendreturnrend-- fiatQuote()Text.char=function(apply,again,accept)-- Create string from codepoints-- Parameter:-- apply -- table (sequence) with numerical codepoints, or nil-- again -- number of repetitions, or nil-- accept -- true, if no error messages to be appended-- Returns: stringlocalr=""apply=type(apply)=="table"andapplyor{}again=math.floor(tonumber(again)or1)ifagain<1thenreturn""endlocalbad={}localcodes={}for_,vinipairs(apply)dolocaln=tonumber(v)ifnotnor(n<32andn~=9andn~=10)thentable.insert(bad,tostring(v))elsetable.insert(codes,math.floor(n))endendif#bad>0thenifnotacceptthenr=tostring(mw.html.create("span"):addClass("error"):wikitext("bad codepoints: "..table.concat(bad," ")))endreturnrendif#codes>0thenr=mw.ustring.char(unpack(codes))ifagain>1thenr=r:rep(again)endendreturnrend-- Text.char()localfunctiontrimAndFormat(args,fmt)localresult={}iftype(args)~='table'thenargs={args}endfor_,vinipairs(args)dov=mw.text.trim(tostring(v))ifv~=""thentable.insert(result,fmtandmw.ustring.format(fmt,v)orv)endendreturnresultendText.concatParams=function(args,apply,adapt)-- Concat list items into one string-- Parameter:-- args -- table (sequence) with numKey=string-- apply -- string (optional); separator (default: "|")-- adapt -- string (optional); format including "%s"-- Returns: stringlocalcollect={}returntable.concat(trimAndFormat(args,adapt),applyor"|")end-- Text.concatParams()Text.containsCJK=function(s)-- Is any CJK code within?-- Parameter:-- s -- string-- Returns: true, if CJK detecteds=sandtostring(s)or""localpatternCJK=mw.loadData('Module:Text/data').PatternCJKreturnmw.ustring.find(s,patternCJK)~=nilend-- Text.containsCJK()Text.removeDelimited=function(s,prefix,suffix)-- Remove all text in s delimited by prefix and suffix (inclusive)-- Arguments:-- s = string to process-- prefix = initial delimiter-- suffix = ending delimiter-- Returns: stripped strings=sandtostring(s)or""prefix=prefixandtostring(prefix)or""suffix=suffixandtostring(suffix)or""localprefixLen=mw.ustring.len(prefix)localsuffixLen=mw.ustring.len(suffix)ifprefixLen==0orsuffixLen==0thenreturnsendlocali=s:find(prefix,1,true)localr=slocaljwhileidoj=r:find(suffix,i+prefixLen)ifjthenr=r:sub(1,i-1)..r:sub(j+suffixLen)elser=r:sub(1,i-1)endi=r:find(prefix,1,true)endreturnrendText.getPlain=function(adjust)-- Remove wikisyntax from string, except templates-- Parameter:-- adjust -- string-- Returns: stringlocalr=Text.removeDelimited(adjust,"<!--","-->")r=r:gsub("(</?%l[^>]*>)",""):gsub("'''",""):gsub("''",""):gsub("&nbsp;"," ")returnrend-- Text.getPlain()Text.isLatinRange=function(s)-- Are characters expected to be latin or symbols within latin texts?-- Arguments:-- s = string to analyze-- Returns: true, if valid for latin onlys=sandtostring(s)or""--- ensure input is always stringlocalPatternLatin=mw.loadData('Module:Text/data').PatternLatinreturnmw.ustring.match(s,PatternLatin)~=nilend-- Text.isLatinRange()Text.isQuote=function(s)-- Is this character any quotation mark?-- Parameter:-- s = single character to analyze-- Returns: true, if s is quotation marks=sandtostring(s)or""ifs==""thenreturnfalseendlocalSeekQuote=mw.loadData('Module:Text/data').SeekQuotereturnmw.ustring.find(SeekQuote,s,1,true)~=nilend-- Text.isQuote()Text.listToText=function(args,adapt)-- Format list items similar to mw.text.listToText()-- Parameter:-- args -- table (sequence) with numKey=string-- adapt -- string (optional); format including "%s"-- Returns: stringreturnmw.text.listToText(trimAndFormat(args,adapt))end-- Text.listToText()Text.quote=function(apply,alien,advance)-- Quote text-- Parameter:-- apply -- string, with text-- alien -- string, with language code, or nil-- advance -- number, with level 1 or 2, or nil-- Returns: quoted stringapply=applyandtostring(apply)or""localmode,slangiftype(alien)=="string"thenslang=mw.text.trim(alien):lower()elseslang=mw.title.getCurrentTitle().pageLanguageifnotslangthen-- TODO FIXME: Introduction expected 2017-04slang=mw.language.getContentLanguage():getCode()endendifadvance==2thenmode=2elsemode=1endreturnfiatQuote(mw.text.trim(apply),slang,mode)end-- Text.quote()Text.quoteUnquoted=function(apply,alien,advance)-- Quote text, if not yet quoted and not empty-- Parameter:-- apply -- string, with text-- alien -- string, with language code, or nil-- advance -- number, with level 1 or 2, or nil-- Returns: string; possibly quotedlocalr=mw.text.trim(applyandtostring(apply)or"")locals=mw.ustring.sub(r,1,1)ifs~=""andnotText.isQuote(s,advance)thens=mw.ustring.sub(r,-1,1)ifnotText.isQuote(s)thenr=Text.quote(r,alien,advance)endendreturnrend-- Text.quoteUnquoted()Text.removeDiacritics=function(adjust)-- Remove all diacritics-- Parameter:-- adjust -- string-- Returns: string; all latin letters should be ASCII-- or basic greek or cyrillic or symbols etc.localcleanup,decomposedlocalPatternCombined=mw.loadData('Module:Text/data').PatternCombineddecomposed=mw.ustring.toNFD(adjustandtostring(adjust)or"")cleanup=mw.ustring.gsub(decomposed,PatternCombined,"")returnmw.ustring.toNFC(cleanup)end-- Text.removeDiacritics()Text.sentenceTerminated=function(analyse)-- Is string terminated by dot, question or exclamation mark?-- Quotation, link termination and so on granted-- Parameter:-- analyse -- string-- Returns: true, if sentence terminatedlocalrlocalPatternTerminated=mw.loadData('Module:Text/data').PatternTerminatedifmw.ustring.find(analyse,PatternTerminated)thenr=trueelser=falseendreturnrend-- Text.sentenceTerminated()Text.ucfirstAll=function(adjust)-- Capitalize all words-- Arguments:-- adjust = string to adjust-- Returns: string with all first letters in upper caseadjust=adjustandtostring(adjust)or""localr=mw.text.decode(adjust,true)locali=1localc,j,mm=(r~=adjust)r=" "..rwhileidoi=mw.ustring.find(r,"%W%l",i)ifithenj=i+1c=mw.ustring.upper(mw.ustring.sub(r,j,j))r=string.format("%s%s%s",mw.ustring.sub(r,1,i),c,mw.ustring.sub(r,i+2))i=jendend-- while ir=r:sub(2)ifmthenr=mw.text.encode(r)endreturnrend-- Text.ucfirstAll()Text.uprightNonlatin=function(adjust)-- Ensure non-italics for non-latin text parts-- One single greek letter might be granted-- Precondition:-- adjust -- string-- Returns: string with non-latin parts enclosed in <span>localrlocaldata=mw.loadData('Module:Text/data')localPatternLatin=data.PatternLatinlocalRangesLatin=data.RangesLatinlocalNumLatinRanges=data.NumLatinRangesifmw.ustring.match(adjust,PatternLatin)then-- latin only, horizontal dashes, quotesr=adjustelselocalclocalj=falselocalk=1localm=falselocaln=mw.ustring.len(adjust)localspan="%s%s<span dir='auto' style='font-style:normal'>%s</span>"localflat=function(a)-- isLatinlocalrange-- NumLatinRanges has to be precomputed because # does not work from loadDatafori=1,NumLatinRangesdorange=RangesLatin[i]ifa>=range[1]anda<=range[2]thenreturntrueendend-- for iend-- flat()localfocus=function(a)-- char is not ambivalentlocalr=(a>64)ifrthenr=(a<8192ora>8212)elser=(a==38ora==60)-- '&' '<'endreturnrend-- focus()localform=function(a)returnstring.format(span,r,mw.ustring.sub(adjust,k,j-1),mw.ustring.sub(adjust,j,a))end-- form()r=""fori=1,ndoc=mw.ustring.codepoint(adjust,i,i)iffocus(c)thenifflat(c)thenifjthenifmthenifi==mthen-- single greek letter.j=falseendm=falseendifjthenlocalnx=i-1locals=""forix=nx,1,-1doc=mw.ustring.sub(adjust,ix,ix)ifc==" "orc=="("thennx=nx-1s=c..selsebreak-- for ixendend-- for ixr=form(nx)..sj=falsek=iendendelseifnotjthenj=iifc>=880andc<=1023then-- single greek letter?m=i+1elsem=falseendendelseifmthenm=m+1endend-- for iifjand(notmorm<n)thenr=form(n)elser=r..mw.ustring.sub(adjust,k)endendreturnrend-- Text.uprightNonlatin()Text.test=function(about)localrifabout=="quote"thendata=mw.loadData('Module:Text/data')r={}r.QuoteLang=data.QuoteLangr.QuoteType=data.QuoteTypeendreturnrend-- Text.test()-- Non Unicode-aware version of mw.text.split and mw.text.gsplit-- based on [[phab:diffusion/ELUA/browse/master/includes/Engines/LuaCommon/lualib/mw.text.lua]]-- These run up to 60 times faster than the Unicode-aware versionsText.split=function(text,pattern,plain)localret={}forminText.gsplit(text,pattern,plain)doret[#ret+1]=mendreturnretendText.gsplit=function(text,pattern,plain)locals,l=1,string.len(text)returnfunction()ifsthenlocale,n=string.find(text,pattern,s,plain)localretifnotethenret=string.sub(text,s)s=nilelseifn<ethen-- Empty separator!ret=string.sub(text,s,e)ife<lthens=e+1elses=nilendelseret=e>sandstring.sub(text,s,e-1)or''s=n+1endreturnretendend,nil,nilend-- Exportlocalp={}for_,funcinipairs({'containsCJK','isLatinRange','isQuote','sentenceTerminated'})dop[func]=function(frame)returnText[func](frame.args[1]or"")and"1"or""endendfor_,funcinipairs({'getPlain','removeDiacritics','ucfirstAll','uprightNonlatin'})dop[func]=function(frame)returnText[func](frame.args[1]or"")endendfunctionp.char(frame)localparams=frame:getParent().argslocalstory=params[1]localcodes,lenient,multipleifnotstorythenparams=frame.argsstory=params[1]endifstorythenlocalitems=mw.text.split(mw.text.trim(story),"%s+")if#items>0thenlocaljlenient=(yesNo(params.errors)==false)codes={}multiple=tonumber(params["*"])for_,vinipairs(items)doj=tonumber((v:sub(1,1)=="x"and"0"or"")..v)table.insert(codes,jorv)endendendreturnText.char(codes,multiple,lenient)endfunctionp.concatParams(frame)localargslocaltemplate=frame.args.templateiftype(template)=="string"thentemplate=mw.text.trim(template)template=(template=="1")endiftemplatethenargs=frame:getParent().argselseargs=frame.argsendreturnText.concatParams(args,frame.args.separator,frame.args.format)endfunctionp.listToFormat(frame)locallists={}localpformat=frame.args["format"]localsep=frame.args["sep"]or";"-- Parameter parsen: Listenfork,vinpairs(frame.args)dolocalknum=tonumber(k)ifknumthenlists[knum]=vendend-- Listen splittenlocalmaxListLen=0fori=1,#listsdolists[i]=mw.text.split(lists[i],sep)if#lists[i]>maxListLenthenmaxListLen=#lists[i]endend-- Ergebnisstring generierenlocalresult=""localresult_line=""fori=1,maxListLendoresult_line=pformatforj=1,#listsdoresult_line=mw.ustring.gsub(result_line,"%%s",lists[j][i],1)endresult=result..result_lineendreturnresultendfunctionp.listToText(frame)localargslocaltemplate=frame.args.templateiftype(template)=="string"thentemplate=mw.text.trim(template)template=(template=="1")endiftemplatethenargs=frame:getParent().argselseargs=frame.argsendreturnText.listToText(args,frame.args.format)endfunctionp.quote(frame)localslang=frame.args[2]iftype(slang)=="string"thenslang=mw.text.trim(slang)ifslang==""thenslang=falseendendreturnText.quote(frame.args[1]or"",slang,tonumber(frame.args[3]))endfunctionp.quoteUnquoted(frame)localslang=frame.args[2]iftype(slang)=="string"thenslang=mw.text.trim(slang)ifslang==""thenslang=falseendendreturnText.quoteUnquoted(frame.args[1]or"",slang,tonumber(frame.args[3]))endfunctionp.zip(frame)locallists={}localseps={}localdefaultsep=frame.args["sep"]or""localinnersep=frame.args["isep"]or""localoutersep=frame.args["osep"]or""-- Parameter parsenfork,vinpairs(frame.args)dolocalknum=tonumber(k)ifknumthenlists[knum]=velseifstring.sub(k,1,3)=="sep"thenlocalsepnum=tonumber(string.sub(k,4))ifsepnumthenseps[sepnum]=vendendendend-- sofern keine expliziten Separatoren angegeben sind, den Standardseparator verwendenfori=1,math.max(#seps,#lists)doifnotseps[i]thenseps[i]=defaultsependend-- Listen splittenlocalmaxListLen=0fori=1,#listsdolists[i]=mw.text.split(lists[i],seps[i])if#lists[i]>maxListLenthenmaxListLen=#lists[i]endendlocalresult=""fori=1,maxListLendoifi~=1thenresult=result..outersependforj=1,#listsdoifj~=1thenresult=result..innersependresult=result..(lists[j][i]or"")endendreturnresultendfunctionp.split(frame)localtext=frame.args.textorframe.args[1]or''localpattern=frame.args.patternorframe.args[2]or''localplain=yesNo(frame.args.plainorframe.args[3])localindex=tonumber(frame.args.index)ortonumber(frame.args[4])or1locala=Text.split(text,pattern,plain)ifindex<0thenindex=#a+index+1endreturna[index]endfunctionp.failsafe()returnText.serialendp.Text=function()returnTextend-- p.Textreturnp