Module:MultiReplace/doc: Difference between revisions

From ValWiki
Jump to navigation Jump to search
w>GKFX
Unify doc pages
 
w>Queen of AWB
m →‎top: {{For2}} to {{For-text}} per RfD; otherr general fixes
Line 1: Line 1:
#REDIRECT [[Template:MultiReplace/doc]]
{{Documentation subpage}}
{{high use}}
{{lua|Module:{{#ifeq:{{NAMESPACE}}|Module|Error|MultiReplace}}}}
{{For-text|a function to search for multiple patterns|{{ml|String2|matchAny|section=#matchAny}}}}
Replaces matches of multiple patterns in a given string with given replacements. For each replacement instance, the pattern matching '''at the lowest position''' is chosen. If there are multiple such patterns, then the one specified earliest in the pattern list is chosen.
 
== Usage ==
{{((}}{{#ifeq:{{NAMESPACE}}|Module|&#35;invoke:MultiReplace{{!}}main|MultiReplace}}{{!}}''input''|plain=yes<small style="font-family:sans"> (optional)</small>|''pattern1''| ''replacement1''|''pattern2''|''replacement2''... {{))}}
 
If <code>plain=yes</code> is specified, then the patterns and replacements are treated as plain text, otherwise as [[mw:Extension:Scribunto/Lua reference manual#mw.ustring.gsub|Lua Unicode patterns]].
<includeonly>{{sandbox other||
[[Category:String manipulation templates]]
}}</includeonly>

Revision as of 02:24, 2 December 2023

Template:Mbox Template:High use

Template:For-text Replaces matches of multiple patterns in a given string with given replacements. For each replacement instance, the pattern matching at the lowest position is chosen. If there are multiple such patterns, then the one specified earliest in the pattern list is chosen.

Usage

Template:((#invoke:MultiReplace|main|input|plain=yes (optional)|pattern1| replacement1|pattern2|replacement2... Template:))

If plain=yes is specified, then the patterns and replacements are treated as plain text, otherwise as Lua Unicode patterns.