Difference between revisions of "Template:Str right/doc"
From Ava Zinn Wiki
| [unchecked revision] | [unchecked revision] |
(sl:Predloga:Str right) |
Aeverinezinn (talk | contribs) m (51 revisions) |
||
| (14 intermediate revisions by 11 users not shown) | |||
| 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 == | |
| − | : | + | : {{tlx|str right|<string>|<offset>}} |
Gives the characters from <offset> to the end of the string. | Gives the characters from <offset> to the end of the string. | ||
| Line 12: | 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=== |
| − | * | + | * <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}} | |
| − | + | <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 == | |
| − | {{String templates | + | * {{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]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | [[ | ||
</includeonly> | </includeonly> | ||
Latest revision as of 08:34, 5 December 2016
 |
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. |
|
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. |
Contents
Usage[edit]
-
{{str right|<string>|<offset>}}
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[edit]
-
{{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[edit]
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[edit]
- {{str rightc}}
- {{str rightmost}}
- {{str left}}
| |||||||||||||||||||||||||||||||||||||
