Module:String/doc - Revision history

Casiope: /* join */

2020-07-24T19:56:20Z

join

← Older revision		Revision as of 19:56, 24 July 2020
Line 287:		Line 287:
	; {{para\|separator}} : String that separates each string being joined together.		; {{para\|separator}} : String that separates each string being joined together.
	: Note that leading and trailing spaces are {{em\|not}} stripped from the separator.		: Note that leading and trailing spaces are {{em\|not}} stripped from the separator.
	; {{para\|string1}}, {{para\|~~string~~}}, etc. : Strings being joined together.		; {{para\|string1}}, {{para\|string2}}, etc. : Strings being joined together.

	=== Examples ===		=== Examples ===

Casiope at 19:54, 24 July 2020

2020-07-24T19:54:22Z

← Older revision		Revision as of 19:54, 24 July 2020
Line 12:		Line 12:
	== len ==		== len ==

	~~This~~ function returns the length of the target string.		The {{strong\|len}} function returns the length of the target string.

	=== Usage ===		=== Usage ===
Line 30:		Line 30:
	== sub ==		== sub ==

	~~This~~ function returns a substring of the target string at specified indices.		The {{strong\|sub}} function returns a substring of the target string at specified indices.

	=== Usage ===		=== Usage ===
Line 58:		Line 58:
	== sublength ==		== sublength ==

	~~This~~ function is kept in order to maintain older templates. It returns a substring of the target string starting at a specified index and of a specified length.		The {{strong\|sublength}} function is kept in order to maintain older templates. It returns a substring of the target string starting at a specified index and of a specified length.

	=== Usage ===		=== Usage ===
Line 78:		Line 78:
	== match ==		== match ==

	~~This~~ function returns a substring from the source string that matches a specified pattern.		The {{strong\|match}} function returns a substring from the source string that matches a specified pattern.

	=== Usage ===		=== Usage ===
Line 113:		Line 113:
	== pos ==		== pos ==

	~~This~~ function returns a single character from the target string at position pos.		The {{strong\|pos}} function returns a single character from the target string at position pos.

	=== Usage ===		=== Usage ===
Line 136:		Line 136:
	== str_find ==		== str_find ==

	~~This~~ function duplicates the behavior of {{tlg\|code=yes\|nolink=yes\|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.		The {{strong\|str-find}} function duplicates the behavior of {{tlg\|code=yes\|nolink=yes\|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 {{code\|source}} that is a match to {{code\|target}}. Indexing is 1‐based, and the function returns “-1” if the {{var\|target_string}} is not present in {{var\|source_string}}.		Returns the first index in {{code\|source}} that is a match to {{code\|target}}. Indexing is 1‐based, and the function returns “-1” if the {{var\|target_string}} is not present in {{var\|source_string}}.
Line 161:		Line 161:
	== find ==		== find ==

	~~This~~ function allows one to search for a target string or pattern within another string.		The {{strong\|find}} function allows one to search for a target string or pattern within another string.

	=== Usage ===		=== Usage ===
Line 194:		Line 194:
	== replace ==		== replace ==

	~~This~~ function allows one to replace a target string or pattern within another string.		The {{strong\|replace}} function allows one to replace a target string or pattern within another string.

	=== Usage ===		=== Usage ===
Line 220:		Line 220:
	== rep ==		== rep ==

	~~This~~ function repeats a string {{var\|n}} times. A simple function to pipe string.rep to templates.		The {{strong\|rep}} function repeats a string {{var\|n}} times. A simple function to pipe string.rep to templates.

	=== Usage ===		=== Usage ===
Line 238:		Line 238:
	== escapePattern ==		== escapePattern ==

	~~This~~ function 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\|.}}, meaning “any character”, will be converted to {{code\|%.}}, meaning the literal character “.”.		The {{strong\|escapePattern}} function 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\|.}}, meaning “any character”, will be converted to {{code\|%.}}, meaning the literal character “.”.

	=== Usage ===		=== Usage ===
