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 | ||
| __init__.py | ||
| config.py | ||
| messages.pot | ||
| plugin.py | ||
| README.rst | ||
| test.py | ||
Documentation for the Todo plugin for Supybot
Purpose
The Todo plugin allows registered users to keep their own personal list of tasks to do, with an optional priority for each.
Usage
This plugin allows you to create your own personal to-do list on the bot.
Commands
- add [--priority=<num>] <text>
-
Adds <text> as a task in your own personal todo list. The optional priority argument allows you to set a task as a high or low priority. Any integer is valid.
- change <task id> <regexp>
-
Modify the task with the given id using the supplied regexp.
- remove <task id> [<task id> ...]
-
Removes <task id> from your personal todo list.
- search [--{regexp} <value>] [<glob> <glob> ...]
-
Searches your todos for tasks matching <glob>. If --regexp is given, its associated value is taken as a regexp and matched against the tasks.
- setpriority <id> <priority>
-
Sets the priority of the todo with the given id to the specified value.
- todo [<username>] [<task id>]
-
Retrieves a task for the given task id. If no task id is given, it will return a list of task ids that that user has added to their todo list.
Configuration
- supybot.plugins.Todo.allowThirdpartyReader
-
This config variable defaults to "False", is not network-specific, and is not channel-specific.
Determines whether users can read the todo-list of another user.
- supybot.plugins.Todo.public
-
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.