Module:String: Difference between revisions
m
1 revision imported from wikipedia:Module:String
en>RexxS m (Changed protection level for "Module:String": Cascade-protected from main page, so no point in enabling TE ([Edit=Require administrator access] (indefinite) [Move=Require administrator access] (indefinite))) |
m (1 revision imported from wikipedia:Module:String) |
||
| (5 intermediate revisions by 3 users not shown) | |||
Line 59:
Parameters
s: The string to return a subset of
i: The
j: The last index of the string to return, defaults to the last character.
Line 107:
--[[
_match
match▼
This function returns a substring from the source string that matches a
specified pattern. It is exported for use in other modules
Usage:
strmatch = require("Module:String")._match
{{#invoke:String|match|source_string|pattern_string|start_index|match_number|plain_flag|nomatch_output}}▼
sresult = strmatch( s, pattern, start, match, plain, nomatch )
OR▼
{{#invoke:String|match|s=source_string|pattern=pattern_string|start=start_index▼
|match=match_number|plain=plain_flag|nomatch=nomatch_output}}▼
Parameters
Line 131 ⟶ 129:
text. Defaults to false.
nomatch: If no match is found, output the "nomatch" value rather than an error.
If invoked using named parameters, Mediawiki will automatically remove any leading or▼
trailing whitespace from each string. In some circumstances this is desirable, in▼
other cases one may want to preserve the whitespace.▼
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 Lua patterns, a form of [regular expression], see:
Line 209 ⟶ 198:
end
end
--[[
▲match
This function returns a substring from the source string that matches a
specified pattern.
Usage:
▲{{#invoke:String|match|source_string|pattern_string|start_index|match_number|plain_flag|nomatch_output}}
▲OR
▲{{#invoke:String|match|s=source_string|pattern=pattern_string|start=start_index
▲ |match=match_number|plain=plain_flag|nomatch=nomatch_output}}
Parameters
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 invoked using named parameters, Mediawiki will automatically remove any leading or
▲trailing whitespace from each string. In some circumstances this is desirable, in
▲other cases one may want to preserve the whitespace.
▲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 Lua patterns, a form of [regular expression], see:
* http://www.lua.org/manual/5.1/manual.html#5.4.1
* http://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#Patterns
* http://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#Ustring_patterns
]]
-- This is the entry point for #invoke:String|match
function str.match( frame )
| |||