Template:Str find/doc
 | 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. |
 | This template uses Lua: |
Usage
[edit]{{Str find|text|sub_string}} = Position of first appearance of sub_string in text.
Examples
[edit]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
- 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
[edit]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 |