Template:Str index/doc

Note: This template is used on 10999 pages. In order not to put too much load on the servers, edits should be kept to a bare minimum.
Please discuss proposed changes on the talk page first.
Editing a template causes all pages that use the template to be re-rendered. If the Template is used often, this can put a lot of load on the servers since it fills up the job queue. [statistics]

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|0}} →
• {{str index|0123456789ABCDEF|1}} →
• 0*
• {{str index|0123456789ABCDEF|15}} →
• 0123456789ABCDE*
• {{str index|0123456789ABCDEF|18}} → Template:FormattingError