Difference between revisions of "Template:Str right/doc"
From Ava Zinn Wiki
[unchecked revision] | [unchecked revision] |
(rm redundant <includeonly> tag pair) |
(some formatting (including <tt> replacement), See-also links, template name and parameter) |
||
Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
− | {{ | + | {{Lua|Module:String}} |
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | ||
− | + | == Usage == | |
− | : <code>{{ | + | : <code>{{tlx|str right|<string>|<offset>}}</code> |
Gives the characters from <offset> to the end of the string. | Gives the characters from <offset> to the end of the string. | ||
Line 13: | Line 13: | ||
If <offset> is longer than <string> then this returns an empty 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 | + | If <offset> is invalid, empty or undefined, this template goes berserk, so please avoid. |
− | === Examples === | + | ===Examples=== |
+ | * <code><nowiki>{{str right |Lorem ipsum dolor sit amet |10}}</nowiki></code> → {{str right |Lorem ipsum dolor sit amet |10}} | ||
+ | * <code><nowiki>{{str right |Lorem ipsum dolor sit amet |1}}</nowiki></code> → {{str right |Lorem ipsum dolor sit amet |1}} | ||
+ | * <code><nowiki>{{str right |Lorem ipsum dolor sit amet |0}}</nowiki></code> → {{str right |Lorem ipsum dolor sit amet |0}} | ||
+ | * <code><nowiki>{{str right |123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.1 |99}}</nowiki></code> → {{str right |nocategory=true |123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.1 |99}} | ||
− | + | == TemplateData == | |
− | |||
− | |||
− | |||
− | |||
{{TemplateDataHeader}} | {{TemplateDataHeader}} | ||
<templatedata> | <templatedata> | ||
Line 44: | Line 44: | ||
</templatedata> | </templatedata> | ||
− | + | == See also == | |
− | {{ | + | * {{tl|str rightc}} |
+ | * {{tl|str rightmost}} | ||
+ | * {{tl|str left}} | ||
+ | |||
+ | {{String-handling templates |trim}} | ||
<includeonly> | <includeonly> | ||
− | <!-- CATEGORIES | + | <!----CATEGORIES BELOW THIS LINE, PLEASE:----> |
[[Category:String manipulation templates]] | [[Category:String manipulation templates]] | ||
[[bn:টেমপ্লেট:Str right]] | [[bn:টেমপ্লেট:Str right]] | ||
</includeonly> | </includeonly> |
Revision as of 06:02, 15 July 2014
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 please avoid.
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
- {{str rightc}}
- {{str rightmost}}
- {{str left}}
|