Module:Ustring/doc

Jump to navigation Jump to search

This is the documentation page for Module:Ustring

This module directly imports all functions from the mw.ustring 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 frame:extensionTag

Usage[edit source]

{{#invoke:Ustring|function_name|arg1|arg2|...}} is equivalent to mw.ustring.function_name( arg1, arg2, ... )

Example using mw.ustring.sub[edit source]

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

produces:

bcd

Example using mw.ustring.gsub[edit source]

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

produces:

14

Example using mw.ustring.char[edit source]

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

produces:




This is nice for escaping character sequences in other modules; for example:

p = {}
function p.main(frame)
  local str = '1-2-2{{#invoke:ustring|char|45}}1-3'
  return frame:preprocess(str:gsub('-', '/'))-- == '1/2/2-1/3'
end
return p

Example using mw.ustring.match[edit source]

{{#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[edit source]

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

produces:

		if args.tag then
			local tag = {name = args.tag, content = mw.ustring[k](unpack(args)), args = {}}
			for x, y in pairs(args) do
				if type(x)~='number' and x~='tag' then tag.args[x] = y end
			end
			return frame:extensionTag(tag)
		end

Note that:

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

produces:

{{#invoke:Ustring|match
|{{Module:Ustring}}|%s%sif.+%
<!--enter an actual newline character to match '\n'-->%s%send}}

External links[edit source]