Module:String/doc: Difference between revisions

Most of the functions provided here can be invoked with named parameters, unnamed parameters, or a mixture. If named parameters are used, Mediawiki will automatically remove any leading or trailing whitespace from the parameter. Depending on the intended use, it may be advantageous to either preserve or remove such whitespace.

: If an error occurs, specifies the name of a category to include with the error message. The default category is {{clc|Errors reported by Module String}}.

This function returns a substring of the target string at specified inclusive, one-indexed indices.

The first character of the string is assigned an index of 1. If either i or j is a negative value, it is interpreted the same as selecting a character by counting from the end of the string. Hence, a value of -1 is the same as selecting the last character of the string.

If the requested indices are out of range for the given string, an error is reported. To avoid error messages, use {{ml|ustring|sub}} instead.

: The index within the source string to start the search. The first character of the string has index 1. Defaults to 1.

: 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.

: Boolean flag indicating that pattern should be understood as plain text and not as a [[mw:Extension:Scribunto/Lua reference manual#Ustring patterns|Scribunto ustring pattern]] (a unicode-friendly [[w:en:Lua (programming language)|Lua]]-style [[w:en:regular expression|regular expression]]). Defaults to false (to change: <code>plain=true</code>)

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.

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

* [[mw:Special:MyLanguage/Extension:Scribunto/Lua_reference_manualLua reference manual#Patterns|Scribunto patterns]]

* [[mw:Special:MyLanguage/Extension:Scribunto/Lua_reference_manualLua reference manual#Ustring_patternsUstring patterns|Scribunto Unicode string patterns]]

from the end of the string. In other words pos = -1 is the same as asking for the last character.

This function duplicates the behavior of {{tl|str_find}}, including all of its quirks. This is provided in order to support existing templates, but is NOT RECOMMENDED for new code and templates. New code is recommended to use the "find" function instead.

Returns the first index in "source" that is a match to "target". Indexing is 1-based, and the function returns -1 if the "target" string is not present in "source".

: <code><nowiki>{{#invoke:</nowiki>String|findstr_find|''source_string''|''target_string''}}</code>

: <code><nowiki>{{#invoke:</nowiki>String|findstr_find|source= ''source_string'' |target= ''target_string'' }}</code>

: Boolean flag indicating that target should be understood as plain text and not as a [[mw:Extension:Scribunto/Lua reference manual#Ustring patterns|Scribunto ustring pattern]] (a unicode-friendly [[w:en:Lua (programming language)|Lua]]-style [[w:en:regular expression|regular expression]]); defaults to true

This function returns the first index >= "start" where "target" can be found within "source". Indices are 1-based. If "target" is not found, then this function returns 0. If either "source" or "target" are missing / empty, this function also returns 0.

This function allows one to replace a target string or pattern within another string. To Lua programmers: this function works internally by calling {{<code>[[mw:Extension:Scribunto/Lua_reference_manual#mw.ustring.gsub|stringmw.ustring.gsub}}]]</code>.

: Boolean flag indicating that pattern should be understood as plain text and not as a [[mw:Extension:Scribunto/Lua reference manual#Ustring patterns|Scribunto ustring pattern]] (a unicode-friendly [[w:en:Lua (programming language)|Lua]]-style [[w:en:regular expression|regular expression]]); defaults to true

* <code><nowiki>"{{#invoke:String|replace| abc123def456 |123|NXYZ}}"</nowiki></code> → "{{#invoke:String|replace| abc123def456 |123|NXYZ}}"

* <code><nowiki>"{{#invoke:String|replace|source= abc123def456 |pattern= 123 |replace= NXYZ }}"</nowiki></code> → "{{#invoke:String|replace|source= abc123def456 |pattern= 123 |replace= NXYZ }}"

* <code><nowiki>"{{#invoke:String|replace| abc123def456 |%d+|NXYZ|1|false}}"</nowiki></code> → "{{#invoke:String|replace| abc123def456 |%d+|NXYZ|1|false}}"

* <code><nowiki>"{{#invoke:String|replace|source= abc123def456 |pattern= %d+ |replace= NXYZ |count=1 |plain= false }}"</nowiki></code> → "{{#invoke:String|replace|source= abc123def456 |pattern= %d+ |replace= NXYZ |count=1 |plain= false }}"

* <code><nowiki>"{{#invoke:String|replace|source= abc123def456 |pattern= %d+ |replace= NXYZ |plain= false }}"</nowiki></code> → "{{#invoke:String|replace|source= abc123def456 |pattern= %d+ |replace= NXYZ |plain= false }}"

Escapes magic characters inIn a [[:mw:LUAREF#Patterns|Lua pattern]]., If you convertchanges a string''class usingcharacter'' this function, then the converted string will be interpreted asinto a ''literal stringcharacter''. inFor functionsexample: thatin accepta Luapattern, patterns. For example,character <code>.</code>, meaningcatches "any character",; escapePattern will beconvert convertedit to <code>%.</code>, meaningcatching just the literal character ".".

== count ==

Counts the number of times a given pattern appears in the arguments that get passed on to this module. Counts disjoint matches only.

: Boolean flag indicating that pattern should be understood as plain text and not as a [[mw:Extension:Scribunto/Lua reference manual#Ustring patterns|Scribunto ustring pattern]] (a unicode-friendly [[w:en:Lua (programming language)|Lua]]-style [[w:en:regular expression|regular expression]]); defaults to true

Joins all strings passed as arguments into one string, treating the first argument as a separator.

: <code><nowiki>{{#invoke:</nowiki>String|endswith|''source_str''|''pattern_stringsearch_string''}}</code>

: <code><nowiki>{{#invoke:</nowiki>String|endswith|source= ''source_string'' |pattern= ''pattern_stringsearch_string''}}</code>

Returns "yes" if the source string ends with the patternsearch string. Use Bothnamed stringsparameters areto have the strings trimmed before use. Despite the parameter name, ''search_string'' is not a Lua pattern, it is interpreted literally.

== See also ==