Limnoria/plugins/News
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
..
locales Fix msgfmt warnings. 2020-03-26 22:10:28 +01: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
README.rst all plugins: regenerate READMEs 2021-04-22 00:29:15 +02:00
test.py all: Add generic 'The Limnoria Contributors' to copyright notices. 2021-08-01 21:54:49 +02:00

Documentation for the News plugin for Supybot

Purpose

A module to allow each channel to have "news". News items may have expiration dates. It was partially inspired by the news system used on #debian's bot.

Usage

This plugin provides a means of maintaining News for a channel.

Commands

add [<channel>] <expires> <subject>: <text>

Adds a given news item of <text> to a channel with the given <subject>. If <expires> isn't 0, that news item will expire <expires> seconds from now. <channel> is only necessary if the message isn't sent in the channel itself.

change [<channel>] <id> <regexp>

Changes the news item with <id> from <channel> according to the regular expression <regexp>. <regexp> should be of the form s/text/replacement/flags. <channel> is only necessary if the message isn't sent on the channel itself.

news [<channel>] [<id>]

Display the news items for <channel> in the format of '(#id) subject'. If <id> is given, retrieve only that news item; otherwise retrieve all news items. <channel> is only necessary if the message isn't sent in the channel itself.

old [<channel>] [<id>]

Returns the old news item for <channel> with <id>. If no number is given, returns all the old news items in reverse order. <channel> is only necessary if the message isn't sent in the channel itself.

remove [<channel>] <id>

Removes the news item with <id> from <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

Configuration

supybot.plugins.News.public

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

Determines whether this plugin is publicly visible.