Module:String/documentation: Difference between revisions

From The Languages of David J. Peterson
Jump to navigation Jump to search
m (Djpwikiadmin moved page Module:String/doc to Module:String/documentation)
No edit summary
 
Line 11: Line 11:
; no_category
; no_category
: If set to {{code|lua|true}} or {{code|lua|1}}, no category will be added if an error is generated.
: If set to {{code|lua|true}} or {{code|lua|1}}, no category will be added if an error is generated.
==See also==
* [[Module:string utilities]] – main module for string manipulation
* [[Module:str]]
<includeonly>
<includeonly>
[[Category:General utility modules]]
[[Category:General utility modules]]
[[Category:Lua metamodules]]
[[Category:Lua metamodules]]
[[Category:Wiktionary modules]]
</includeonly>
</includeonly>

Latest revision as of 19:56, 18 September 2023

This module is intended to provide access to basic string functions.

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.

Global options

ignore_errors
If set to true or 1, any error condition will result in an empty string being returned rather than an error message.
error_category
If an error occurs, specifies the name of a category to include with the error message. The default category is Errors reported by Module String.
no_category
If set to true or 1, no category will be added if an error is generated.

See also