History

Valentin Lorentz db7ef3f025 all: Add generic 'The Limnoria Contributors' to copyright notices. No need to bother with details (that are all outdated / out of sync anyway), just look up the git history.		2021-08-01 21:54:49 +02:00
..
local	dictclient: remove overly complex dequote method	2017-09-29 16:20:13 -07:00
locales	Fix msgfmt warnings.	2020-03-26 22:10:28 +01:00
README.rst	all plugins: regenerate READMEs	2021-04-22 00:29:15 +02:00
__init__.py	all: Add generic 'The Limnoria Contributors' to copyright notices.	2021-08-01 21:54:49 +02:00
config.py	all: Add generic 'The Limnoria Contributors' to copyright notices.	2021-08-01 21:54:49 +02:00
messages.pot	Squashed commit of the following:	2014-12-20 14:37:27 +01:00
plugin.py	all: Add generic 'The Limnoria Contributors' to copyright notices.	2021-08-01 21:54:49 +02:00
test.py	all: Add generic 'The Limnoria Contributors' to copyright notices.	2021-08-01 21:54:49 +02:00

README.rst

Documentation for the Dict plugin for Supybot

Purpose

Commands that use the dictd protocol to define words.

In order to use this plugin you must have the following modules installed:

dictclient: http://quux.org:70/devel/dictclient

Usage

This plugin provides a function to look up words from different dictionaries.

Commands

dict [<dictionary>] <word>: Looks up the definition of <word> on the dictd server specified by the supybot.plugins.Dict.server config variable.

dictionaries takes no arguments: Returns the dictionaries valid for the dict command.

random takes no arguments: Returns a random valid dictionary.

synonym <word> [<word> ...]: Gets a random synonym from the Moby Thesaurus (moby-thesaurus) database. If given many words, gets a random synonym for each of them. Quote phrases to have them treated as one lookup word.

Configuration

supybot.plugins.Dict.default

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

Determines the default dictionary the bot will ask for definitions in. If this value is '*' (without the quotes) the bot will use all dictionaries to define words.

supybot.plugins.Dict.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.Dict.server

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

Determines what server the bot will retrieve definitions from.

supybot.plugins.Dict.showDictName

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

Determines whether the bot will show which dictionaries responded to a query, if the selected dictionary is '*'.