View source for Templet:Strloc prefix/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES & INTERWIKIS AT BOTTOM OF THIS 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.
__NOTOC__
=== Usage ===
::: {&#123;'''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===
The following show various uses:
:* {&#123;Strloc prefix|abcdef|strloc=3}}{{pad|2em}}&rarr; {{Strloc prefix|abcdef|strloc=3}}
:* {&#123;Strloc prefix|abcdef|strloc=0}}{{pad|2em}}&rarr; {{Strloc prefix|abcdef|strloc=0}}
:* <nowiki>{{Strloc prefix|My Title (film)|strloc= {{strfind_short|My Title (film)|(|1|lenstr={{strlen_quick|My Title (film)}}|}}-2}}</nowiki>{{pad|2em}}&rarr; {{Strloc prefix|My Title (film)|strloc= {{strfind_short|My Title (film)|(|1|lenstr={{strlen_quick|My Title (film)}}|}}-2}}
:: In the example with "{{[[Template:Strfind_short|strfind_short]]}}: the number for strloc was set by finding "(" in the<br>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 [[WP:Parser function|parser functions]] {#ifexpr:} and {padleft:}. In particular, spaces around the prefixed string are dropped, and NOT counted, before or after:
:* <nowiki>{{Strloc prefix| Title here |strloc=9}}</nowiki> &nbsp; &rarr; "{{Strloc prefix| Title here |strloc=9}}"
:* <nowiki>{{Strloc prefix| Title here |strloc=0}}</nowiki> &nbsp; &rarr; "{{Strloc prefix| Title here |strloc=0}}"
Spaces embedded within the prefix string are ''real'' spaces (NOT "&amp;#32;"), and any accented or special characters can be used in the string.

=== See also ===
{{String templates see also}}

<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->

[[Category:String manipulation templates]]
[[Category:Templates with minimal expansion depth]]

</includeonly>