Editing Module:String/doc (section)

=== Usage ===
<pre>
{{#invoke: String|match|''source_string''|''pattern_string''|''start_index''|''match_number''|''plain_flag''|''nomatch_output''}}
</pre>

OR

<pre>
{{#invoke:</nowiki>String|match|s= ''source_string'' |pattern= ''pattern_string'' |start= ''start_index''|match= ''match_number''|plain= ''plain_flag'' |nomatch= ''nomatch_output'' }}
</pre>

; s
: The string to search
; pattern
: The pattern or string to find within the string
; start
: The index within the source string to start the search.  The first character of the string has index 1.  Defaults to 1.
; match
: In some cases it may be possible to make multiple matches on a single string.  This specifies which match to return, where the first match is match= 1.  If a negative number is specified then a match is returned counting from the last match.  Hence match = -1 is the same as requesting the last match.  Defaults to 1.
; plain
: A flag indicating that the pattern should be understood as plain text.  Defaults to false.
; nomatch
: If no match is found, output the "nomatch" value rather than an error.

If the match_number or start_index are out of range for the string being queried, then this function generates an error.  An error is also generated if no match is found.
If one adds the parameter ignore_errors=true, then the error will be suppressed and an empty string will be returned on any failure.

For information on constructing [[wikipedia:Lua (programming language)|Lua]] patterns, a form of [[wikipedia:regular expression|regular expression]], see:

* [http://www.lua.org/manual/5.1/manual.html#5.4.1 Lua reference: Patterns] (as of version 5.1)
* [[mediawikiwiki:Extension:Scribunto/Lua_reference_manual#Patterns|Scribunto patterns]]
* [[mediawikiwiki:Extension:Scribunto/Lua_reference_manual#Ustring_patterns|Scribunto Unicode string patterns]]