Template:Str find/doc: Difference between revisions

(14 intermediate revisions by 7 users not shown)

Line 1:

;Usage

: Returns the position of a ''substring'' in a ''~~string~~'', 0 if not found.

: Returns the position (1 for the first character) of first appearance of ''substring'' in a ''text'', -1 if not found.

: {{SandboxDocumentation}}

;Examples

:* <tt><nowiki>{{Str find|Panthera (genus)|(}}</nowiki></tt> → {{Str find|Panthera (genus)|(}}

:* <code><nowiki>{{Str find|Panthera (genus)|P}}</nowiki></code> → {{Str find|Panthera (genus)|P}} (first character)

:* <tt><nowiki>{{Str find|Panthera (genus)|=}}</nowiki></tt> → {{Str find|Panthera (genus)|=}}

:* <code><nowiki>{{Str find|Panthera (genus)|a}}</nowiki></code> → {{Str find|Panthera (genus)|a}} (second character)

:* <code><nowiki>{{Str find|Panthera (genus)|(}}</nowiki></code> → {{Str find|Panthera (genus)|(}}

:* <code><nowiki>{{Str find|Panthera (genus)|/}}</nowiki></code> → {{Str find|Panthera (genus)|/}} (means not found)

:* <code><nowiki>{{Str find|Panthera (genus)|}}</nowiki></code> → {{Str find|Panthera (genus)|}} (Warning: empty substring returns 1)

;Syntax

: <~~pre><nowiki~~>{{Str ~~endswith~~ | <~~string~~> | <substring> }}</~~nowiki></pre~~>

: <syntaxhighlight lang="wikitext">{{Str find | <text> | <substring> }}</syntaxhighlight>

;Parameters

:* '''<~~string~~>'''

:* '''<text>'''

:: the tested string

:* '''<substring>'''

:: the substring to be searched in the <~~string~~>

:: the substring to be searched in the <text>

:: [[File:Dialog-warning.svg|16px]] if <substring> is empty, this template returns 1

:: [[File:Dialog-warning.svg|16px]] you cannot search for = as it is interpreted as a parameter separator

;See also

:* {{tl|Str find/logic}} a subtemplate

[[Category:String manipulation templates]]

</includeonly>