Module:Ustring/doc

Template:Module rating This module directly imports all functions from the Template:Luaref library. Documentation for each function can be found there.

The module takes an indefinite number of arguments. All arguments are coerced as number type if possible. If you wish for something to remain a string, you can simply escape it by insert \ at the beginning of the string.

You can also wrap results in tags. All non-number indexed arguments will be passed to Template:Luaref

Usage

{{#invoke:Ustring|function_name|arg1|arg2|...}} is equivalent to Template:Luaref

Example using mw.ustring.sub

{{#invoke:Ustring|sub|abcde|2|4}}

produces:

bcd

Example using mw.ustring.gsub

{{#invoke:Ustring|gsub|1234|23|}}

produces:

14

Example using mw.ustring.char

&#{{#invoke:ustring|char|49|48|59}}

produces:




This is nice for escaping character sequences in other modules; for example: <syntaxhighlight lang="lua"> p = {} function p.main(frame)

 local str = '1-2-2-1-3'
 return frame:preprocess(str:gsub('-', '/'))-- == '1/2/2-1/3'

end return p </syntaxhighlight>

Example using mw.ustring.match

{{#invoke:Ustring|match|abcde|(c%w)}}

produces:

cd

Note: Only the first match is returned. Additional returns are omitted because mw.ustring.gsub's second return value is generally undesirable.

Example using tag arguments

{{#invoke:Ustring|match
|{{Module:Ustring}}|%s%s%sif%snot%s[^%s]+%sthen.+%
<!--enter an actual newline character to match '\n'-->%s%s%send
|tag=syntaxhighlight|lang=lua}}

produces: <syntaxhighlight lang="lua"> if not args.tag then return (what(unpack(args))) end local tagargs = {} for x, y in pairs(args) do if type(x) ~= 'number' and x ~= 'tag' then tagargs[x] = y end end </syntaxhighlight>

Note that:

<syntaxhighlight lang="lua">{{#invoke:Ustring|match
|{{Module:Ustring}}|%s%s%sif%snot%s[^%s]+%sthen.+%
<!--enter an actual newline character to match '\n'-->%s%s%send}}</syntaxhighlight>

produces: <syntaxhighlight lang="lua"> if not args.tag then return (what(unpack(args))) end local tagargs = {} for x, y in pairs(args) do if type(x) ~= 'number' and x ~= 'tag' then tagargs[x] = y end end</syntaxhighlight>

Errors

Errors from accessing Template:Luaref should be maintained, e.g.:

{{#invoke:Ustring|xyzzy}}

should produce:

and

{{#invoke:Ustring|maxPatternLength}}

should produce: