Module:String/doc: Difference between revisions

From the Croc Wiki, the Croc encyclopedia
Jump to navigationJump to search
add documentation for escapePattern
m (update examples)
(add documentation for escapePattern)
Line 305:
* <code><nowiki>"{{#invoke:String|rep|hello|3}}"</nowiki></code> → "{{#invoke:String|rep|hello|3}}"
* <code><nowiki>"{{#invoke:String|rep| hello | 3 }}"</nowiki></code> → "{{#invoke:String|rep| hello | 3 }}"
 
== escapePattern ==
 
Escapes magic characters in a [[mw:LUAREF#Patterns|Lua pattern]]. If you convert a string using this function, then the converted string will be interpreted as a literal string in functions that accept Lua patterns. For example, <code>.</code>, meaning "any character", will be converted to <code>%.</code>, meaning the literal character ".".
 
Usage:
 
* <code><nowiki>{{#invoke:String|escapePattern|</nowiki>''pattern_string''<nowiki>}}</nowiki></code>
 
Parameters:
 
; pattern_string
: The pattern string to escape
 
Examples:
 
* <code><nowiki>"{{#invoke:String|escapePattern|A.D.}}"</nowiki></code> → "{{#invoke:String|escapePattern|A.D.}}"
* <code><nowiki>"{{#invoke:String|escapePattern|10%}}"</nowiki></code> → "{{#invoke:String|escapePattern|10%}}"
 
== See also ==
Cookies help us deliver our services. By using our services, you agree to our use of cookies.

Navigation menu