Template:Str find/doc

{{#invoke:Message box|mbox}} {{#invoke:Lua banner|main}}

Usage

{{Str find|text|sub_string}} = Position of first appearance of sub_string in text.

Examples

In the examples, the string to be searched is <syntaxhighlight lang="text" enclose="none">Abcdefghijklm</syntaxhighlight>:

• A; {{#invoke:String|str_find|source=Abcdefghijklm|A}}
• a; {{#invoke:String|str_find|source=Abcdefghijklm|a}}
• def; {{#invoke:String|str_find|source=Abcdefghijklm|def}}
• klm; {{#invoke:String|str_find|source=Abcdefghijklm|klm}}
• zyx; {{#invoke:String|str_find|source=Abcdefghijklm|zyx}}
• empty;klm;{{#invoke:String|str_find|source=|klm}}
• empty;empty; {{#invoke:String|str_find|source=|}}

• Case sensitive.
• Returns -1 if sub_string not found
• Character position is 1 based (not 0 based as usual in calculations).
• Warning: if sub_string is empty, then this routine will return 1 !!! This case will often have to be handled specially.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

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>

{{#invoke:Navbox|navbox}}