833af36b08
Starting with this commit, there should be no "original" text in READMEs. Instead, the entire text should be in docstrings, and READMEs should be automatically generated from these docstrings. Motivation: * The same help is available both via IRC and in the README (although the README can be more detailed, as only the first paragraph will be shown on IRC) * This will allow auto-generating plugin help on docs.limnoria.net using the same content as the README, as it's sourced from the docstrings Additionally, this converts all READMEs from Markdown to ReST, because the documentation already uses ReST, and other docstrings in the codebase are in ReST for this reason. |
||
|---|---|---|
| .. | ||
| locales | ||
| README.rst | ||
| __init__.py | ||
| config.py | ||
| messages.pot | ||
| plugin.py | ||
| test.py | ||
README.rst
Documentation for the Later plugin for Supybot
Purpose
Informal notes, mostly for compatibility with other bots. Based entirely on nicks, it's an easy way to tell users who refuse to register notes when they arrive later.
Usage
Used to do things later; currently, it only allows the sending of nick-based notes. Do note (haha!) that these notes are not private and don't even pretend to be; if you want such features, consider using the Note plugin.
Use the later tell command to leave a message to a user.
If you sent the message by accident or want to cancel it, you can use
the later undo command to remove the
latest later, which you have sent.
You can also see the people who have notes waiting for them by using
the later notes command. If you specify a
nickname in later notes command, you will see the notes,
which are waiting for the nickname.
Privacy
As you probably noticed from above, this plugin isn't private. Everyone can see notes sent by anyone and the laters are sent on channel by default and as the "plugin help later" says:
Used to do things later; currently, it only allows the sending of nick-based notes. Do note (haha!) that these notes are *not* private and don't even pretend to be; if you want such features, consider using the Note plugin.The Note plugin identifies people by username instead of nickname and allows only users to send notes. The only people who are able to read notes are the sender, receiver, and the owner.
Commands
- notes [<nick>]
-
If <nick> is given, replies with what notes are waiting on <nick>, otherwise, replies with the nicks that have notes waiting for them.
- remove <nick>
-
Removes the notes waiting on <nick>.
- tell <nick1[,nick2[,...]]> <text>
-
Tells each <nickX> <text> the next time <nickX> is seen. <nickX> can contain wildcard characters, and the first matching nick will be given the note.
- undo <nick>
-
Removes the latest note you sent to <nick>.
Configuration
- supybot.plugins.Later.maximum
-
This config variable defaults to "0", is not network-specific, and is not channel-specific.
Determines the maximum number of messages to be queued for a user. If this value is 0, there is no maximum.
- supybot.plugins.Later.messageExpiry
-
This config variable defaults to "30", is not network-specific, and is not channel-specific.
Determines the maximum number of days that a message will remain queued for a user. After this time elapses, the message will be deleted. If this value is 0, there is no maximum.
- supybot.plugins.Later.private
-
This config variable defaults to "False", is not network-specific, and is not channel-specific.
Determines whether users will be notified in the first place in which they're seen, or in private.
- supybot.plugins.Later.public
-
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
- supybot.plugins.Later.tellOnJoin
-
This config variable defaults to "False", is not network-specific, and is not channel-specific.
Determines whether users will be notified upon joining any channel the bot is in, or only upon sending a message.