Template:Str find/doc

From Sapphire Wiki
Revision as of 22:34, 3 September 2013 by Bryan (talk | contribs) (1 revision)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Usage

{{Str find|text|sub_string}} = Position of first appearance of sub_string in text.

Examples

In the examples, the string to be searched is <syntaxhighlight lang="text" class="" id="" style="" inline="1">Abcdefghijklm</syntaxhighlight>:

  • 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

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Str find

<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>


Template:Navbox string handling templates