Module:Ustring: Difference between revisions

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

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. Arguments given as |s1=, |s2=, etc, are read first, and are used as strings. All remaining numerical arguments are coerced to number type if possible, and remain strings if not. If you wish for a numerical (i.e. unnamed or "|1=", "|2=") to remain a string, you can simply escape it by inserting \ at the beginning of the string.

Note that MediaWiki will always trim whitespace from named arguments; to give arguments with surrounding whitespace you must use unnamed parameters starting with \.

How to pass inconvenient strings

To pass this...	Write this	Explanation
" 0123 "	|\ 123	To get surrounding whitespace must use unnamed, but must precede with \ to indicate that it isn't a number.
"0123"	|s1=0123	If you don't need to preserve whitespace use |s1= etc.
"0123"	|1=\0123	If you don't need to preserve whitespace explicitly use |1= etc.
In another template, to pass its parameter {{{1}}}, preserving whitespace	|\{{{1}}}	Must provide the \ with unknown string input.
In another template, to pass its parameter {{{1}}}, stripping whitespace	|s1={{{1}}}
In another template, to pass its parameter {{{1}}}, stripping whitespace	|1=\{{#if:1|{{{1}}}}}

You can also wrap results in tags. All other unused 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|s1=abcde|2|4}}

produces:

Example using mw.ustring.gsub

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

produces:

Example using mw.ustring.char

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

produces:

&#

Example using mw.ustring.match

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

produces:

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
|s1={{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:

Note that:

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

produces:

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

Errors

Errors from accessing mw.ustring should be maintained, e.g.:

{{#invoke:Ustring|xyzzy}}

should produce:

and

{{#invoke:Ustring|maxPatternLength}}

should produce:

See also

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

require('Module:No globals')
return setmetatable({}, {
	__index = function(t, f)
		return function(frame)
			if nil == mw.ustring[f] then
				return '<strong class="error">'..mw.message.new('scribunto-common-nosuchfunction', '', f):plain()..'</strong>'
			end
			if 'function' ~= type(mw.ustring[f]) then
				return '<strong class="error">'..mw.message.new('scribunto-common-notafunction', '', f):plain()..'</strong>'
			end
			local args = frame.args
			for i, v in ipairs(args) do
				args[i] = tonumber(v) or v:gsub("^\\", "", 1)
			end
			if args.tag then
				local tagargs = {}
				for k, v in pairs(args) do
					if 'number' ~= type(k) and 'tag' ~= k then tagargs[k] = v end
				end
				return frame:extensionTag{name = args.tag, content = mw.ustring[f](unpack(args)), args = tagargs}
			end
			return (mw.ustring[f](unpack(args)))
		end
	end
})