Template:Str len/doc

From Wikispooks
Jump to navigation Jump to search

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

It takes a string as parameter and returns its length (excluding spaces at the start and end). It can now count as high as necessary.

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
{{str len| 499-characters... }} returns 499
{{str len| 1000-characters... }} returns 1000

Template data

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

TemplateData for Str len

<templatedata> {

       "description": "The template takes a string as parameter and returns its length, excluding spaces at the start and end of the string",
       "params": {
               "1": {
                       "label": "Alpha-numeric text",
                       "description": "The string to be counted",
                       "type": "string",
                       "required": true
               }
       }

} </templatedata>

Technical details

This is the first general-purpose template to be implemented using mw:Extension:Scribunto. The Lua code is located in Module:String.

See also