Difference between revisions of "Template:Str index/doc"
From Ava Zinn Wiki
| [unchecked revision] | [unchecked revision] |
(remove limitation note) |
(update) |
||
| Line 3: | Line 3: | ||
=== Usage === | === Usage === | ||
| − | <nowiki>{{str index|</nowiki>''text''|''number''<nowiki>}}</nowiki> = Returns the ''number''-th character of ''text''. Base 1: the first character is numbered 1, and so on. | + | <nowiki>{{str index|</nowiki>''text''|''number''<nowiki>}}</nowiki> = Returns the ''number''-th character of ''text''. |
| + | |||
| + | Base 1: the first character is numbered 1, and so on. Any leading or trailing whitespace is removed from the string before searching. | ||
| + | |||
| + | If the requested position is negative, this function will search the string counting from the last character. In other words, | ||
| + | number = -1 is the same as asking for the last character of the string. | ||
| + | |||
| + | A requested position equal to zero or with a value longer than the string will generate an error. | ||
| + | |||
| + | This function will properly return a space character (' ') if the selected position contains a space. | ||
=== Examples === | === Examples === | ||
Revision as of 01:06, 24 February 2013
 |
This is a documentation subpage for Template:Str index. It contains usage information, categories and other content that is not part of the original template page. |
Usage
{{str index|text|number}} = Returns the number-th character of text.
Base 1: the first character is numbered 1, and so on. Any leading or trailing whitespace is removed from the string before searching.
If the requested position is negative, this function will search the string counting from the last character. In other words, number = -1 is the same as asking for the last character of the string.
A requested position equal to zero or with a value longer than the string will generate an error.
This function will properly return a space character (' ') if the selected position contains a space.
Examples
-
{{str index|0123456789ABCDEF|15}}→ Character not recognized by string_index -
{{str index|0123456789ABCDEF|18}}→ ((str index)): String is not long enough.
