Template:Strloc prefix/doc
 |
This is a documentation subpage for Template:Strloc prefix (see that page for the template itself). It contains usage information, categories, interlanguage links and other content that is not part of the original template page. |
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
[edit source]- {{Strloc prefix|<string1>|strloc=<n>}}
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={{{len}}}-2, or strloc=abs(-2*5)+6.
Examples
[edit source]The following show various uses:
- {{Strloc prefix|abcdef|strloc=3}} → abc
- {{Strloc prefix|abcdef|strloc=0}} → abcdef
- {{Strloc prefix|My Title (film)|strloc= {{strfind_short|My Title (film)|(|1|lenstr={{strlen_quick|My Title (film)}}|}}-2}} → My Title
- In the example with "{{strfind_short}}: 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
[edit source]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:
- {{Strloc prefix| Title here |strloc=9}} → "Title her"
- {{Strloc prefix| Title here |strloc=0}} → "Title here"
Spaces embedded within the prefix string are real spaces (NOT " "), and any accented or special characters can be used in the string.
See also
[edit source]- {{Strfind short}} - can be used to set strloc and default to whole string
- {{Strlen short}} - gets length of a short string (faster than {str len} )
- {{Strloc insert}} - inserts text at strloc, which can be set by {strfind_short}
Description of all string templates