summaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2013-04-12 23:34:11 +0200
committermathieui <mathieui@mathieui.net>2013-04-12 23:34:11 +0200
commite6cb43eeedcd6c6961c5ab430f25bb962d40bf8e (patch)
tree10d14250b3ccbc64b75de22ee76b76811cd1f2de /plugins
parente341d1534ef97d6465e960e99fcbd4adf412cc8e (diff)
downloadpoezio-e6cb43eeedcd6c6961c5ab430f25bb962d40bf8e.tar.gz
poezio-e6cb43eeedcd6c6961c5ab430f25bb962d40bf8e.tar.bz2
poezio-e6cb43eeedcd6c6961c5ab430f25bb962d40bf8e.tar.xz
poezio-e6cb43eeedcd6c6961c5ab430f25bb962d40bf8e.zip
Start the plugin documentation
(with admin.py)
Diffstat (limited to 'plugins')
-rw-r--r--plugins/admin.py60
1 files changed, 60 insertions, 0 deletions
diff --git a/plugins/admin.py b/plugins/admin.py
index fac34fdb..638a31a6 100644
--- a/plugins/admin.py
+++ b/plugins/admin.py
@@ -1,3 +1,63 @@
+"""
+This plugin adds several convenient aliases, to shorten
+roles/affiliation management.
+
+Installation
+------------
+
+You only have to load the plugin:
+
+``/load admin``
+
+Aliases defined
+---------------
+
+All those commands take a nick or a JID as a parameter.
+
+For roles
+~~~~~~~~~
+
+.. glossary::
+ :sorted:
+
+ /visitor
+ /mute
+ Set the role to ``visitor``
+
+ /participant
+ Set the role to ``participant``
+
+ /moderator
+ /op
+ Set the role to ``moderator``
+
+
+For affiliations
+~~~~~~~~~~~~~~~~
+
+.. glossary::
+ :sorted:
+
+ /admin
+ Set the affiliation to ``admin``
+
+ /member
+ /voice
+ Set the affiliation to ``member``
+
+ /noaffiliation
+ Set the affiliation to ``none``
+
+ /owner
+ Set the affiliation to ``owner``
+
+
+
+
+
+"""
+
+
from plugin import BasePlugin
from tabs import MucTab