Limnoria/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Limnoria/Limnoria-doc.git synced 2025-04-07 07:49:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Review and update the layout.

Browse Source
This commit is contained in:
Valentin Lorentz
2011-06-28 17:29:38 +02:00
parent 2ce465adcd
commit b17bd0fac6
63 changed files with 2384 additions and 2323 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
use/plugins/news.rst
View File

@ -4,62 +4,56 @@
The News plugin
===============
.. _command-old:
Read news
---------
old [<channel>] [<id>]
^^^^^^^^^^^^^^^^^^^^^^
.. _command-news-old:
news 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.
.. _command-news-news:
.. _command-die:
die
^^^^
.. _command-remove:
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.
.. _command-add:
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.
.. _command-news:
news [<channel>] [<id>]
^^^^^^^^^^^^^^^^^^^^^^^
news 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.
Administration
--------------
.. _command-change:
.. _command-news-remove:
change [<channel>] <id> <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
news 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.
.. _command-news-add:
news 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.
.. _command-news-change:
news 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.