Template:Str find/doc

Usage

{{Str find|text|sub_string}}

Returns the position of first appearance of sub_string in text.

• The comparison is case sensitive.
• Returns -1 if sub_string not found
• Character position is 1 based (not 0 based as usual in calculations).
• If sub_string is empty, this routine returns 1. This case will often have to be handled specially.

Examples

In the examples, the string to be searched is Abcdefghijklm:

• A; 1
• a; -1
• def; 4
• klm; 11
• zyx; -1
• empty;klm;-1
• empty;empty; 1

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Str find in articles based on its TemplateData.

TemplateData for Str find

<templatedata> {

       "description": "A template to find the numeric position of first appearance of sub_string in text",
       "params": {
               "1": {
                       "label": "Text",
                       "description": "The text to search within",
                       "type": "string",
                       "required": true
               },
               "2": {
                       "label": "Sub_string",
                       "description": "The string to be searched within the text",
                       "type": "string",
                       "required": true
               }
       }

} </templatedata>