From Koha Test Wiki MW Canasta on Koha Portainer
Jump to navigation
Jump to search
1
 | This template uses Lua:
|
Usage
Template:Tlc
Returns the position of first appearance of sub_string in text.
- The comparison is case sensitive.
- Returns -1 if sub_string not found
- Character position is 1 based (not 0 based as usual in calculations).
- If sub_string is empty, this routine returns 1. This case will often have to be handled specially.
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
TemplateData
A template to find the numeric position of first appearance of ''sub_string'' in ''text''
Template parameters
| Parameter | Description | Type | Status |
|---|
| Text | 1 | The text to search within
| String | required |
|---|
| Sub_string | 2 | The string to be searched within the text
| String | required |
|---|
See also
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. | | {{Plain text}}, {{Nowiki}} | Strips wikicode from a string. |
|
|
|---|
| 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. | | {{trim quotes}} | To trim leading or trailing matching quotes. |
| |
|
|---|
| 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's name prefix, if listed (ship names). | | {{title year}} | Returns the 4-digit year from a pagename, if any. | | {{title decade}} | Returns the 4-digit decade (e.g. "1740s") 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. | | {{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. | | {{digits}} | Returns the string, after removing all characters that are not digits 0–9 |
|
| {{str len}} | Returns a string's length. | | {{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. |
|
|
|
|
|
|
Template documentation