Template:Str ≥ len/doc
|
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
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. |
|
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
This template is used on a very large number of pages. To avoid large-scale disruption and unnecessary server load, any changes to it should first be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can then be added to this page in a single edit. Please consider discussing changes on the talk page before implementing them. |
 |
This template uses material from the Wikipedia template Template:Str ≥ len/doc, which is released under the Creative Commons Attribution-ShareAlike 3.0 Unported License (view authors). | Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
This is the {{str ≥ len}} meta-template.
It helps other templates check if a string is "longer or equally long" vs. "shorter" than a given length.
Contents
Usage
This template takes 3 to 4 unnamed parameters.
Here is how to check if the string "abcde" is 4 characters or more:
{{str ≥ len | abcde | 4
| Equal or longer.
| Shorter.
}}
Which returns this:
- Equal or longer.
Templates have a problem to handle parameter data that contains equal signs "=". But that is easily solved by using numbered parameters. Here we check if the string "ab=cde" is 100 characters or more:
{{str ≥ len
| 1 = ab=cde
| 2 = 100
| 3 = Equal "=" or longer.
| 4 = Shorter, not "=".
}}
Which returns this:
- Shorter, not "=".
It probably is a good habit to always use the numbered parameters, since you might not know beforehand exactly how the data will look that your template will feed to this meta-template.
Parameters
Detailed parameter explanation:
{{str ≥ len
| 1 = A string, 0-500 characters long.
| 2 = 0 - 500
| 3 = Data to return/render when "longer than or equally long".
| 4 = Data to return/render when "shorter than".
}}
Empty or undefined strings are considered to be of 0 length. Strings longer than 500 are not truncated to 500.
Length values below 0 are considered to be 0. Length values above 500 are considered to be 500.
Thus a string of 500 length or more are always considered to be "longer than or equally long", no matter what length value it is compared with.
Technical details
The potential alternative templates names {{str >= len}} or (for the opposite) {{str < len}} do not work in MediaWiki.
Even though this is a string handling template it uses very efficient code. (While some of the other string handling templates are probably so heavy on the servers that we perhaps should not use them.)
Templates have problems to handle parameter data that contains pipes "|", unless the pipe is inside another template {{name|param1}} or inside a piped link [[Help:Template|help]]. Thus templates can not handle wikitables as input unless you escape them by using the {{!}} template. This makes it hard to use wikitables as parameters to templates. Instead the usual solution is to use "HTML wikimarkup" for the table code, which is more robust.
See also
Description of all string templates
