Limnoria/plugins/Format/README.rst

115 lines
2.9 KiB
ReStructuredText

.. _plugin-Format:
Documentation for the Format plugin for Supybot
===============================================
Purpose
-------
Provides simple commands for formatting text on IRC (like bold),
and to change the output of the bot for a particular command.
See also the :ref:`Filter plugin <plugin-Filter>` to configure
the output format for all commands.
Usage
-----
Provides some commands for formatting text, such as making text bold or
capitalized.
.. _commands-Format:
Commands
--------
.. _command-format-bold:
bold <text>
Returns <text> bolded.
.. _command-format-capitalize:
capitalize <text>
Returns <text> capitalized.
.. _command-format-color:
color <foreground> [<background>] <text>
Returns <text> with foreground color <foreground> and background color <background> (if given)
.. _command-format-concat:
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.
.. _command-format-cut:
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>.
.. _command-format-field:
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.
.. _command-format-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.
.. _command-format-join:
join <separator> <string 1> [<string> ...]
Joins all the arguments together with <separator>.
.. _command-format-lower:
lower <text>
Returns <text> lowercased.
.. _command-format-replace:
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>.
.. _command-format-repr:
repr <text>
Returns <text> surrounded by double quotes.
.. _command-format-reverse:
reverse <text>
Returns <text> in reverse-video.
.. _command-format-title:
title <text>
Returns <text> titlecased.
.. _command-format-translate:
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.
.. _command-format-underline:
underline <text>
Returns <text> underlined.
.. _command-format-upper:
upper <text>
Returns <text> uppercased.
.. _conf-Format:
Configuration
-------------
.. _conf-supybot.plugins.Format.public:
supybot.plugins.Format.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.