Template:Str right/doc

{{#invoke:Message box|mbox}} {{#invoke:Lua banner|main}}

Usage

{{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 don't do that.

Examples

• {{Str right| lorem ipsum dolor sit amet | 10 }} →
• {{Str right| lorem ipsum dolor sit amet | 1 }} →
• {{Str right| lorem ipsum dolor sit amet | 0 }} →
• {{Str right |123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.1 | 99}} →

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Str right

<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  to trim the right n characters. If its greater than the string length returns the empty string.",
                       "type": "number",
                       "required": true
               }
       }

} </templatedata>

See also

{{#invoke:Navbox|navbox}}