Template:Trim/doc: Difference between revisions

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.

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

English Wikipedia

Category:Modules that manipulate strings

Trimming templates:

{{Trunc}} – To trim down to a specified number of characters.
{{Trim}} — To trim any leading or trailing whitespace.
{{Str left}} – To trim down to a specified number of characters, or duplicate the string to a specified number.
{{Str right}}
{{Strip}} – To strip (remove) a given number of characters from the beginning/end of the string

Analyzing templates:

{{Str endswith}} – To check if a string ends with a given string.
{{Str find}} – Returns the numerical location of a given string in a string, up to 50 characters.
{{Str len}} – Returns a string's length. Can count up to 500 characters.

String length comparison templates:

{{Str ≤ len}} – To check if a string is "shorter or equally long" or "longer" than a given length.

Sandboxes and test cases:

Technical stuff:

mw:Help:Magic words – About {{padleft:|}}.
mw:Help:Extension:ParserFunctions – About {{#titleparts:|}}, {{#expr:|}}, {{#ifeq:|}}, etc.
Module:String - Script with native string parsing

@@ Line 1: / Line 1: @@
-==Usage==
+This template trims whitespace from a string. The string should be passed as the first unnamed parameter. You may [[WP:SUBST|substitute]] this template - that is, if used as {{tlxs|trim}}, the resulting wikicode is "clean".
-To trim any leading or trailing whitespace.{{clarification|date=September 2012}}
-== See also ==
+=== Usage ===
+<nowiki>{{trim|</nowiki>''text''<nowiki>}}</nowiki> = ''text'' with any leading or trailing whitespace removed.
+=== Example ===
+*{{tlx|trim| abc}} produces {{trim| abc}}.
+===See also===
 {{String templates see also}}

Template:Trim/doc: Difference between revisions

commons>Hyacinth

Revision as of 02:11, 18 September 2012

Usage

Example

See also