Line 255:		Line 255:
	== count ==		== count ==

	~~This~~ function counts the number of times a given pattern appears in the arguments that get passed on to this module.		The {{strong\|count}} function counts the number of times a given pattern appears in the arguments that get passed on to this module.

	=== Usage ===		=== Usage ===
Line 277:		Line 277:
	== join ==		== join ==

	~~This~~ function joins all strings passed as arguments into one string, treating the first argument as a separator		The {{strong\|join}} function joins all strings passed as arguments into one string, treating the first argument as a separator

	=== Usage ===		=== Usage ===
Line 301:		Line 301:
	== endswith ==		== endswith ==

	~~This~~ function returns “yes” if the source string ends with the pattern string. Both strings are trimmed before use.		The {{strong\|endswith}} function returns “yes” if the source string ends with the pattern string. Both strings are trimmed before use.

	=== Usage ===		=== Usage ===

	: <code><nowiki>{{#invoke:</nowiki>String\|count\|{{var\|source_str}}\|{{var\|pattern_string}}}}</code>		: <code><nowiki>{{#invoke:</nowiki>String\|count\|{{var\|source_str}}\|{{var\|pattern_string}}}}</code>
	: <code><nowiki>{{#invoke:</nowiki>String\|count\|source={{var\|source_string}}\|pattern={{var\|pattern_string}}}}</code>		: <code><nowiki>{{#invoke:</nowiki>String\|count\|source={{var\|source_string}}\|pattern={{var\|pattern_string}}}}</code>

Casiope at 19:49, 24 July 2020

2020-07-24T19:49:05Z

Show changes

Casiope at 19:39, 24 July 2020

2020-07-24T19:39:55Z

Casiope at 19:30, 24 July 2020

2020-07-24T19:30:31Z

Show changes

Casiope: /* find */

2020-07-24T18:31:25Z

find

← Older revision		Revision as of 18:31, 24 July 2020
Line 160:		Line 160:

	Usage:		Usage:
	: <code><nowiki>{{#invoke:</nowiki>String\|find\|''source_string''\|''target_string''\|''start_index''\|''plain_flag''}}</code>		: <code><nowiki>{{#invoke:</nowiki>String\|find\|{{var\|source_string}}\|{{var\|target_string}}\|{{var\|start_index}}\|{{var\|plain_flag}}}}</code>

	Or		Or

	: <code><nowiki>{{#invoke:</nowiki>String\|find\|source= ''source_string'' \|target= ''target_string'' \|start= ''start_index'' \|plain= ''plain_flag'' }}</code>		: <code><nowiki>{{#invoke:</nowiki>String\|find\|source={{var\|source_string}}\|target={{var\|target_string}}\|start={{var\|start_index}}\|plain={{var\|plain_flag}}}}</code>

	Parameters:		Parameters:
Line 172:		Line 172:
	; {{para\|plain}} : 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 Lua‐style regular expression); defaults to true.		; {{para\|plain}} : 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 Lua‐style regular expression); defaults to true.

	This function returns the first index >= {{code\|start}} where {{code\|target}} can be found within {{code\|source}}. Indices are 1‐based. If {{code\|target}} is not found, then this function returns “0”. If either {{~~code~~\|source}} or {{~~code~~\|target}} are missing or empty, this function also returns “0”.		This function returns the first index >= {{code\|start}} where {{code\|target}} can be found within {{code\|source}}. Indices are 1‐based. If {{code\|target}} is not found, then this function returns “0”. If either {{para\|source}} or {{para\|target}} are missing or empty, this function also returns “0”.

	This function should be safe for UTF-8 strings.		This function should be safe for UTF-8 strings.

Casiope at 15:24, 24 July 2020

2020-07-24T15:24:47Z

← Older revision		Revision as of 15:24, 24 July 2020
Line 290:		Line 290:
	* <code><nowiki>{{#invoke:String\|join\| – \|a\|b\|c\|d\|e\|f\|g}}</nowiki></code> → {{#invoke:String\|join\| – \|a\|b\|c\|d\|e\|f\|g}}		* <code><nowiki>{{#invoke:String\|join\| – \|a\|b\|c\|d\|e\|f\|g}}</nowiki></code> → {{#invoke:String\|join\| – \|a\|b\|c\|d\|e\|f\|g}}

	The preceding example uses the ~~html~~ entity &ndash; but the unicode character also works.		The preceding example uses the HTML entity &ndash; but the unicode character also works.

	== endswith ==		== endswith ==

Casiope at 15:33, 21 July 2020

2020-07-21T15:33:58Z

← Older revision		Revision as of 15:33, 21 July 2020
Line 122:		Line 122:
	; {{para\|pos}} : The index for the character to return.		; {{para\|pos}} : The index for the character to return.

	The first character has an index value of 1. If one requests a negative value, this function will select a character by counting ~~backwards~~ from the end of the string. In other words {{para\|pos\|-1}} is the same as asking for the last character.		The first character has an index value of 1. If one requests a negative value, this function will select a character by counting backward from the end of the string. In other words, {{para\|pos\|-1}} is the same as asking for the last character.

	A requested value of zero, or a value greater than the length of the string returns an error.		A requested value of zero, or a value greater than the length of the string returns an error.
Line 132:		Line 132:
	== str_find ==		== str_find ==

	This function duplicates the behavior of {{~~tnull~~\|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.		This function duplicates the behavior of {{tlg\|code=yes\|nolink=yes\|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 {{code\|source}} that is a match to {{code\|target}}. Indexing is 1‐based, and the function returns “-1” if the {{code\|target}} string is not present in {{code\|source}}.		Returns the first index in {{code\|source}} that is a match to {{code\|target}}. Indexing is 1‐based, and the function returns “-1” if the {{code\|target}} string is not present in {{code\|source}}.

	Important Note: If the {{code\|target}} string is empty / missing, this function returns a value of “1”, which is generally unexpected behavior, and must be accounted for separately.		Important Note: If the {{code\|target}} string is empty/missing, this function returns a value of “1”, which is generally unexpected behavior, and must be accounted for separately.

	Usage:		Usage:

Casiope at 16:44, 20 July 2020

2020-07-20T16:44:22Z

← Older revision		Revision as of 16:44, 20 July 2020
Line 305:		Line 305:
	* <code><nowiki>{{#invoke:String\|endswith\|xxxyyy\|z}}</nowiki></code> → {{#invoke:String\|endswith\|xxxyyy\|z}}		* <code><nowiki>{{#invoke:String\|endswith\|xxxyyy\|z}}</nowiki></code> → {{#invoke:String\|endswith\|xxxyyy\|z}}

	[[Category:Modules documentation]]		[[Category:Modules]][[Category:Modules documentation]]

Casiope at 23:32, 13 July 2020

2020-07-13T23:32:39Z

← Older revision		Revision as of 19:39, 24 July 2020
Line 152:		Line 152:
	* <code><nowiki>{{#invoke:String\|str_find\|abc123def}}</nowiki></code> → {{#invoke:String\|str_find\|abc123def}}		* <code><nowiki>{{#invoke:String\|str_find\|abc123def}}</nowiki></code> → {{#invoke:String\|str_find\|abc123def}}
	* <code><nowiki>{{#invoke:String\|str_find\|source=abc123def}}</nowiki></code> → {{#invoke:String\|str_find\|source=abc123def}}		* <code><nowiki>{{#invoke:String\|str_find\|source=abc123def}}</nowiki></code> → {{#invoke:String\|str_find\|source=abc123def}}
	* <code><nowiki>{{#invoke:String\|str_find\|abc123def\|123}}</nowiki></code> → {{#invoke:String\|str_find\| abc123def \|123}}		* <code><nowiki>{{#invoke:String\|str_find\|abc123def\|123}}</nowiki></code> → {{#invoke:String\|str_find\|abc123def\|123}}
	* <code><nowiki>{{#invoke:String\|str_find\|source=abc123def\|target=123}}</nowiki></code> → {{#invoke:String\|str_find\|source=abc123def\|target=123}}		* <code><nowiki>{{#invoke:String\|str_find\|source=abc123def\|target=123}}</nowiki></code> → {{#invoke:String\|str_find\|source=abc123def\|target=123}}

Line 182:		Line 182:
	* <code><nowiki>{{#invoke:String\|find\| abc123def \|123}}</nowiki></code> → {{#invoke:String\|find\| abc123def \|123}}		* <code><nowiki>{{#invoke:String\|find\| abc123def \|123}}</nowiki></code> → {{#invoke:String\|find\| abc123def \|123}}
	* <code><nowiki>{{#invoke:String\|find\|source= abc123def \|target= 123 }}</nowiki></code> → {{#invoke:String\|find\|source= abc123def \|target= 123 }}		* <code><nowiki>{{#invoke:String\|find\|source= abc123def \|target= 123 }}</nowiki></code> → {{#invoke:String\|find\|source= abc123def \|target= 123 }}
	* <code><nowiki>{{#invoke:String\|find\|source=abc123def\|target=%d \|start=3 \|plain=false }}</nowiki></code> → {{#invoke:String\|find\|source=abc123def\|target=%d \|start=3 \|plain=false }}		* <code><nowiki>{{#invoke:String\|find\|source=abc123def\|target=%d\|start=3\|plain=false}}</nowiki></code> → {{#invoke:String\|find\|source=abc123def\|target=%d\|start=3\|plain=false}}

	When using unnamed parameters, preceding and trailing spaces are kept and counted:		When using unnamed parameters, preceding and trailing spaces are kept and counted:
Line 270:		Line 270:

	Usage:		Usage:
	: <code><nowiki>{{#invoke:</nowiki>String\|join\|{{var\|separator}}\|{{var\|string1}}\|{{var\|string2}}\|~~...~~}}</code>		: <code><nowiki>{{#invoke:</nowiki>String\|join\|{{var\|separator}}\|{{var\|string1}}\|{{var\|string2}}\|…}}</code>

	Parameters:		Parameters:

← Older revision		Revision as of 23:32, 13 July 2020
Line 5:		Line 5:
	== Global options ==		== Global options ==

	; ignore_errors		; {{para\|ignore_errors}} : If set to {{code\|true}} or {{code\|1}}, any error condition will result in an empty string being returned rather than an error message.
	: If set to 'true' or 1, any error condition will result in an empty string being returned rather than an error message.		; {{para\|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”.
	; error_category		; {{para\|no_category}} : If set to {{code\|true}} or {{code\|1}}, no category will be added if an error is generated.
	: 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.

	== len ==		== len ==
Line 43:		Line 40:
	Parameters:		Parameters:
	; {{para\|s}} : The string to return a subset of.		; {{para\|s}} : The string to return a subset of.
	; {{para\|i}} : The first index of the substring to return, defaults to 1.		; {{para\|i}} : The first index of the substring to return, defaults to {{code\|1}}.
	; {{para\|j}} : The last index of the string to return, defaults to the last character.		; {{para\|j}} : The last index of the string to return, defaults to the last character.

	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.		The first character of the string is assigned an index of 1. If either {{para\|i}} or {{para\|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.		If the requested indices are out of range for the given string, an error is reported.
Line 89:		Line 86:
	; {{para\|s}} : The string to search.		; {{para\|s}} : The string to search.
	; {{para\|pattern}} : The pattern or string to find within the string.		; {{para\|pattern}} : The pattern or string to find within the string.
	; {{para\|start}} : The index within the source string to start the search. The first character of the string has index 1. Defaults to 1.		; {{para\|start}} : The index within the source string to start the search. The first character of the string has index 1. Defaults to {{code\|1}}.
	; {{para\|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.		; {{para\|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 {{para\|match\|1}}. If a negative number is specified then a match is returned counting from the last match. Hence {{para\|match\|-1}} is the same as requesting the last match. Defaults to {{code\|1}}.
	; {{para\|plain}} : 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 Lua‐style regular expression). Defaults to false (to change: ~~<code>~~plain=true~~</code>~~).		; {{para\|plain}} : 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 Lua‐style regular expression). Defaults to false (to change: {{para\|plain\|true}}).
	; {{para\|nomatch}} : If no match is found, output the ~~“nomatch”~~ value rather than an error.		; {{para\|nomatch}} : If no match is found, output the {{code\|nomatch}} value rather than an error.
	; {{para\|ignore_errors}} : If no match is found and {{~~code~~\|ignore_errors=true}}, output an empty string rather than an error.		; {{para\|ignore_errors}} : If no match is found and {{para\|ignore_errors\|true}}, output an empty string rather than an error.

	If the {{code\|match_number}} or {{code\|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 the {{code\|match_number}} or {{code\|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.
Line 137:		Line 134:
	This function duplicates the behavior of {{tnull\|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.		This function duplicates the behavior of {{tnull\|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 {{code\|source}} that is a match to {{code\|target}}. Indexing is 1‐based, and the function returns -1 if the {{code\|target}} string is not present in {{code\|source}}.		Returns the first index in {{code\|source}} that is a match to {{code\|target}}. Indexing is 1‐based, and the function returns “-1” if the {{code\|target}} string is not present in {{code\|source}}.

	Important Note: If the {{code\|target}} string is empty / missing, this function returns a value of “1”, which is generally unexpected behavior, and must be accounted for separately.		Important Note: If the {{code\|target}} string is empty / missing, this function returns a value of “1”, which is generally unexpected behavior, and must be accounted for separately.
Line 172:		Line 169:
	; {{para\|source}} : The string to search.		; {{para\|source}} : The string to search.
	; {{para\|target}} : The string or pattern to find within source.		; {{para\|target}} : The string or pattern to find within source.
	; {{para\|start}} : The index within the source string to start the search, defaults to 1.		; {{para\|start}} : The index within the source string to start the search, defaults to {{code\|1}}.
	; {{para\|plain}} : 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 Lua‐style regular expression); defaults to true.		; {{para\|plain}} : 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 Lua‐style regular expression); defaults to true.

	This function returns the first index >= {{code\|start}} where {{code\|target}} can be found within {{code\|source}}. Indices are 1‐based. If {{code\|target}} is not found, then this function returns 0. If either {{code\|source}} or {{code\|target}} are missing or empty, this function also returns 0.		This function returns the first index >= {{code\|start}} where {{code\|target}} can be found within {{code\|source}}. Indices are 1‐based. If {{code\|target}} is not found, then this function returns “0”. If either {{code\|source}} or {{code\|target}} are missing or empty, this function also returns “0”.

	This function should be safe for UTF-8 strings.		This function should be safe for UTF-8 strings.
Line 211:		Line 208:
	; {{para\|pattern}} : The string or pattern to find within source.		; {{para\|pattern}} : The string or pattern to find within source.
	; {{para\|replace}} : The replacement text.		; {{para\|replace}} : The replacement text.
	; {{para\|count}} : The number of occurrences to replace; defaults to all.		; {{para\|count}} : The number of occurrences to replace; defaults to {{code\|all}}.
	; {{para\|plain}} : 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 Lua‐style regular expression); defaults to true.		; {{para\|plain}} : 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 Lua‐style regular expression); defaults to {{code\|true}}.

	Examples:		Examples:
Line 266:		Line 263:
	; {{para\|source_string}} : The string to count occurrences in.		; {{para\|source_string}} : The string to count occurrences in.
	; {{para\|pattern}} : The string or pattern to count occurrences of within source.		; {{para\|pattern}} : The string or pattern to count occurrences of within source.
	; {{para\|plain}} : 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 Lua‐style regular expression); defaults to true.		; {{para\|plain}} : 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 Lua‐style regular expression); defaults to {{code\|true}}.

	Examples:		Examples: