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 Factoids plugin for Supybot
Purpose
Handles 'factoids,' little tidbits of information held in a database and available on demand via several commands.
Usage
Provides the ability to show Factoids.
Commands
- alias [<channel>] <oldkey> <newkey> [<number>]
-
Adds a new key <newkey> for factoid associated with <oldkey>. <number> is only necessary if there's more than one factoid associated with <oldkey>. The same action can be accomplished by using the 'learn' function with a new key but an existing (verbatim) factoid content.
- change [<channel>] <key> <number> <regexp>
-
Changes the factoid #<number> associated with <key> according to <regexp>.
forget [<channel>] <key> [<number>|] Removes a key-fact relationship for key <key> from the factoids database. If there is more than one such relationship for this key, a number is necessary to determine which one should be removed. A can be used to remove all relationships for <key>. If as a result, the key (factoid) remains without any relationships to a factoid (key), it shall be removed from the database. <channel> is only necessary if the message isn't sent in the channel itself.
- info [<channel>] <key>
-
Gives information about the factoid(s) associated with <key>. <channel> is only necessary if the message isn't sent in the channel itself.
- learn [<channel>] <key> is <value>
-
Associates <key> with <value>. <channel> is only necessary if the message isn't sent on the channel itself. The word 'is' is necessary to separate the key from the value. It can be changed to another word via the learnSeparator registry value.
- lock [<channel>] <key>
-
Locks the factoid(s) associated with <key> so that they cannot be removed or added to. <channel> is only necessary if the message isn't sent in the channel itself.
- random [<channel>]
-
Returns random factoids from the database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
- rank [<channel>] [--plain] [--alpha] [<number>]
-
Returns a list of top-ranked factoid keys, sorted by usage count (rank). If <number> is not provided, the default number of factoid keys returned is set by the rankListLength registry value. If --plain option is given, rank numbers and usage counts are not included in output. If --alpha option is given in addition to --plain, keys are sorted alphabetically, instead of by rank. <channel> is only necessary if the message isn't sent in the channel itself.
- search [<channel>] [--values] [--regexp <value>] [--author <username>] [<glob> ...]
-
Searches the keyspace for keys matching <glob>. If --regexp is given, its associated value is taken as a regexp and matched against the keys. If --values is given, search the value space instead of the keyspace.
- unlock [<channel>] <key>
-
Unlocks the factoid(s) associated with <key> so that they can be removed or added to. <channel> is only necessary if the message isn't sent in the channel itself.
- whatis [<channel>] [--raw] <key> [<number>]
-
Looks up the value of <key> in the factoid database. If given a number, will return only that exact factoid. If '--raw' option is given, no variable substitution will take place on the factoid. <channel> is only necessary if the message isn't sent in the channel itself.
Configuration
- supybot.plugins.Factoids.format
-
This config variable defaults to "$value", is network-specific, and is channel-specific.
Determines the format of the response given when a factoid's value is requested. All the standard substitutes apply, in addition to "$key" for the factoid's key and "$value" for the factoid's value.
- supybot.plugins.Factoids.keepRankInfo
-
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether we keep updating the usage count for each factoid, for popularity ranking.
- supybot.plugins.Factoids.learnSeparator
-
This config variable defaults to "is", is network-specific, and is channel-specific.
Determines what separator must be used in the learn command. Defaults to 'is' -- learn <key> is <value>. Users might want to change this to something else, so it's configurable.
- supybot.plugins.Factoids.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.Factoids.rankListLength
-
This config variable defaults to "20", is network-specific, and is channel-specific.
Determines the number of factoid keys returned by the factrank command.
- supybot.plugins.Factoids.replyApproximateSearchKeys
-
This config variable defaults to "True", is network-specific, and is channel-specific.
If you try to look up a nonexistent factoid, this setting make the bot try to find some possible matching keys through several approximate matching algorithms and return a list of matching keys, before giving up.
- supybot.plugins.Factoids.replyWhenInvalidCommand
-
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the bot will reply to invalid commands by searching for a factoid; basically making the whatis unnecessary when you want all factoids for a given key.
- supybot.plugins.Factoids.requireVoice
-
This config variable defaults to "False", is network-specific, and is channel-specific.
Only allows a user with voice or above on a channel to use the 'learn' and 'forget' commands.
- supybot.plugins.Factoids.showFactoidIfOnlyOneMatch
-
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the bot will reply with the single matching factoid if only one factoid matches when using the search command.