View source for Help:Manipulating strings

{{shortcut|H:CHARSTR}}

BTW has several templates and [[w:wp:Lua|Lua modules]] which can format or manipulate '''[[w:strings|strings]]'''. In this context a "string" is any piece of text forming part of a page. This help page covers a few useful techniques; look in the navbox below for the full catalogue of templates.

==Substrings==
The simplest operation is taking a substring, a snippet of the string taken at a certain offset (called an "index") from the start or end. There are a number of legacy templates offering this ([[#Trimming|see navbox]]) but for new code use {{ml|String|sub|''string''|''startIndex''|''endIndex''}}. The indices are one-based (meaning the first is number one), inclusive (meaning the indices you specify are included),  and may be negative to count from the other end. For example, <code><nowiki>{{#invoke:string|sub|12345678|2|-3}}</nowiki></code> → {{#invoke:string|sub|12345678|2|-3}}. Not all the legacy substring templates use this numbering scheme, so check the documentation of unfamiliar templates.

==Using existing templates==
If you think that someone will have done what you want before, look in the navbox below and check. It is much easier to find and use an existing template than to write complex code to do it all in one place.

Look for a template that will do what you want all in one go. For example, rather than taking the final six characters of a string and checking if they are equal to "navbox", use {{tlp|str endswith|''string''|navbox}}.

==Automatically trimmed whitespace==
If you pass the string "<code style="white-space:pre">  abc def  </code>" (without quotes) to a template via a named or explicitly numbered parameter (like <code style="white-space:pre"><nowiki>{{template|1=  abc def  }}</nowiki></code> the spaces on the outside will be trimmed off and will not be counted for anything the template does with that parameter. It will see the string <code style="white-space:pre">abc def</code>.

If you use automatically numbered parameters (<code style="white-space:pre"><nowiki>{{template|  abc def  }}</nowiki></code>) the spaces on the outside do count, but some templates may still choose to remove them themselves.

==Lua patterns (regex)==
{{main article|mw:Extension:Scribunto/Lua reference manual#Patterns}}
[[w:Regular expressions|Regular expressions]] (or regex) are a common and very versatile programming technique for manipulating strings. On Wikipedia you can use a limited version of regex called a Lua pattern to select and modify bits of text from a string. The pattern is a piece of code describing what you are looking for in the string. The symbols you an use in a pattern are:
* <code>.</code> means any individual character. <code>...</code> would mean any three characters, etc.
* <code>*</code>, <code>+</code>, <code>?</code>, and <code>-</code> are the quantifiers. They mean that the previous character can be repeated {{math|n}} times, where for each symbol {{math|n ≥ 0}}, {{math|n > 0}}, {{math|n}} is zero or one, and {{math|n ≥ 0}} again respectively. (The difference with <code>-</code> is that it is "non-greedy", it matches as few symbols as possible given the rest of the pattern.)
* <code>^</code> means the start of the string, and <code>$</code> means the end.
* <code>[abc]</code> means any symbol out of a, b or c, and <code>[^abc]</code> means anything that isn't a, b or c.
* Preceding any of the above with a <code>%</code> takes away their normal meaning and makes them mean "literally" the symbol they are. Preceding anything else with a <code>%</code> (like <code>%a</code>) has a special meaning which you can check in [[mw:Extension:Scribunto/Lua reference manual#Patterns|the manual]].

Putting this all together, <code>^[Aa]*b?c</code> matches the first six characters of "AaAabcccc".

By wrapping part of the pattern in brackets, you can extract it, referencing it with the code <code>%1</code>. Example:
* The find-replace instruction {{ml|string|replace|section=#replace|AaAabc XYZ|^([Aa]*)b?c|%1|6=plain=false}} gives <code>AaAa XYZ</code>
* We can discard the XYZ by putting <code>.*</code> at the end of the search string; this picks up anything after the rest of the pattern. {{ml|string|replace|section=#replace|AaAabc XYZ|^([Aa]*)b?c.*|%1|6=plain=false}} gives <code>AaAa</code>.

=={{vanchor|StringFunctions}} (from ParserFunctions)==
BTW does not have any "StringFunctions" series of parser functions (listed below). Instead, templates use Lua (via [[Module:String]] or otherwise), alongside existing parser functions.

None of these functions will work, but they have alternatives:
* #len – use {{ml|string|len|section=#len}}
* #pos – use {{ml|string|find|section=#find}}
* #rpos
* #sub – use {{ml|string|sub|section=#sub}}
* #count – use {{ml|string|count|section=#count}}
* #replace – use {{ml|string|replace|section=#replace}}
* #explode – use {{tl|string split}}
* #urldecode – use {{ml|urldecode|urlDecode}}

==Testing code==
If you're not sure what some code is going to do, paste it into [[Special:ExpandTemplates]], which will evaluate it for you to view.

==See also==
See navbox chart below for various string-handling templates or [[w:wp:parser functions|parser functions]].

{{Template:String-handling templates |state=uncollapsed}}