3.2 KiB
The Format plugin
Capitals
format upper <text>
Returns <text> uppercased.
format capitalize <text>
Returns <text> capitalized.
format lower <text>
Returns <text> lowercased.
format title <text>
Returns <text> titlecased.
Text modifications
format format <format string> [<arg> ...]
Expands a Python-style format string using the remaining args. Just be sure always to use %s, not %d or %f or whatever, because all the args are strings.
format color <foreground> [<background>] <text>
Returns <text> with foreground color <foreground> and background color <background> (if given)
format repr <text>
Returns the text surrounded by double quotes.
format replace <substring to translate> <substring to replace it with> <text>
Replaces all non-overlapping occurrences of <substring to translate> with <substring to replace it with> in <text>.
format field <number> <text>
Returns the <number>th space-separated field of <text>. I.e., if text is "foo bar baz" and <number> is 2, "bar" is returned.
format concat <string 1> <string 2>
Concatenates two strings. Do keep in mind that this is not the same thing as join "", since if <string 2> contains spaces, they won't be removed by concat.
format translate <chars to translate> <chars to replace those with> <text>
Replaces <chars to translate> with <chars to replace those with> in <text>. The first and second arguments must necessarily be the same length.
format cut <size> <text>
Cuts <text> down to <size> by chopping off the rightmost characters in excess of <size>. If <size> is a negative number, it chops that many characters off the end of <text>.
format join <separator> <string 1> [<string> ...]
Joins all the arguments together with <separator>.
format reverse <text>
Returns <text> in reverse-video.
Text properties
format bold <text>
Returns <text> bolded.
format underline <text>
Returns <text> underlined.
Configuration
supybot.plugins.Format.public
Default value: True
Determines whether this plugin is publicly visible.