View source for Template:Str find/doc

{{Documentation subpage}}
{{Lua|Module:String}}
<!----PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE---->
===Usage===
<nowiki>{{Str find|</nowiki>''text''|''sub_string''<nowiki>}}</nowiki> = Position of first appearance of ''sub_string'' in ''text''.

===Examples===
In the examples, the string to be searched is {{code|1=Abcdefghijklm}}:
* A; {{str find|Abcdefghijklm|A}}
* a; {{str find|Abcdefghijklm|a}}
* def; {{str find|Abcdefghijklm|def}}
* klm; {{str find|Abcdefghijklm|klm}}
* zyx; {{str find|Abcdefghijklm|zyx}}
* empty;klm;{{str find||klm}}
* empty;empty; {{str find||}}

* 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===
{{TemplateDataHeader}}
<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>

===See also===
{{String-handling templates |anlys/tech}}

<includeonly>
{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!----CATEGORIES BELOW THIS LINE, PLEASE:---->
[[Category:String manipulation templates]]
}}
</includeonly>