https://pool.calebcooper.ie/index.php?action=history&feed=atom&title=Module%3AUstring%2FdocModule:Ustring/doc - Revision history2026-04-08T06:51:16ZRevision history for this page on the wikiMediaWiki 1.43.8https://pool.calebcooper.ie/index.php?title=Module:Ustring/doc&diff=11786&oldid=prevCaleb Cooper: Created page with "{{Module rating |release<!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}} <!-- Please..."2020-10-16T11:24:15Z<p>Created page with "{{Module rating |release<!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}} <!-- Please..."</p>
<p><b>New page</b></p><div>{{Module rating |release<!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}}<br />
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --><br />
This module directly imports all functions from the {{luaref|Ustring library|mw.ustring}} library. Documentation for each function can be found there.<br />
<br />
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 <code>\</code> at the beginning of the string.<br />
<br />
You can also wrap results in tags. All non-number indexed arguments will be passed to {{luaref|frame:extensionTag}}<br />
<br />
== Usage ==<br />
<br />
<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|''function_name''|arg1|arg2|...}}</code> is equivalent to {{luaref|Ustring library|mw.ustring.''function_name''|args=arg1, arg2, ...}}<br />
<br />
===Example using mw.ustring.sub===<br />
<code><nowiki>{{#invoke:Ustring|sub|abcde|2|4}}</nowiki></code><br />
<br />
produces:<br />
<br />
{{#invoke:Ustring|sub|abcde|2|4}}<br />
<br />
===Example using mw.ustring.gsub===<br />
<code><nowiki>{{#invoke:Ustring|gsub|1234|23|}}</nowiki></code><br />
<br />
produces:<br />
<br />
{{#invoke:Ustring|gsub|1234|23|}}<br />
<br />
===Example using mw.ustring.char===<br />
<code><nowiki>&amp;amp;#{{#invoke:ustring|char|49|48|59}}</nowiki></code><br />
<br />
produces:<br />
<br />
&amp;#{{#invoke:ustring|char|49|48|59}}<br />
<br />
This is nice for escaping character sequences in other modules; for example:<br />
<syntaxhighlight lang="lua"><br />
p = {}<br />
function p.main(frame)<br />
local str = '1-2-2{{#invoke:ustring|char|45}}1-3'<br />
return frame:preprocess(str:gsub('-', '/'))-- == '1/2/2-1/3'<br />
end<br />
return p<br />
</syntaxhighlight><br />
<br />
===Example using mw.ustring.match===<br />
<code><nowiki>{{#invoke:Ustring|match|abcde|(c%w)}}</nowiki></code><br />
<br />
produces:<br />
<br />
{{#invoke:Ustring|match|abcde|(c%w)}}<br />
<br />
Note: Only the first match is returned. Additional returns are omitted because mw.ustring.gsub's second return value is generally undesirable.<br />
<br />
===Example using tag arguments===<br />
<pre>{{#invoke:Ustring|match<br />
|{{Module:Ustring}}|%s%s%sif%snot%s[^%s]+%sthen.+%<br />
<!--enter an actual newline character to match '\n'-->%s%s%send<br />
|tag=syntaxhighlight|lang=lua}}</pre><br />
produces:<br />
{{#invoke:Ustring|match<br />
|{{Module:Ustring}}|%s%s%sif%snot%s[^%s]+%sthen.+%<br />
<!--enter an actual newline character to match '\n'-->%s%s%send<br />
|tag=syntaxhighlight|lang=lua}}<br />
<br />
Note that:<br />
{{#tag:pre|<nowiki><syntaxhighlight lang="lua">{{#invoke:Ustring|match<br />
|{{Module:Ustring}}|%s%s%sif%snot%s[^%s]+%sthen.+%<br />
<!--enter an actual newline character to match '\n'-->%s%s%send}}</syntaxhighlight></nowiki>}}<br />
produces:<br />
<syntaxhighlight lang="lua">{{#invoke:Ustring|match<br />
|{{Module:Ustring}}|%s%s%sif%snot%s[^%s]+%sthen.+%<br />
<!--enter an actual newline character to match '\n'-->%s%s%send}}</syntaxhighlight><br />
<br />
== Errors ==<br />
Errors from accessing {{luaref|Ustring library|mw.ustring}} should be maintained, e.g.:<br />
<br />
<code><nowiki>{{#invoke:Ustring|xyzzy}}</nowiki></code><br />
<br />
should produce:<br />
<br />
{{script error|Script error: The function "xyzzy" does not exist.}}<br />
<br />
and<br />
<br />
<code><nowiki>{{#invoke:Ustring|maxPatternLength}}</nowiki></code><br />
<br />
should produce:<br />
<br />
{{script error|Script error: "maxPatternLength" is not a function.}}<br />
<br />
== See also ==<br />
* [[Module:String]]<br />
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |<br />
<!-- Categories below this line, please; interwikis at Wikidata --><br />
<br />
}}</includeonly></div>Caleb Cooper