Module:Ustring/doc explained

This module directly imports all functions from the library. Documentation for each function can be found there.

The module takes an indefinite number of arguments. Arguments given as,, 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 "", "") 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 "		To get surrounding whitespace must use unnamed, but must precede with \ to indicate that it isn't a number.
"0123"		If you don't need to preserve whitespace use etc.
"0123"		If you don't need to preserve whitespace explicitly use etc.
In another template, to pass its parameter {{{1}}}, preserving whitespace		Must provide the \ with unknown string input.
In another template, to pass its parameter {{{1}}}, stripping whitespace
In another template, to pass its parameter {{{1}}}, stripping whitespace	You can also wrap results in tags. All other unused arguments will be passed to Usage <nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|''function_name''|arg1|arg2|...}

is equivalent to

Example using mw.ustring.sub

<nowiki>{{#invoke:Ustring|sub|s1=abcde|2|4}}</nowiki>

produces:

Example using mw.ustring.gsub

<nowiki>{{#invoke:Ustring|gsub|s1=1234|23|}}</nowiki>

produces:

Example using mw.ustring.char

<nowiki>&amp;amp;#{{#invoke:ustring|char|49|48|59}}</nowiki>

produces:

&#

Example using mw.ustring.match

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

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: