Template:Str right/doc

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 is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:String

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 please avoid.

Examples

{{str right |Lorem ipsum dolor sit amet |10}} → m dolor sit amet
{{str right |Lorem ipsum dolor sit amet |1}} → orem ipsum dolor sit amet
{{str right |Lorem ipsum dolor sit amet |0}} → Lorem ipsum dolor sit amet
{{str right |123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.1 |99}} → .1

{{str right |#123456|1}} → 123456
{{str right |#123|1}} → 123

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Str right

Gives the characters from <offset> to the end of the string.

Template parameters
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

{{#invoke:string\|sub}} {{str sub new}}	Select a substring based on starting and ending index counted in either direction.
{{str left}}	Keep the first N characters of a string, or duplicate it to N characters.
{{str crop}}	Return all but the last N characters of a string.
{{str index}}	Return the N-th character of a string.

{{str right}}	Return substring starting at N-th character to end of string.
{{str rightc}}	Return the last N characters of a string; or a given value if empty.
{{str sub old}}	Return substring of given length starting at N-th character.

Trimming (select/remove chunk of string by character type)

{{trim}}	Trim any leading or trailing whitespace
{{str letter/trim}}	Trim down to the beginning letters.
{{str number/trim}}	Trim down to the beginning numbers.
{{trim brackets}}	Trim any leading or trailing square brackets.
{{trim quotes}}	Trim leading or trailing matching quotes.
{{trim leading}}	Trim up to six instances of specified <prefix>.

{{string split}}	Extract a short string from a long string.
{{first word}}	Trim down to the first space.
{{remove first word}}	Remove anything before the first space.
{{last word}}	Trim down from the last space.
{{remove last word}}	Remove anything after the last space.

Select/remove specific item from string

{{delink}}, {{trim brackets}}	Removes wikilink brackets (wikicode); all or outer only.
{{remove file prefix}}	Removes "File:" (or "Image:") from filenames.
{{PAGENAMEBASE}}	Trim off any parenthesis text at the end of a string (disambiguation).
{{title disambig text}}	Returns text in parentheses at the end of a string (disambiguation).
{{WikiProjectbasename}}	Removes "WikiProject" from a pagename.

{{ship prefix}}	Returns the length of a ship's name prefix, if listed (ship names).
{{title year}}	Returns the 3-or-4-digit year from a pagename, if any.
{{title decade}}	Returns the 4-digit decade (e.g. "1740s") from a pagename, if any.
{{title number}}	Returns any number from a pagename.

Insertion, replacement and length

{{loop}}	Repeat character string a specified number of times.
{{replace}}	Returns the string, after replacing all occurrences of a specified string with another string.
{{str rep}}	Returns the string, after replacing the first occurrence of a specified string with another string.
{{digits}}	Returns the string, after removing all characters that are not digits 0–9
{{Plain text}}, {{Nowiki}}	Strips wikicode from a string.

{{str len}}	Returns a string's length.
{{str ≥ len}}	Check if a string is "longer or equally long" or "shorter" than a given length.
{{str ≤ len}}	Check if a string is "shorter or equally long" or "longer" than a given length.
{{str ≠ len}}	Check if a string is "not equal" or "equal" to a given length.

Analysis and searching

{{#invoke:string2\|startswith}} {{str endswith}}	Check if a string starts or ends with a given string.
{{str find}}, {{strfind short}}	Returns the numerical location of a given string in a string.
{{in string}}	Returns optional string when given string is not found
{{str count}}	Count the number of occurrences of a pattern within a string.

{{a or an}}	Takes a noun and produces the appropriate indefinite article, based on whether the first letter is a vowel.
{{Isnumeric}}	Returns number when true, blank when not numeric.
{{str letter}}	Returns the number of letters that begin a string.
{{str number}}	Returns the number of numbers that begin a string.

Modules and built-in functions
Module:String, Module:String2, Module:Ustring, Module:Text: modules that together contain most necessary string functions. Magic words: About `{{padleft:\|}}`, `{{lc:\|}}`, `{{formatnum:\|}}` etc. ParserFunctions: About `{{#titleparts:\|}}, {{#expr:\|}}, {{#ifeq:\|}},` etc.

Category:String manipulation templates

Category:String manipulating modules

Template:Str right/doc

Contents

Usage

Examples

TemplateData

See also

Navigation menu

Template:Str right/doc

Usage

Examples

TemplateData

See also

Navigation menu

Search