Module:Ustring

This module is rated as ready for general use. It has reached a mature form and is thought to be 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.

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 escape it with \, which in turn can be escaped by itself.

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

Usage

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

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

&amp;#{{#invoke:ustring|char|49|48|59}}
produces:
&#10;
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

{{#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%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}}

local p = {}

for k, v in pairs(mw.ustring) do
	p[k] = function(frame)
		local args = frame.args
		for _, v in ipairs(args) do
			args[_] = tonumber(v) or v:gsub("^\\", "", 1)
		end
		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
		return (mw.ustring[k](unpack(args)))
	end
end

return p

This module "Ustring" is from Wikipedia if otherwise notified