Usage
Characters in the source string are counted: the first is index 1
, the last one is index length of string
. The substring requested can be defined by these two indexes. Also, the substring can be defined by one index, and the substring length. The options are:
{{Str mid|<string>|<index of first character>|<length of substring>|<index of last character>}}
It returns a part of the <string>, starting with character on position index, length <sublength>, last charater returned is end index.
- {{str mid|Abcdefghijklmnopqrstuvwxyz|5|3}} → efg
If parameter 2 is omitted, start is from character 1:
- {{str mid|Abcdefghijklmnopqrstuvwxyz||5}} → Abcde
If parameter 3 is omitted, the hole rest of the string is returned:
- {{str mid|Abcdefghijklmnopqrstuvwxyz|15}} → opqrstuvwxyz
Counting from the end
By entering a negative value, the index is counted from the end:
- {{str mid|Abcdefghijklmnopqrstuvwxyz|-7|4}} → tuvw
- {{str mid|Abcdefghijklmnopqrstuvwxyz|-7}} → tuvwxyz
Instead if substring length, use index for last character
By using parameter |4=n
, a number, you do not ask for substring length, but the last character (as counted from the start of the input string):
- {{str mid|Abcdefghijklmnopqrstuvwxyz|5||7}} → efg
Spaces are kept
In the returned substring, spaces are kept:
- >{{str mid|I like this.|2|6}}< → >like<
But the input string is trimmed:
- >{{str mid| I like this. |2|6}}< → >like<
Error messages
When the ranges (either param2 or the substring length) is out impossible in the string, an error is returned:
- {{str mid|Abcdefghijklmnopqrstuvwxyz|30}} → String Module Error: String subset index out of range
- {{str mid|Abcdefghijklmnopqrstuvwxyz|0|45}} → efghijklmnopqrstuvwxyz
The error can be supporesssed by using |ignore errors=true
. A blank (empty string) will be returned:
- {{str mid|Abcdefghijklmnopqrstuvwxyz|0|45|ignore errors=true}} → efghijklmnopqrstuvwxyz
Error category
|no category=true
switches off category adding.
|error category=[[Category:Your category name]]
sets the category to be added when in case of an error.
- Default is Category:Errors reported by Module String.
See also
String handling templates |
---|
| As of February 2013, these templates are being optimised using Lua modules. | | Trim by counting |
- {{Str mid}} – To return a substring, specified by its position and length.
- {{Trunc}} – To trim down to a specified number of characters.
- {{Str left}} – To trim down to a specified number of characters, or duplicate the string to a specified number.
- {{Str crop}} – To crop a specified number of characters off the end.
- {{Chop head and tail}} – To crop a specified number of characters off the beginning and end.
- {{Str right}} – To trim the first specified number of characters.
- {{Str rightc}} – To return a number of characters from the end, returns a parameter if the string is empty.
- {{Str rightmost}} – To trim down to the last specified number of characters.
- {{Str sub old}} – To trim down to a specified number, starting at a given number from the left.
- {{Str sub new}} – Select a substr based on starting and ending index.
- {{Str index}} – Returns a given character from a string, but not accented letters.
|
---|
| Trim by checking | |
---|
| Insert strings |
- {{Loop}} – Repeat character string n times
- {{Replace}} – Returns the string, after replacing all occurrences of a specified string with another string.
- {{Strloc insert}} – Inserts a string at character location strloc, or appends if strloc<=0.
- {{Strloc prefix}} – Extracts string prefix up to location strloc, or whole string if strloc<=0.
- {{Str rep}} – Returns the string, after replacing the first occurrence of a specified string with another string.
|
---|
| Length |
- {{Str len}} – Returns a string's length.
- {{iflenge}} – IF LENgth Greater than or Equal to.
- {{Str ≥ len}} – To check if a string is "longer or equally long" or "shorter" than a given length.
- {{Str ≤ len}} – To check if a string is "shorter or equally long" or "longer" than a given length.
- {{Str ≠ len}} – To check if a string is "not equal" or "equal" to a given length.
- {{Str ≤ ≥ len}} – To check if a string is "shorter", "equal", or "longer" than a given length.
|
---|
| Analyse string |
- {{Str endswith}} – To check if a string ends with a given string.
- {{Str find}} – Returns the numerical location of a given string in a string.
- {{Strfind short}} – Returns the numerical location of a given string in a string.
- {{Str find0}} – Zero-based substring search.
- {{Str sub find}} – Searches a substring in a string at the given offset.
- {{ASCII code}} – Returns the ASCII value of a single character.
- {{Str letter}} – Returns the number of letters that begin a string.
- {{Str number}} – Returns the number of numbers that begin a string.
- {{Str gtr str}} – Compares two strings for alphabetical order, and returns a value accordingly.
- {{a or an}} – Takes a noun and produces the appropriate indefinite article, based on whether the first letter is a vowel.
|
---|
| Trim, dedicated |
- {{WikiProjectbasename}} - Removes "WikiProject" from a pagename
- {{Remove unranked}} - Removes the string "unranked_" from the left of a string (taxonomy).
- {{Ship prefix}} – Returns the length of a ship name prefix, if listed (ship names).
- {{Title without disambig}} – To trim off any parenthesis text at the end of a string (disambiguation).
- {{Title disambig text}} – Returns text in parenthesis at the end of a string (disambiguation).
- {{Unlink}} – Removes wikilink brackets (wikicode).
- {{Remove file prefix}}—Removes "File:" or "Image:" from filenames.
|
---|
| Technical developments | |
---|
| |
|