Template:Strloc prefix/doc

The string-prefixer Template:Strloc_prefix gets the prefix of a string up to a specified location, or the entire string when location is less than 1.

Usage

 * {&#123;Strloc prefix| |strloc=}}

Returns the prefix of string1 up to location strloc=n, where n = 1 denotes the first character of the string. If strloc <= 0 then the entire string1 is the result. The parameter strloc can be a math formula, such as: strloc=-2, or strloc=abs(-2*5)+6.

Examples
The following show various uses:
 * {&#123;Strloc prefix|abcdef|strloc=3}}&rarr;
 * {&#123;Strloc prefix|abcdef|strloc=0}}&rarr;
 * &rarr;
 * In the example with ": the number for strloc was set by finding "(" in the title. If there had been no parenthesis "(" then the result would get the entire title.

Limitations
The text extracted is subject to the limitations of parser functions {#ifexpr:} and {padleft:}. In particular, spaces around the prefixed string are dropped, and NOT counted, before or after:
 * &rarr; ""
 * &rarr; ""

Spaces embedded within the prefix string are real spaces (NOT "&amp;#32;"), and any accented or special characters can be used in the string.