Saucy: doc

2023-07-16T05:59:42Z

doc

New page

{{Lua|Match}}
<code>{{match|''string''|''pattern''|init=''optional''|ifMatch=''optional''|ifNo=''optional''}}</code>

This template looks for the first match of the ''pattern'' in the ''string'' and returns it. It uses the [[mediawikiwiki:Extension:Scribunto/Lua reference manual#mw.ustring.match|mw.ustring.match()]] function to do this. The pattern must be a '''[[mediawikiwiki:Extension:Scribunto/Lua reference manual#Patterns|Lua pattern]]'''. Lua patterns are essentially a nerfed version of {{w|regular expressions}}.

== TemplateData ==
<templatedata>
{
"params": {
"1": {
"label": "String",
"description": "The string to search.",
"type": "string",
"required": true
},
"2": {
"label": "Pattern",
"description": "The pattern that the string should be searched for. Must be a Lua pattern, which is like a regular expression but nerfed.",
"type": "string",
"required": true
},
"init": {
"description": "The position in the string to start searching in from.",
"type": "number",
"default": "1"
},
"ifMatch": {
"description": "What the template outputs if a match is found. If this parameter is \"MATCH\" or left undefined, then the match itself would be returned.",
"type": "string",
"default": "(the match that was found)"
},
"ifNo": {
"description": "What the template outputs if no match is found.",
"type": "string",
"default": "(empty string)"
}
},
"description": "Looks for the first match of a pattern in a string and returns it."
}
</templatedata>

Template:Match/doc - Revision history

Saucy: doc