Difference between revisions of "Template:Str len/doc"
[unchecked revision] | [unchecked revision] |
m (Reverted edits by Wolfgang ist doof! 3 (talk) to last version by Entlinkt) |
(Removing the "This template is brand new" caution notice. Since this template has now been used on many pages by several users for some months. And adding {{high-use| 30,000+ }}.) |
||
Line 1: | Line 1: | ||
{{documentation subpage}} | {{documentation subpage}} | ||
− | + | {{high-use| 30,000+ }} | |
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | ||
− | |||
− | |||
− | |||
This is the {{tl|str len}} meta-template. | This is the {{tl|str len}} meta-template. |
Revision as of 09:00, 13 November 2009
This is a documentation subpage for Template:Str len. It contains usage information, categories and other content that is not part of the original template page. |
This template is used on 30,000+ pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please consider discussing changes on the talk page before implementing them. |
This is the {{str len}} 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}}
returns 0{{str len|}}
returns 0{{str len| }}
returns 0
It counts the length correctly, even if the string contains spaces, looks like a number, or contains special characters:
{{str len| ab cde }}
returns 6
{{str len| 1234567 }}
returns 7
{{str len| café åäö }}
returns 8
It can measure strings up to 500 in length, and returns 500 for strings that are too long:
{{str len| 499-characters... }}
returns 499{{str len| 1000-characters... }}
returns 500
Technical details
MediaWiki has no parser function or magic word to measure string lengths. And measuring string length using template code is very heavy on the servers. Thus this template is as optimised as possible. But you should consider using {{str ≥ len}} instead, since for most usage cases it is much easier to use and it costs much less server resources.
This template calls {{str len/core}} which does most of the work. For documentation on the internal workings of these two templates see /core. The talk page might also have more details.
See also
Template:String templates see also