| This template uses Lua:
|
This template selects a sub-string from the target string based on selected indices. The indices are 1-based. If the end index is omitted, it returns the rest of the string. One can also specify negative indices, in which case the substr is selected by counting from the end of the string.
{{str sub new|target_string|start_index|end_index}}
{{str sub new|s=target_string|i=start_index|j=end_index}}
{{str sub new|1234567890|3|7}}
- 34567
{{str sub new|1234567890|3|-3}}
- 345678
{{str sub new|1234567890|3}}
- 34567890
{{str sub new|1234567890|12}}
- String Module Error: String subset index out of range
{{Str sub new|s=abcd=fgh|i=3|j=7}}
- cd=fg
Equivalent to:
{{#invoke:string|sub|s=abcd=fgh|i=3|j=7}}
- cd=fg
Named parameters are required if the target string contains an equals sign, where unnamed or numbered parameters will not work as expected:
{{str sub new|abcd=fgh|3|7}}
- String Module Error: String subset index out of range
{{str sub new|1=abcd=fgh|2=3|3=7}}
- cd=fg
String-handling templates |
---|
|
---|
By counting | {{str mid}} | To return a substring specified by 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. |
|
|
---|
By checking | {{trim}} | To trim any leading or trailing whitespace | {{str letter/trim}} | To trim down to the beginning letters. | {{str number/trim}} | To trim down to the beginning numbers. | {{trim brackets}} | To trim any leading or trailing square brackets. |
| |
|
---|
Dedicated | {{delink}} | Removes wikilink brackets (wikicode). | {{remove file prefix}} | Removes "File:" (or "Image:") from filenames. | {{PAGENAMEBASE}} | 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). |
| {{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's name prefix, if listed (ship names). | {{title year}} | Returns the 4-digit year from a pagename, if any. |
|
|
---|
|
|
Insertion, replacement and length |
---|
{{strloc insert}} | Inserts a string at character location strloc, or appends if strloc<=0. | {{loop}} | Repeat character string a specified number of times. | {{repeat}} | Repeat a string a specified number of times. | {{replace}} | Returns the string, after replacing all occurrences of a specified string with another string. | {{str rep}} | Returns the string, after replacing the first occurrence of a specified string with another string. | {{str len}} | Returns a string's length. |
|
{{iflenge}} | [if len]gth [g]reater than or [e]qual 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. |
|
|
|
Analysis and technical |
---|
{{str endswith}} | To check if a string ends with a given string. | {{str find}} {{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. | {{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. |
|
|
|
|
|