From e6cb43eeedcd6c6961c5ab430f25bb962d40bf8e Mon Sep 17 00:00:00 2001
From: mathieui <mathieui@mathieui.net>
Date: Fri, 12 Apr 2013 23:34:11 +0200
Subject: Start the plugin documentation

(with admin.py)
---
 plugins/admin.py | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)

(limited to 'plugins/admin.py')

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
 
-- 
cgit v1.2.3