 | This template is used on 840,000+ pages.
To avoid large-scale disruption and unnecessary server load, any changes to it should first be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can then be added to this page in a single edit. Please consider discussing changes on the talk page before implementing them. |
 | 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
The template trims whitespace from a string.
Template parameters
| Parameter | Description | Type | Status |
|---|
| String | 1 | The string to be trimmed of whitespace
| 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. |
|
|
|---|
| 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 matches quotes. |
| |
|
|---|
| 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 parentheses 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. | | {{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. | | {{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. |
|
| {{ASCII code}} | Returns the ASCII value of a single character. | | {{a or an}} | Takes a noun and produces the appropriate indefinite article, based on whether the first letter is a vowel. | | | | | Module:String | | | ...Magic words | <templatestyles src="Noitalic/styles.css"/>About {{padleft:|}}. | | ...ParserFunctions | <templatestyles src="Noitalic/styles.css"/>About {{#titleparts:|}}, {{#expr:|}}, {{#ifeq:|}}, etc. |
|
|
|
|
Template documentation
