mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-05 02:29:22 +01:00

Valentin Lorentz 833af36b08 all plugins: auto-generate READMEs

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.

2021-04-05 17:42:31 +02:00

1.8 KiB

Raw Blame History

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 '*'.

1.8 KiB Raw Blame History