Template:Trim

Template documentation[view] [edit] [history] [purge]

This template is used on 24,000+ pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. 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

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Trim in articles based on its TemplateData.

TemplateData for Trim

The template trims whitespace from a string.

Template parameters[Edit template data]
Parameter		Description	Type	Status
String	`1`	The string to be trimmed of whitespace	String	required

{{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.
{{str index}}	Returns a given character from a string, but not accented letters.

{{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.

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.
{{trim leading}}	To trim up to six instances of specified <prefix>.

{{string split}}	Extract a short string from a long string.
{{first word}}	To trim down to the first space.
{{remove first word}}	To remove anything before the first space.
{{last word}}	To trim down from the last space.
{{remove last word}}	To remove anything after the last space.

Dedicated

{{delink}}, {{trim brackets}}	Removes wikilink brackets (wikicode); all or outer only.
{{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.
{{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

{{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
{{Plain text}}, {{Nowiki}}	Strips wikicode from a string.

{{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.

Analysis and searching

{{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.

{{a or an}}	Takes a noun and produces the appropriate indefinite article, based on whether the first letter is a vowel.
{{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
Module:String, Module:String2, Module:Ustring: modules that together contain most necessary string functions. Magic words: About `{{padleft:\|}}`, `{{lc:\|}}`, `{{formatnum:\|}}` etc. ParserFunctions: About `{{#titleparts:\|}}, {{#expr:\|}}, {{#ifeq:\|}},` etc.

Category:String manipulation templates

m:Category:String templates

commons:Category:String manipulation templates

The documentation on top is transcluded from Template:Trim/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.

Contents

Usage

Examples

Template data

See also