Content added Content deleted
Line 1:
Line 1:
{{high use}}
{{high use}}
{{Documentation subpage}}
{{Documentation subpage}}
{{Lua|Module:String}}
{{Lua|Module:StringW }}
<!----PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE---->
<!----PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE---->
===Usage===
===Usage===
Latest revision as of 16:14, 24 August 2024
This template is used on many pages. To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in its /sandbox or /testcases subpages or in your own user subpage .
The tested changes can then be added to this page in one single edit.
Please consider discussing any changes on the talk page before implementing them.
Usage {{Str find|text |sub_string }}
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
:
A; 1
a; -1
def; 4
klm; 11
zyx; -1 Examples with empty parameters:
empty;klm; -1
empty;empty; 1 TemplateData Template parameters
Parameter Description Type Status Text 1The text to search within
String required Sub_string 2The string to be searched within the text
String required
See also
String-handling templates
(help page) Substring (select chunk of string by its position)
{{Str sub new Select a substring based on starting and ending index counted in either direction. {{Str left Keep the first N characters of a string, or duplicate it to N characters. {{Str crop Return all but the last N characters of a string. {{Str index Return the N-th character of a string.
{{Str right Return substring starting at N-th character to end of string. {{Str rightc Return the last N characters of a string; or a given value if empty. {{Str sub old Return substring of given length starting at N-th character.
Trimming (select/remove chunk of string by character type)
{{Trim Trim any leading or trailing whitespace {{Str letter/trim Trim down to the beginning letters. {{Str number/trim Trim down to the beginning numbers. {{Trim brackets Trim any leading or trailing square brackets. {{Trim quotes Trim leading or trailing matching quotes. {{Trim leading Trim up to six instances of specified <prefix>.
Select/remove specific item from string
{{Delink Trim brackets Removes wikilink brackets (wikicode); all or outer only . {{Plain text Removes wikicode (formatting and brackets) {{PAGENAMEBASE Trim off any parenthesis text at the end of a string (disambiguation). {{Title disambig text Returns text in parentheses at the end of a string (disambiguation).
{{Title year Returns the 3-or-4-digit year from a pagename, if any. {{Title decade Returns the 4-digit decade from a pagename (e.g. "1740" from "Foo 1740s bar"), if any. {{Title number Returns any number from a pagename. {{WikiProjectbasename Removes "WikiProject" from a pagename.
Insertion, replacement and length
{{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 {{Nowiki Displays wikitext as plain text.
{{Str len Returns a string's length. {{Str ≥ len Check if a string is "longer or equally long" or "shorter" than a given length. {{Str ≤ len Check if a string is "shorter or equally long" or "longer" than a given length. {{Str ≠ len Check if a string is "not equal" or "equal" to a given length.
Analysis and searching
{{Array Array item manipulation and retrieval. {{A or an Takes a noun and produces the appropriate indefinite article, based on whether the first letter is a vowel. {{In string Returns optional string when given string is not found {{Isnumeric Returns number when true, blank when not numeric. {{Str letter Returns the number of letters that begin a string. {{Str number Returns the number of numbers that begin a string.
Modules and built-in functions
