Template:Str sub new/doc

From BibleStrength

Template:Documentation subpage Template:Lua

This template selects a sub-string from the target string based on selected indices. The indices are 1-based. If the end index is omitted, it returns the rest of the string. One can also specify negative indices, in which case the substr is selected by counting from the end of the string.

Usage

{{str sub new|target_string|start_index|end_index}}
{{str sub new|s=target_string|i=start_index|j=end_index}}

Examples

Unnamed parameters

{{str sub new|1234567890|3|7}}

Script error: No such module "String".

{{str sub new|1234567890|3|-3}}

Script error: No such module "String".

{{str sub new|1234567890|3}}

Script error: No such module "String".

{{str sub new|1234567890|12}}

Script error: No such module "String".

Named parameters

{{Str sub new|s=abcd=fgh|i=3|j=7}}

Script error: No such module "String".

Equivalent to:

{{#invoke:string|sub|s=abcd=fgh|i=3|j=7}}

Script error: No such module "string".

Named parameters are required if the target string contains an equals sign, where unnamed or numbered parameters will not work as expected:

{{str sub new|abcd=fgh|3|7}}

Script error: No such module "String".

{{str sub new|1=abcd=fgh|2=3|3=7}}

Script error: No such module "String".

See also

Template:Navbox with collapsible groups