Template:Str find/doc
< Template:Str findRevision as of 02:59, 20 June 2017 by Renamed user 2560613081 (talk) (Made the page a little less like someone's madlibs.)
40px | This is a documentation subpage for Template:Str find. It contains usage information, categories and other content that is not part of the original template page. |
30px | This template uses Lua: |
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 documentation for this template used by VisualEditor and other tools; see the monthly error report for this template.
TemplateData for Str find
A template to find the numeric position of first appearance of ''sub_string'' in ''text''
Parameter | Description | Type | Status | |
---|---|---|---|---|
Text | 1 | The text to search within
| String | required |
Sub_string | 2 | The string to be searched within the text
| String | required |