Latest revision as of 19:50, 8 July 2024
Warning This template is used on approximately 1,690,000 pages, or roughly 199764% of all pages ./sandbox or /testcases subpages, or in your own user subpage . The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.
[[Category:Template documentation pages{{#translation:}}]]
This template is for trimming whitespace from strings. For the maintenance tag for images, see {{trimming }}
This template trims leading and trailing (but not interior) whitespace from a string. The string should be passed as the first unnamed parameter. The parameter must be named |1= if its value contains a = character.
You may substitute this template - that is, if used as {{subst:trim }}, the resulting wikicode is "clean".
Usage {{trim |text }} = text with any leading or trailing whitespace removed.
Examples "{{trim | abc}} " produces "abc"
"{{trim |xyz }} " produces "xyz"
"{{trim | abc xyz }} " produces "abc xyz" Template data [[Category:TemplateData documentation{{#translation:}}]]
Template parameters
Parameter Description Type Status String 1The string to be trimmed of whitespace
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)
Select/remove specific item from string
{{ship prefix }} Returns the length of a ship's name prefix, if listed (ship names). {{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.
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
{{str startswith }}str endswith }} Check if a string starts or ends with a given string. {{str find }}, {{strfind short }} Returns the numerical location of a given string in a string. {{in string }} Returns optional string when given string is not found {{str count }} Count the number of occurrences of a pattern within a string. {{reSwitch }} Match one or multiple patterns with a variety of possible outputs.
{{a or an }} Takes a noun and produces the appropriate indefinite article, based on whether the first letter is a vowel. {{Array }} Array manipulation and retrieval. {{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
