poezio/plugins/status.py
mathieui d676c2ee7b Move the plugins documentation
(use automodule directive & docstrings)
2013-04-13 22:33:06 +02:00

48 lines
987 B
Python

"""
This plugin adds several aliases, to shorten status changes.
Installation
------------
You only have to load the plugin.
.. code-block:: none
/load status
Aliases
-------
.. glossary::
:sorted:
/afk
/away
Set your status to ``away``
/dnd
/busy
Set your status to ``dnd``
/available
Set your status to ``available``
/chat
Set your status to ``chat``
/xa
Set your status to ``xa``
"""
from plugin import BasePlugin
class Plugin(BasePlugin):
"""
Adds several convenient aliases to /status command
"""
def init(self):
for st in ('dnd', 'busy', 'afk', 'chat', 'xa', 'away', 'available'):
self.api.add_command(st,
lambda line,st=st: self.api.run_command('/status ' + st + ' "'+line+'"'),
usage='[status message]',
short='Set your status as %s' % st,
help='Set your status as %s' % st)