Template:Trim quotes/doc

This template is used on approximately 25,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 is a documentation subpage for Template:Trim quotes.
It may contain usage information, categories and other content that is not part of the original template page.

Shortcut

Template:Trimq

This template uses Lua:

Module:Trim quotes (sandbox)

This template trims matched pairs of leading and trailing single (') and double (") quotes and whitespace from a string. The string should be passed as the first unnamed parameter or using |1= or |s= if your string contains any = signs.

Usage

[edit]

{{trim quotes|text}} = text with any leading or trailing quotes removed (as long as text doesn't contain any = signs).

{{trim quotes|1=text}} or {{trim quotes|s=text}} = text with any leading or trailing quotes removed.

Example

[edit]

{{trim quotes|1= 'Play it, Sam.' }} produces Play it, Sam..
{{trim quotes|1= ""Jimmy's""}} produces Jimmy's
{{trim quotes|1= Alex said "hello"}} produces Alex said "hello" (since the quotes aren't at the beginning and end of the string)
{{trim quotes|1=''zut alors!''}} produces zut alors! (the double-apostrophe that would otherwise display the phrase in italics is removed)
{{trim quotes|1='''This place is not a place of honor'''}} produces This place is not a place of honor (the triple-apostrophe that would otherwise display the phrase in boldface is removed)
{{trim quotes|1="fish" and "chips"}} produces fish" and "chips (the quotes at the beginning and end are removed, those in the middle are unaffected)

Template data

[edit]

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

TemplateData for Trim quotes

The template trims matched pairs of leading and trailing single and double quotes from a string.

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

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

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

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

{{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.
{{str count}}	Count the number of occurrences of a pattern within a string.

{{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
Module:String, Module:String2, Module:Ustring, Module:Text, wikitext handling: 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

Category:Modules that manipulate strings

Usage

Example

Template data

See also