Difference between revisions of "Template:Str right/doc"
From Ava Zinn Wiki
[unchecked revision] | [unchecked revision] |
(remove the category from the {{lua}} template - this is done automatically now) |
(add templatedate) |
||
Line 21: | Line 21: | ||
*<tt><nowiki>{{Str right| lorem ipsum dolor sit amet | 0 }}</nowiki></tt> → {{Str right| lorem ipsum dolor sit amet | 0 }} | *<tt><nowiki>{{Str right| lorem ipsum dolor sit amet | 0 }}</nowiki></tt> → {{Str right| lorem ipsum dolor sit amet | 0 }} | ||
*<tt><nowiki>{{Str right |123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.1 | 99}}</nowiki></tt> → {{Str right |nocategory=true |123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.1 | 99}} | *<tt><nowiki>{{Str right |123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.1 | 99}}</nowiki></tt> → {{Str right |nocategory=true |123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.1 | 99}} | ||
+ | |||
+ | ==TemplateData== | ||
+ | {{TemplateDataHeader}} | ||
+ | <templatedata> | ||
+ | { | ||
+ | "description": "Gives the characters from <offset> to the end of the string.", | ||
+ | "params": { | ||
+ | "1": { | ||
+ | "label": "String", | ||
+ | "description": "The string to be trimmed", | ||
+ | "type": "string", | ||
+ | "required": true | ||
+ | }, | ||
+ | "2": { | ||
+ | "label": "Count", | ||
+ | "description": "The index of the character to trim from. Negative values are treated as 0, see {{str rightc}} to trim the right n characters. If its greater than the string length returns the empty string.", | ||
+ | "type": "number", | ||
+ | "required": true | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | </templatedata> | ||
=== See also === | === See also === |
Revision as of 12:46, 24 July 2013
This is a documentation subpage for Template:Str right. It contains usage information, categories and other content that is not part of the original template page. |
Contents
Usage
-
<code>{{Str right|<string>|<offset>}}
</code>
Gives the characters from <offset> to the end of the string.
A negative <offset> is treated the same as zero, which simply returns the original string.
If <offset> is longer than <string> then this returns an empty string.
If <offset> is invalid, empty or undefined, this template goes berserk, so don't do that.
Examples
- {{Str right| lorem ipsum dolor sit amet | 10 }} → Expression error: Unrecognized punctuation character "{".
- {{Str right| lorem ipsum dolor sit amet | 1 }} → Expression error: Unrecognized punctuation character "{".
- {{Str right| lorem ipsum dolor sit amet | 0 }} → Expression error: Unrecognized punctuation character "{".
- {{Str right |123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.1 | 99}} → Expression error: Unrecognized punctuation character "{".
TemplateData
This is the TemplateData documentation for this template used by VisualEditor and other tools.
Str right
Gives the characters from <offset> to the end of the string.
Parameter | Description | Type | Status | |
---|---|---|---|---|
String | 1 | The string to be trimmed
| String | required |
Count | 2 | The index of the character to trim from. Negative values are treated as 0, see {{str rightc}} to trim the right n characters. If its greater than the string length returns the empty string.
| Number | required |
See also
Template:Navbox string handling templates