Best Practices Wiki

Template:Str gtr str/doc

Template Discussion
< Template:Str gtr str
Revision as of 11:57, 21 March 2013 by Unknown user (talk)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Template:Mbox

Compares two strings for alphabetical order, and returns a value accordingly

Usage

{{Str gtr str|first string|second string|value if true|value if false}}

Examples

  • {{Str gtr str|zebra|aardvark|zebra comes after aardvark|aardvark comes after zebra}} returns zebra comes after aardvark
  • {{Str gtr str|cat|dog|cat comes after dog|dog comes after cat}} returns dog comes after cat
  • {{Str gtr str|same text|same text|true|false}} returns false

Note that the strings are case dependant, and sorted in order of ASCII characters, so {{Str gtr str|Romeo|juliet|true|false}} returns false

Limitations

Only the first four characters of the strings are analysed, so that (for example) {{Str gtr str|Wikipedia|Wikicommons|true|false}} returns false. ASCII characters outside the range 32-126 are treated as a space.

See also

Trimming templates:

  • {{Trunc}} – To trim down to a specified number of characters.
  • {{Str left}} – To trim down to a specified number of characters, or duplicate the string to a specified number.
  • {{Str crop}} – To crop a specified number of characters off the end.
  • {{Chop head and tail}} — To crop a specified number of characters off the beginning and end.
  • {{Trim}} — To trim any leading or trailing whitespace.
  • {{First word}} — To trim down to the first space.
  • {{Remove first word}} — To remove anything before the first space.
  • {{Str letter/trim}} — To trim down to the beginning letters.
  • {{Str number/trim}} — To trim down to the beginning numbers.
  • {{Title without disambig}} — To trim off any parenthesis text at the end of a string.
  • {{Title disambig text}} – Returns text in parenthesis at the end of a string.
  • {{Str right}} — To trim the first specified number of characters.
  • {{Str rightc}} — To return a number of characters from the end, returns a parameter if the string is empty.
  • {{Str rightmost}} — To trim down to the last specified number of characters.
  • {{Str sub}} — To trim down to a specified number, starting at a given number from the left, less than 50.
  • {{Substr any}} — To trim down to a specified number, starting at a given number from the left, less than 50, can extract accented letters.
  • {{Str sub long}} — To trim down to a specified number, starting at a given number from the left, less than 100.
  • {{trim}} — Removes whitespace ({{Strip whitespace}} does so too, but is less effective)

Inserting strings:

  • {{Strloc insert}} - Inserts a string at character location strloc, or appends if strloc<=0.
  • {{Strloc prefix}} - Extracts string prefix up to location strloc, or whole string if strloc<=0.
  • {{Str rep}} — Returns the string, replacing the first occurrence of a specified string, with another string. Requires a match.
  • {{Str repc}} — Returns the string, replacing the first occurrence of a specified string, with another string, if there is one.
  • {{Repeat}} — Repeat character string n times

Analyzing strings:

  • {{Str endswith}} – To check if a string ends with a given string.
  • {{Str find}} – Returns the numerical location of a given string in a string, up to 50 characters.
  • {{Str find long}} – Returns the numerical location of a given string in a string, up to 80 characters.
  • {{Strfind short}} – Searches for a short string in a longer (up to 99 char) string. Performs faster than {{str find}}
  • {{Str find0}} – Very fast zero-based substring search with string support up to 90 characters.
  • {{Str sub find}} – Searches a substring in a string at the given offset.
  • {{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.
  • {{Chr}} – Returns a given character from a string, including a space.
  • {{Str len}} – Returns a string's length. Can count up to 500 characters.
  • {{Strlen quick}} – Gets string length quickly (better performance), up to 70 long.
  • {{Strlen short}} – Gets length of short strings (1-50), using only 2 expansion levels.
  • {{Str letter}} — Returns the number of letters that begin a string.
  • {{Str number}} — Returns the number of numbers that begin a string.
  • {{Ship prefix}} — Returns the length of a ship name prefix, if listed.

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.

Sandboxes and test cases:

Technical stuff:

Feature requests:

  • bugzilla:6455 - Set $wgPFEnableStringFunctions = true on WMF wikis
  • bugzilla:26092 - Enable or install string parsing wikimarkup functionality on WMF wikis

Future:

bs:Šablon:Niz šabloni


Retrieved from "http://www.bestpracticeswiki.net/index.php?title=Template:Str_gtr_str/doc&oldid=853"