Limnoria-doc/use/plugins/news.rst

76 lines
1.8 KiB
ReStructuredText
Raw Normal View History

2011-06-28 08:11:32 +02:00
.. _plugin-news:
The News plugin
===============
2011-06-28 17:29:38 +02:00
Read news
---------
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
.. _command-news-old:
news old [<channel>] [<id>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^
2011-06-28 08:11:32 +02:00
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.
2011-06-28 17:29:38 +02:00
.. _command-news-news:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
news news [<channel>] [<id>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
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.
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
Administration
--------------
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
.. _command-news-remove:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
news remove [<channel>] <id>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2011-06-28 08:11:32 +02:00
Removes the news item with *<id>* from *<channel>*. *<channel>* is only
necessary if the message isn't sent in the channel itself.
2011-06-28 17:29:38 +02:00
.. _command-news-add:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
news add [<channel>] <expires> <subject>: <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2011-06-28 08:11:32 +02:00
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.
2011-06-28 17:29:38 +02:00
.. _command-news-change:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
news change [<channel>] <id> <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2011-06-28 08:11:32 +02:00
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.
.. _plugin-news-config:
Configuration
-------------
.. _supybot.plugins.News.public:
supybot.plugins.News.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.