Template:Str sub new/doc

< Template:Str sub new
Revision as of 00:24, 26 March 2019 by Gallambria (talk | contribs) (Created page with "{{Documentation subpage}} {{lua|Module:String}} <!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see Wikipedia:Wikidata)...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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}}

34567

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

345678

{{str sub new|1234567890|3}}

34567890

{{str sub new|1234567890|12}}

String Module Error: String subset index out of range

Named parameters

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

cd=fg

Equivalent to:

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

cd=fg

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}}

String Module Error: String subset index out of range

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

cd=fg

See also

Template:String-handling templates