Template:Str len/doc: Difference between revisions

Latest revision as of 16:08, 15 March 2020

Please test any changes in the template's /sandbox or /testcases subpages, and consider discussing changes at the talk page before implementing them.

Uses Lua:

Module:String

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:Str len.

العربية ∙ asturianu ∙ Boarisch ∙ беларуская (тарашкевіца) ∙ български ∙ বাংলা ∙ català ∙ čeština ∙ dansk ∙ Deutsch ∙ Zazaki ∙ Ελληνικά ∙ English ∙ Esperanto ∙ español ∙ eesti ∙ euskara ∙ فارسی ∙ suomi ∙ français ∙ galego ∙ עברית ∙ हिन्दी ∙ hrvatski ∙ magyar ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ ქართული ∙ 한국어 ∙ кыргызча ∙ Lëtzebuergesch ∙ македонски ∙ മലയാളം ∙ ဘာသာမန် ∙ Bahasa Melayu ∙ Mirandés ∙ မြန်မာဘာသာ ∙ norsk bokmål ∙ Plattdüütsch ∙ Nederlands ∙ norsk ∙ polski ∙ português ∙ português do Brasil ∙ русский ∙ sicilianu ∙ Scots ∙ slovenščina ∙ српски / srpski ∙ svenska ∙ ไทย ∙ Türkçe ∙ українська ∙ اردو ∙ oʻzbekcha / ўзбекча ∙ Tiếng Việt ∙ 中文 ∙ 中文（简体） ∙ 中文（繁體） ∙ 中文（臺灣） ∙ +/−

This template takes a string as parameter and returns its length (excluding whitespace at the start and end).

Usage

Template parameters

Parameter text is empty

TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Wikipedia's help about TemplateData • Commons-specific information

This template takes a string as parameter and returns its length (excluding whitespace at the start and end).

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
string	`1`	The string to get the length of	Unknown	required

Additional information

The template is intended to be used in the following namespaces: the Template namespace

The template is intended to be used by the following user groups: all users

Localization

This template is not intended to be localized.

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 over 500 in length:

{{str len| 499-characters... }} returns 499

{{str len| 1000-characters... }} returns 1000

@@ Line 1: / Line 1: @@
-{{documentation subpage}}
+{{Use sandbox}}
-<includeonly>{{intricate template}}</includeonly>
+{{Lua|Module:String}}
-<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+{{TemplateBox
-{{caution
+  |1        = 1
-| This template is brand new. It might need a little more testing by other users, but it has passed all my tests. <br> --[[User:Davidgothberg|David Göthberg]] ([[User talk:Davidgothberg|talk]]) 14:43, 28 March 2009 (UTC)
+  |1label-en= string
+  |1d-en    = The string to get the length of
+  |1aliases = <!-- List of aliases, separated by / (a slash) -->
+  |1type    = <!-- number, string, string/wiki-user-name, string/wiki-page-name, string/line; unknown -->
+  |1def     = <!-- default value for the parameter -->
+  |1stat    = required
+  |name               = Str len
+  |desc               = This template takes a string as parameter and returns its length (excluding whitespace at the start and end).
+  |usage-notes        =
+  |namespace          = template
+  |usergroup          = all
+  |shorthand          =
+  |mustbesubst        =
+  |setscats           =
+  |placement          =
+  |example            =
+  |example-value      =
+  |relieson           =
+  |seealso            = {{string templates see also}}
+  |print              =
+  |type               =
+  |i18n-method        = -
+  |i18n-desc          =
+  |i18n-subpage       =
+  |i18n-mediawiki-msg =
+  |useTemplateData    = only
 }}
+== Examples ==
-This is the {{tl|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 {{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:
@@ Line 28: / Line 47: @@
 :<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:
+It can measure strings over 500 in length:
 :<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}}]]
-</includeonly>

commons>Tacsipacsi