Template:Str rightc/doc

From Wikibooks, open books for an open world
Jump to navigation Jump to search

Usage[edit source]

{{Str rightc|<string>|<count>}}
{{Str rightc|<string>|<count>|<result if empty>}}

Gives a substring of length <count> of characters from the right-side end of the string. If the parameter 1 <string> is empty, then immediately returns with parameter 3 (or nothing), and skips all the complex processing usually needed to extract a substring.

If <count> is invalid, empty or undefined, this template goes berserk, so don't do that.

Limitations[edit source]

  • Up to 100 characters in the input string. If possible, first check length of input string using {{Str len}}. Using strings longer than 100 characters may result in the error "max index is 100 for str sub long".
  • Limited set of characters.
  • Expensive (if used too many times per page, generates "Wikimedia Foundation Server Error").
  • Returning parameter 3, when parameter 1 is empty, was added 8 May 2010.

Examples[edit source]

  • {{Str rightc| lorem ipsum dolor sit amet | 10 }} → r sit amet
  • {{Str rightc| lorem ipsum dolor sit amet | 1 }} → t
  • {{Str rightc| lorem ipsum dolor sit amet | 0 }}
  • {{Str rightc| | 1 | empty }} → empty
  • {{Str rightc |123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.1 | 99}} → 3456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.123456789.max index is 100 for str sub long

See also[edit source]

Trimming templates:

  • {{Str left}} – To trim down to a specified number of characters, or duplicate the string to a specified number.
  • {{Str trim}} — To trim any leading or trailing whitespace.
  • {{Str right}} — To trim the first specified number of characters.
  • {{Str rightc}} — To trim the first specified number of characters, returns a parameter if the string is empty.
  • {{Str sub}} — To trim down to a specified number, starting at a given number from the left, less than 50.
  • {{Str sub long}} — To trim down to a specified number, starting at a given number from the left, less than 100.

Analyzing templates:

  • {{Str find}} – Returns the numerical location of a given string in a string, up to 50 characters.
  • {{Str index}} – Returns a given character from a string, but not accented letters.
  • {{Str index any}} – Returns a given character from a string, but not a space.
  • {{Str len}} – Returns a string's length. Can count up to 500 characters.

String length comparison templates:

  • {{Str ≥ len}} – To check if a string is "longer or equally long" or "shorter" than a given length.
  • {{Str ≤ len}} – To check if a string is "shorter or equally long" or "longer" than a given length.
  • {{Str ≠ len}} – To check if a string is "not equal" or "equal" to a given length.
  • {{Str ≤ ≥ len}} – To check if a string is "shorter", "equal", or "longer" than a given length.