Template:Trim

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

This template is used on 844,000+ 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 a single edit. Please consider discussing any 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 whitespace from a string. The string should be passed as the first unnamed parameter. 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.

Example

"{{trim| abc}}" produces "abc"

Template data

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly error report for this template.

TemplateData for Trim

The template trims whitespace from a string.

Template parameters
Parameter		Description	Type	Status
String	`1`	The string to be trimmed of whitespace	String	required

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

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

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.
{{repeat}}	Repeat a 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.

{{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	About `{{padleft:\|}}`.
...ParserFunctions	About `{{#titleparts:\|}}, {{#expr:\|}}, {{#ifeq:\|}},` etc.

The above documentation is transcluded from Template:Trim/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this template.

Contents

Usage

Example

Template data

See also

Navigation menu

Template:Trim

Usage

Example

Template data

See also

Navigation menu

Search