| 42px | This template uses Module:String, a script written in the Lua programming language. Please see Wikipedia:Lua if you want to learn more about Lua or help convert other templates. |
Usage
{{Str find|text|sub_string}} = Position of first appearance of sub_string in text.
Examples
In the examples, the string to be searched is Abcdefghijklm:
- A; 1
- a; -1
- def; 4
- klm; 11
- zyx; -1
- empty;klm;-1
- empty;empty; 1
- Case sensitive.
- Returns -1 if sub_string not found
- Character position is 1 based (not 0 based as usual in calculations).
- Warning: if sub_string is empty, then this routine will return 1 !!! This case will often have to be handled specially.
TemplateData
A template to find the numeric position of first appearance of ''sub_string'' in ''text''
Template parameters| Parameter | Description | Type | Default | Status |
|---|
| Text | 1 | The text to search within | string | empty | required |
|---|
| Sub_string | 2 | The string to be searched within the text | string | empty | required |
|---|
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 |
{{Trim}} – To trim any leading or trailing whitespace ({{Strip whitespace}} does so too, but is less effective)
{{First word}} – To trim down to the first space.
{{Remove first word}} – To remove anything before the first space.
{{Str letter/trim}} – To trim down to the beginning letters.
{{Str number/trim}} – To trim down to the beginning numbers. |
|---|
| | 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 | |
|---|
| |
|
