Template:Str find/doc: Difference between revisions
Template page
More actions
Created page with "{{Documentation subpage}} {{Lua|Module:String}} <!----PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE----> ===Usage=== {{tlc|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). * {{Color|red|If ''sub_string'' is empty, this routine returns 1.}} This ca..." |
(No difference)
|
Latest revision as of 05:30, 20 February 2025
 | This is a documentation subpage for Template:Str find. It may contain usage information, categories and other content that is not part of the original template page. |
 | 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).
- 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
Examples with empty parameters:
- 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
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 |
See also