Editing Template:Str len/doc

{{documentation subpage}}
{{used in system}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

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

It takes a string as parameter and returns its length (excluding spaces at the start and end). 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 {{tl|str ≥ len}} or one of its sister templates. See the [[#See also|see also]] section below.

=== Examples ===

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

:<code><nowiki>{{str len}}</nowiki></code> returns {{str len}}
:<code><nowiki>{{str len|}}</nowiki></code> returns {{str len|}}
:<code><nowiki>{{str len| }}</nowiki></code> returns {{str len| }}

It counts the length correctly, even if the string contains spaces, looks like a number, or contains special characters:

:<code><nowiki>{{str len| ab cde }}</nowiki></code> returns {{str len| ab cde }}

:<code><nowiki>{{str len| 1234567 }}</nowiki></code> returns {{str len| 1234567 }}

:<code><nowiki>{{str len| café åäö }}</nowiki></code> returns {{str len| café åäö }}

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

:<code><nowiki>{{str len| 499-characters... }}</nowiki></code> returns {{str len| abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi }}
:<code><nowiki>{{str len| 1000-characters... }}</nowiki></code> returns {{str len| abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghij }}

=== 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 {{tl|str ≥ len}} instead, since for most usage cases it is much easier to use and it costs much less server resources.

This template calls {{tl|str len/core}} which does most of the work. For documentation on the internal workings of these two templates see /core. The [[Template talk:Str len|talk page]] might also have more details.

=== See also ===

{{string templates see also}}

<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:String manipulation templates|{{PAGENAME}}]]

[[ar:قالب:Str len]]
[[bg:Шаблон:Str len]]
[[de:Vorlage:Str len]]
[[eo:Ŝablono:Lin longo]]
[[es:Plantilla:Str len]]
[[hsb:Předłoha:Str len]]
[[id:Templat:Str len]]
[[lv:Veidne:Str len]]
[[ja:Template:Str len]]
[[pt:Predefinição:Str len]]
[[ru:Шаблон:Str len]]
[[sl:Predloga:Str len]]
</includeonly>
@@ Line 1: / Line 1: @@
-{{Documentation subpage}}
+{{documentation subpage}}
-{{Used in system}}
+{{used in system}}
-{{Lua|Module:String}}
+<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
-<!----PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE---->
 This is the {{tl|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.
+It takes a string as parameter and returns its length (excluding spaces at the start and end). 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 {{tl|str ≥ len}} or one of its sister templates. See the [[#See also|see also]] section below.
+=== Examples ===
-===Examples===
 If the parameter is empty or undefined it is considered to be of zero length:
@@ Line 21: / Line 24: @@
 :<code><nowiki>{{str len| café åäö }}</nowiki></code> returns {{str len| café åäö }}
+It can measure strings up to 500 in length, and returns 500 for strings that are too long:
 :<code><nowiki>{{str len| 499-characters... }}</nowiki></code> returns {{str len| abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi }}
 :<code><nowiki>{{str len| 1000-characters... }}</nowiki></code> returns {{str len| abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghij }}
-===Template data===
+=== Technical details ===
-{{TemplateDataHeader}}
-<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===
+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 {{tl|str ≥ len}} instead, since for most usage cases it is much easier to use and it costs much less server resources.
-This is the first general-purpose template to be implemented using [[mw:Extension:Scribunto]]. The Lua code is located in [[Module:String]].
-===See also===
+This template calls {{tl|str len/core}} which does most of the work. For documentation on the internal workings of these two templates see /core. The [[Template talk:Str len|talk page]] might also have more details.
-{{String-handling templates |IRL}}
+=== See also ===
+{{string templates see also}}
 <includeonly>
-{{#ifeq:{{SUBPAGENAME}}|sandbox | |
+<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
-<!----CATEGORIES BELOW THIS LINE, PLEASE:---->
+[[Category:String manipulation templates|{{PAGENAME}}]]
-[[Category:String manipulation templates]]
-}}
+[[ar:قالب:Str len]]
+[[bg:Шаблон:Str len]]
+[[de:Vorlage:Str len]]
+[[eo:Ŝablono:Lin longo]]
+[[es:Plantilla:Str len]]
+[[hsb:Předłoha:Str len]]
+[[id:Templat:Str len]]
+[[lv:Veidne:Str len]]
+[[ja:Template:Str len]]
+[[pt:Predefinição:Str len]]
+[[ru:Шаблон:Str len]]
+[[sl:Predloga:Str len]]
 </includeonly>