Limnoria/plugins/Note
Valentin Lorentz cd02444f87 supybot-plugin-doc: Add labels for all command and config variables
So they can be referenced from elsewhere in the doc.
2021-04-06 00:33:07 +02:00
..
locales Fix msgfmt warnings. 2020-03-26 22:10:28 +01:00
__init__.py Use importlib instead of imp. 2020-01-26 12:00:08 +01:00
config.py Fix neutral pronouns. 2014-04-11 21:56:42 +00:00
messages.pot Squashed commit of the following: 2014-12-20 14:37:27 +01:00
plugin.py all plugins: Use msg.channel instead of msg.args[0] + give network name to self.registryValue. 2019-08-24 23:35:01 +02:00
README.rst supybot-plugin-doc: Add labels for all command and config variables 2021-04-06 00:33:07 +02:00
test.py Change the modeline to use softtabstop instead of tabstop. 2006-02-11 15:52:51 +00:00

Documentation for the Note plugin for Supybot

Purpose

A complete messaging system that allows users to leave 'notes' for other users that can be retrieved later.

Usage

Allows you to send notes to other users.

Commands

list [--{old,sent}] [--{from,to} <user>]

Retrieves the ids of all your unread notes. If --old is given, list read notes. If --sent is given, list notes that you have sent. If --from is specified, only lists notes sent to you from <user>. If --to is specified, only lists notes sent by you to <user>.

next takes no arguments

Retrieves your next unread note, if any.

note <id>

Retrieves a single note by its unique note id. Use the 'note list' command to see what unread notes you have.

reply <id> <text>

Sends a note in reply to <id>.

send <recipient>,[<recipient>,[...]] <text>

Sends a new note to the user specified. Multiple recipients may be specified by separating their names by commas.

unsend <id>

Unsends the note with the id given. You must be the author of the note, and it must be unread.

Configuration

supybot.plugins.Note.public

This config variable defaults to "True", is not network-specific, and is not channel-specific.

Determines whether this plugin is publicly visible.