Difference between revisions of "Module:Ustring/doc"

From Holdfast: Nations At War
Jump to navigation Jump to search
(Initial transfer from Wikipedia)
 
m
 
Line 1: Line 1:
{{Module rating |release<!-- Values:  pre-alpha • alpha • beta • release • protected  --  If a rating not needed/relevant, delete this template call -->}}
 
 
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
This module directly imports all functions from the {{luaref|mw.ustring}} library. Documentation for each function can be found there.
+
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 <code>\</code> at the beginning of the string.
 
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.
  
You can also wrap results in tags. All non-number indexed arguments will be passed to {{luaref|frame:extensionTag}}
+
You can also wrap results in tags. All non-number indexed arguments will be passed to frame:extensionTag
  
 
== Usage ==
 
== Usage ==
  
<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|''function_name''|arg1|arg2|...}}</code> is equivalent to {{luaref|mw.ustring|mw.ustring.function_name|args=arg1, arg2, ...}}
+
<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|''function_name''|arg1|arg2|...}}</code> is equivalent to mw.ustring|mw.ustring.function_name|args=arg1, arg2, ...
  
 
===Example using mw.ustring.sub===
 
===Example using mw.ustring.sub===

Latest revision as of 15:11, 22 August 2019

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

{{#invoke:Ustring|function_name|arg1|arg2|...}} is equivalent to mw.ustring|mw.ustring.function_name|args=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: <syntaxhighlight lang="lua"> p = {} function p.main(frame)

 local str = '1-2-2-1-3'
 return frame:preprocess(str:gsub('-', '/'))-- == '1/2/2-1/3'

end return p </syntaxhighlight>

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: <syntaxhighlight lang="lua"> 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 </syntaxhighlight>

Note that:

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

produces: <syntaxhighlight lang="lua"> 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</syntaxhighlight>