Template:Str len/doc

From Ava Zinn Wiki
< Template:Str len
Revision as of 23:31, 27 March 2009 by Davidgothberg (talk) (Starting out the documentation for this string length measuring template. Will add technical details later.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This is the {{str len full}} meta-template.

It takes a string as parameter and returns its length. It can count up to 500 in length, and returns 500 for strings that are too long.

Note! For most usage cases it is much easier and costs much less server resources to use {{str ≥ len}} or one of its sister templates. See the see also section below.

Examples

If the parameter is empty or undefined it is considered to be of zero length:

{{str len full}}, {{str len full|}}, {{str len full| }}
Template:Str len full, Template:Str len full, Template:Str len full

This template counts the length of the string, even if it contains spaces or looks like a number:

{{str len full| ab cde }}, {{str len full| 1234567 }}
Template:Str len full, Template:Str len full

It can measure strings up to 500 in length, and returns 500 for strings that are too long:

{{str len full| 499-characters... }}, {{str len full| 1000-characters... }}
Template:Str len full, Template:Str len full

Technical details

This template calls {{str len full/core}} which does most of the work.

See also

Easy to use and efficient string length comparison templates:

  • {{str ≥ len}} – To check if a string is "longer or equally long" vs. "shorter" than a given length.
  • {{str ≤ len}} – To check if a string is "shorter or equally long" vs. "longer" than a given length.
  • {{str ≠ len}} – To check if a string is "not equal" vs. "equal" to a given length.
  • {{str ≤ ≥ len}} – To check all three of "shorter", "equal" and "longer" at the same time.

Much less efficient string length templates:

  • {{str len full}} – Can count up to 500 in length. Returns 500 for strings that are too long.
  • {{strlen}} – Can only count up to 64 in length. Returns 64 for strings that are too long.
  • {{str len}} – Can only count up to 80 in length. Returns an error message for strings longer than 80. And it counts any whitespace that surrounds its input.