Difference between revisions of "Template:Str len/doc"

From Ava Zinn Wiki
Jump to: navigation, search
[unchecked revision][unchecked revision]
m (46 revisions)
 
(9 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{documentation subpage}}
+
{{Documentation subpage}}
{{used in system}}
+
{{Used in system}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+
{{Lua|Module:String}}
 
+
<!----PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE---->
 
This is the {{tl|str len}} meta-template.
 
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 now count as high as necessary.
  
=== Examples ===
+
===Examples===
 
 
 
If the parameter is empty or undefined it is considered to be of zero length:  
 
If the parameter is empty or undefined it is considered to be of zero length:  
  
Line 26: Line 25:
 
:<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 }}
 
:<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 ===
+
===Template data===
 +
{{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===
 
This is the first general-purpose template to be implemented using [[mw:Extension:Scribunto]]. The Lua code is located in [[Module:String]].
 
This is the first general-purpose template to be implemented using [[mw:Extension:Scribunto]]. The Lua code is located in [[Module:String]].
  
=== See also ===
+
===See also===
 
+
{{String-handling templates |IRL}}
{{string templates see also}}
 
  
 
<includeonly>
 
<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
+
{{#ifeq:{{SUBPAGENAME}}|sandbox | |
[[Category:String manipulation templates|{{PAGENAME}}]]
+
<!----CATEGORIES BELOW THIS LINE, PLEASE:---->
[[Category:Lua-based templates|{{PAGENAME}}]]
+
[[Category:String manipulation templates]]
 
+
}}
[[ar:قالب:Str len]]
 
[[bg:Шаблон:Str len]]
 
[[bs:Šablon:Niz dužina]]
 
[[de:Vorlage:Str len]]
 
[[eo:Ŝablono:Lin longo]]
 
[[es:Plantilla:Str len]]
 
[[ko:틀:Str len]]
 
[[hsb:Předłoha:Str len]]
 
[[id:Templat:Str len]]
 
[[lv:Veidne:Str len]]
 
[[lb:Schabloun:Str len]]
 
[[ja:Template:Str len]]
 
[[pt:Predefinição:Str len]]
 
[[ru:Шаблон:Str len]]
 
[[sl:Predloga:Str len]]
 
[[tr:Şablon:Str len]]
 
 
</includeonly>
 
</includeonly>

Latest revision as of 08:33, 5 December 2016

Template:Used in system
Gnome-utilities-terminal.svg This template uses (or will be using) Lua programming language.

Please see Wikipedia:Lua if you want to learn more about Lua or help convert other templates.

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[edit]

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 500

Template data[edit]

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Str len

The template takes a string as parameter and returns its length, excluding spaces at the start and end of the string

Template parameters

ParameterDescriptionTypeStatus
Alpha-numeric text1

The string to be counted

Default
empty
Example
empty
Auto value
empty
Stringrequired

Technical details[edit]

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

See also[edit]