Limnoria/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Limnoria/Limnoria-doc.git synced 2025-04-07 15:59:50 +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

114
use/plugins/messageparser.rst
View File

@ -4,52 +4,52 @@
The MessageParser plugin
========================
.. _command-show:
Administration
--------------
show [<channel>] [--id] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _command-messageparser-remove:
Looks up the value of *<regexp>* in the triggers database.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
messageparser remove [<channel>] [--id] <regexp>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes the trigger for *<regexp>* from the triggers database.
*<channel>* is only necessary if
the message isn't sent in the channel itself.
If option *--id* specified, will retrieve by regexp id, not content.
.. _command-messageparser-add:
.. _command-lock:
messageparser add [<channel>] <regexp> <action>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lock [<channel>] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^
Associates *<regexp>* with *<action>*. *<channel>* is only
necessary if the message isn't sent on the channel
itself. Action is echoed upon regexp match, with variables $1, $2,
etc. being interpolated from the regexp match groups.
.. _command-messageparser-lock:
messageparser lock [<channel>] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Locks the *<regexp>* so that it cannot be
removed or overwritten to. *<channel>* is only necessary if the message isn't
sent in the channel itself.
.. _command-messageparser-unlock:
.. _command-rank:
rank [<channel>]
^^^^^^^^^^^^^^^^
Returns a list of top-ranked regexps, sorted by usage count
(rank). The number of regexps returned is set by the
rankListLength registry value. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. _command-unlock:
unlock [<channel>] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^
messageparser unlock [<channel>] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Unlocks the entry associated with *<regexp>* so that it can be
removed or overwritten. *<channel>* is only necessary if the message isn't
sent in the channel itself.
.. _command-messageparser-vacuum:
.. _command-vacuum:
vacuum [<channel>]
^^^^^^^^^^^^^^^^^^
messageparser vacuum [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Vacuums the database for *<channel>*.
See SQLite vacuum doc here: http://www.sqlite.org/lang_vacuum.html
@ -58,46 +58,44 @@ the channel itself.
First check if user has the required capability specified in plugin
config requireVacuumCapability.
User commands
-------------
.. _command-info:
.. _command-messageparser-show:
info [<channel>] [--id] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
messageparser show [<channel>] [--id] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Looks up the value of *<regexp>* in the triggers database.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
If option *--id* specified, will retrieve by regexp id, not content.
.. _command-messageparser-rank:
messageparser rank [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns a list of top-ranked regexps, sorted by usage count
(rank). The number of regexps returned is set by the
rankListLength registry value. *<channel>* is only necessary if the
message isn't sent in the channel itself.
.. _command-messageparser-info:
messageparser info [<channel>] [--id] <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Display information about *<regexp>* in the triggers database.
*<channel>* is only necessary if the message isn't sent in the channel
itself.
If option *--id* specified, will retrieve by regexp id, not content.
.. _command-messageparser-list:
.. _command-list:
list [<channel>]
^^^^^^^^^^^^^^^^
messageparser list [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Lists regexps present in the triggers database.
*<channel>* is only necessary if the message isn't sent in the channel
itself. Regexp ID listed in paretheses.
.. _command-remove:
remove [<channel>] [--id] <regexp>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes the trigger for *<regexp>* from the triggers database.
*<channel>* is only necessary if
the message isn't sent in the channel itself.
If option *--id* specified, will retrieve by regexp id, not content.
.. _command-add:
add [<channel>] <regexp> <action>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Associates *<regexp>* with *<action>*. *<channel>* is only
necessary if the message isn't sent on the channel
itself. Action is echoed upon regexp match, with variables $1, $2,
etc. being interpolated from the regexp match groups.