Template:Str find/doc

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:Str find.

Uses Lua:

Usage: Returns the position (1 for the first character) of first appearance of substring in a text, -1 if not found.; Note: if you want to edit this template, first try your modifications on {{Str find/sandbox}}.You can then test your edits in {{Str find/testcases}}.
When the new version is ready, you can move it to the main template.

Examples

Syntax

{{Str find | <text> | <substring> }}

Parameters

the tested string

the substring to be searched in the <text>

if <substring> is empty, this template returns 1

you cannot search for = as it is interpreted as a parameter separator

See also

Trimming templates:

{{Trunc}} – To trim down to a specified number of characters.
{{Trim}} — To trim any leading or trailing whitespace.
{{Str left}} – To trim down to a specified number of characters, or duplicate the string to a specified number.
{{Str right}}
{{Strip}} – To strip (remove) a given number of characters from the beginning/end of the string

Analyzing templates:

{{Str endswith}} – To check if a string ends with a given string.
{{Str find}} – Returns the numerical location of a given string in a string, up to 50 characters.
{{Str len}} – Returns a string's length. Can count up to 500 characters.

String length comparison templates:

{{Str ≤ len}} – To check if a string is "shorter or equally long" or "longer" than a given length.

Technical stuff:

mw:Help:Magic words – About {{padleft:|}}.
mw:Help:Extension:ParserFunctions – About {{#titleparts:|}}, {{#expr:|}}, {{#ifeq:|}}, etc.
Module:String - Script with native string parsing