summaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2014-03-27 23:45:47 +0100
committermathieui <mathieui@mathieui.net>2014-03-27 23:45:47 +0100
commit550aa6efa484d8a3a3872ac947e140a3b009ff5f (patch)
tree3d037e4db40c0addd2c51720a7ddec056d7aaf89 /plugins
parente80ea90e58bc9091729482e67eb24d3a94fecf30 (diff)
downloadpoezio-550aa6efa484d8a3a3872ac947e140a3b009ff5f.tar.gz
poezio-550aa6efa484d8a3a3872ac947e140a3b009ff5f.tar.bz2
poezio-550aa6efa484d8a3a3872ac947e140a3b009ff5f.tar.xz
poezio-550aa6efa484d8a3a3872ac947e140a3b009ff5f.zip
Remove useless "installation" parts from the plugin documentations
Diffstat (limited to 'plugins')
-rw-r--r--plugins/admin.py7
-rw-r--r--plugins/amsg.py8
-rw-r--r--plugins/autocorrect.py7
-rw-r--r--plugins/capslock.py13
-rw-r--r--plugins/day_change.py6
-rw-r--r--plugins/display_corrections.py6
-rw-r--r--plugins/double.py9
-rw-r--r--plugins/exec.py7
-rw-r--r--plugins/figlet.py7
-rw-r--r--plugins/iq_show.py9
-rw-r--r--plugins/mirror.py9
-rw-r--r--plugins/mpd_client.py2
-rw-r--r--plugins/pacokick.py8
-rw-r--r--plugins/ping.py8
-rw-r--r--plugins/pointpoint.py2
-rw-r--r--plugins/quote.py10
-rw-r--r--plugins/rainbow.py9
-rw-r--r--plugins/random_nick.py6
-rw-r--r--plugins/regex_admin.py7
-rw-r--r--plugins/reminder.py8
-rw-r--r--plugins/replace.py9
-rw-r--r--plugins/replace_word.py9
-rw-r--r--plugins/revstr.py14
-rw-r--r--plugins/screen_detach.py8
-rw-r--r--plugins/send_delayed.py20
-rw-r--r--plugins/shuffle.py12
-rw-r--r--plugins/spaces.py12
-rw-r--r--plugins/spam.py17
-rw-r--r--plugins/status.py8
-rw-r--r--plugins/tell.py11
-rw-r--r--plugins/time_marker.py9
-rw-r--r--plugins/uptime.py9
32 files changed, 38 insertions, 248 deletions
diff --git a/plugins/admin.py b/plugins/admin.py
index 638a31a6..c0b3e3da 100644
--- a/plugins/admin.py
+++ b/plugins/admin.py
@@ -2,13 +2,6 @@
This plugin adds several convenient aliases, to shorten
roles/affiliation management.
-Installation
-------------
-
-You only have to load the plugin:
-
-``/load admin``
-
Aliases defined
---------------
diff --git a/plugins/amsg.py b/plugins/amsg.py
index c330373f..01758db0 100644
--- a/plugins/amsg.py
+++ b/plugins/amsg.py
@@ -4,12 +4,6 @@ This plugin broadcasts a message to all your joined rooms.
.. note:: With great power comes great responsability.
Use with moderation.
-Installation
-------------
-You only have to load the plugin.::
-
- /load amsg
-
Command
-------
@@ -18,6 +12,8 @@ Command
/amsg
**Usage:** ``/amsg <message>``
+ Broadcast a message.
+
"""
from plugin import BasePlugin
diff --git a/plugins/autocorrect.py b/plugins/autocorrect.py
index 61795b79..f1a82b2a 100644
--- a/plugins/autocorrect.py
+++ b/plugins/autocorrect.py
@@ -1,13 +1,6 @@
"""
This plugin lets you perform simple replacements on the last message.
-Installation
-------------
-
-Load the plugin::
-
- /load autocorrect
-
Usage
-----
diff --git a/plugins/capslock.py b/plugins/capslock.py
index 57dea345..1b9aafb7 100644
--- a/plugins/capslock.py
+++ b/plugins/capslock.py
@@ -1,16 +1,5 @@
"""
-Shout
-
-Installation
-------------
-
-You only have to load the plugin:
-
-.. code-block:: none
-
- /load capslock
-
-
+Once loaded, everything you will send will be IN CAPITAL LETTERS.
"""
from plugin import BasePlugin
diff --git a/plugins/day_change.py b/plugins/day_change.py
index 91c298f7..cedb4b35 100644
--- a/plugins/day_change.py
+++ b/plugins/day_change.py
@@ -2,12 +2,6 @@
This plugin adds a message at 00:00 in each of your chat tabs saying that the
date has changed.
-Installation
-------------
-You only have to load the plugin.::
-
- /load day_change
-
"""
from gettext import gettext as _
diff --git a/plugins/display_corrections.py b/plugins/display_corrections.py
index c7617b3e..5169cf18 100644
--- a/plugins/display_corrections.py
+++ b/plugins/display_corrections.py
@@ -1,12 +1,6 @@
"""
Lists old versions of a corrected message.
-Installation
-------------
-::
-
- /load display_corrections
-
Usage
-----
diff --git a/plugins/double.py b/plugins/double.py
index 02c7ddcd..7a9efd80 100644
--- a/plugins/double.py
+++ b/plugins/double.py
@@ -1,14 +1,5 @@
"""
Double the first word of any message you send in a :ref:`muctab`, making you appear retarded.
-
-Installation
-------------
-
-You only have to load the plugin:
-
-.. code-block:: none
-
- /load double
"""
from plugin import BasePlugin
diff --git a/plugins/exec.py b/plugins/exec.py
index 10681713..6232fe8c 100644
--- a/plugins/exec.py
+++ b/plugins/exec.py
@@ -1,13 +1,6 @@
"""
This plugin lets you execute a system command through poezio.
-Installation
-------------
-
-You only have to load the plugin. ::
-
- /load exec
-
Usage
-----
diff --git a/plugins/figlet.py b/plugins/figlet.py
index 9006f793..a7e69172 100644
--- a/plugins/figlet.py
+++ b/plugins/figlet.py
@@ -2,13 +2,6 @@
This plugin uses figlet to transform every message into a big ascii-art
message.
-Installation
-------------
-You only have to load the plugin (and have :file:`figlet` installed, of course).
-::
-
- /load figlet
-
Usage
-----
diff --git a/plugins/iq_show.py b/plugins/iq_show.py
index 69bd2722..8f82ca72 100644
--- a/plugins/iq_show.py
+++ b/plugins/iq_show.py
@@ -1,15 +1,6 @@
"""
Show the exchanged IQs (useful for debugging).
-Installation
-------------
-
-Load the plugin:
-
-.. code-block:: none
-
- /load iq_show
-
"""
from plugin import BasePlugin
from sleekxmpp.xmlstream.matcher import StanzaPath
diff --git a/plugins/mirror.py b/plugins/mirror.py
index 16f2014e..e7c475a2 100644
--- a/plugins/mirror.py
+++ b/plugins/mirror.py
@@ -1,15 +1,6 @@
"""
Repeats the last message in the conversation.
-Installation
-------------
-
-You only have to load the plugin:
-
-.. code-block:: none
-
- /load mirror
-
Command
-------
diff --git a/plugins/mpd_client.py b/plugins/mpd_client.py
index 5991422c..2cb0799e 100644
--- a/plugins/mpd_client.py
+++ b/plugins/mpd_client.py
@@ -1,8 +1,6 @@
"""
This plugin is here to send what you are listening to in a chat tab.
-
-
Installation
------------
diff --git a/plugins/pacokick.py b/plugins/pacokick.py
index bd285db8..923e759b 100644
--- a/plugins/pacokick.py
+++ b/plugins/pacokick.py
@@ -1,14 +1,6 @@
"""
This plugin adds a :term:`/pacokick` command, which is a random kick.
-Installation
-------------
-You only have to load the plugin.
-
-.. code-block:: none
-
- /load pacokick
-
Usage
-----
diff --git a/plugins/ping.py b/plugins/ping.py
index 0e436e89..d8c6fc54 100644
--- a/plugins/ping.py
+++ b/plugins/ping.py
@@ -1,14 +1,6 @@
"""
This plugin allows you to ping an entity.
-Installation
-------------
-You only have to load the plugin.
-
-.. code-block:: none
-
- /load ping
-
Command
-------
diff --git a/plugins/pointpoint.py b/plugins/pointpoint.py
index 395cd058..190dc835 100644
--- a/plugins/pointpoint.py
+++ b/plugins/pointpoint.py
@@ -28,6 +28,8 @@ Command
/pointpoint
**Usage:** ``/pointpoint``
+ …
+
"""
diff --git a/plugins/quote.py b/plugins/quote.py
index 829f251e..3236ef4d 100644
--- a/plugins/quote.py
+++ b/plugins/quote.py
@@ -1,16 +1,8 @@
"""
This plugin allows you to quote messages easily.
-Installation
-------------
-You only have to load the plugin.
-
-.. code-block:: none
-
- /load quote
-
Usage
--------
+-----
.. glossary::
diff --git a/plugins/rainbow.py b/plugins/rainbow.py
index 0937eeb7..0ad5b6dd 100644
--- a/plugins/rainbow.py
+++ b/plugins/rainbow.py
@@ -1,15 +1,6 @@
"""
This plugin colors each character of a message with a random color.
-Installation
-------------
-
-You only have to load the plugin.
-
-.. code-block:: none
-
- /load rainbow
-
Usage
-----
diff --git a/plugins/random_nick.py b/plugins/random_nick.py
index 812292e5..a62ef23c 100644
--- a/plugins/random_nick.py
+++ b/plugins/random_nick.py
@@ -1,12 +1,6 @@
"""
This plugin makes you have a random nick when joining a MUC.
-Installation
-------------
-You only have to load the plugin.::
-
- /load random_nick
-
Usage
-----
diff --git a/plugins/regex_admin.py b/plugins/regex_admin.py
index 05b65db2..dcc9cebd 100644
--- a/plugins/regex_admin.py
+++ b/plugins/regex_admin.py
@@ -2,13 +2,6 @@
This plugins adds a :term:`/rkick` and a :term:`/rban` command,
in order to kick/ban according to a regex on a nick.
-Installation
-------------
-
-You only have to load the plugin:
-
-``/load regex_admin``
-
Commands
--------
diff --git a/plugins/reminder.py b/plugins/reminder.py
index eb2f9801..59337189 100644
--- a/plugins/reminder.py
+++ b/plugins/reminder.py
@@ -1,12 +1,4 @@
"""
-Installation
-------------
-You only have to load the plugin:
-
-.. code-block:: none
-
- /load reminder
-
Usage
-----
diff --git a/plugins/replace.py b/plugins/replace.py
index e238552f..c9143ef8 100644
--- a/plugins/replace.py
+++ b/plugins/replace.py
@@ -1,15 +1,6 @@
"""
Replace some patterns in a message before sending it.
-
-Installation
-------------
-You only have to load the plugin.
-
-.. code-block:: none
-
- /load replace
-
Usage
-----
Insert a pattern in the form
diff --git a/plugins/replace_word.py b/plugins/replace_word.py
index 6abb1702..ce685f49 100644
--- a/plugins/replace_word.py
+++ b/plugins/replace_word.py
@@ -1,15 +1,6 @@
"""
Replace some word with some other word in a message before sending it.
-
-Installation
-------------
-You only have to load the plugin.
-
-.. code-block:: none
-
- /load replace_word
-
Configuration example
---------------------
.. code-block:: ini
diff --git a/plugins/revstr.py b/plugins/revstr.py
index 4d5720dc..4ca154b7 100644
--- a/plugins/revstr.py
+++ b/plugins/revstr.py
@@ -1,16 +1,6 @@
"""
-Reverse everything you say.
-
-Installation
-------------
-
-You only have to load the plugin:
-
-.. code-block:: none
-
- /load revstr
-
-
+Reverse everything you say (``Je proteste énergiquement`` will become
+``tnemeuqigrené etsetorp eJ``)
"""
from plugin import BasePlugin
diff --git a/plugins/screen_detach.py b/plugins/screen_detach.py
index 2cc55cd6..3552a179 100644
--- a/plugins/screen_detach.py
+++ b/plugins/screen_detach.py
@@ -1,14 +1,6 @@
"""
This plugin will set your status to **away** if you detach your screen.
-Installation
-------------
-You only have to load the plugin.
-
-.. code-block:: none
-
- /load screen_detach
-
"""
from plugin import BasePlugin
import os
diff --git a/plugins/send_delayed.py b/plugins/send_delayed.py
index 3f678708..3f9ed931 100644
--- a/plugins/send_delayed.py
+++ b/plugins/send_delayed.py
@@ -1,3 +1,23 @@
+"""
+Send a message after a certain delay.
+
+Usage
+-----
+
+This plugin adds a command to the chat tabs.
+
+.. glossary::
+
+ /send_delayed
+ **Usage:** ``/send_delayed <delay> <message>``
+
+ Send a message after a given delay to the current tab.
+ The delay can be either in seconds or in a classic XdXhXm format
+ (e.g. ``7h3m`` or ``1d``), some examples are given with the
+ autocompletion.
+
+
+"""
from plugin import BasePlugin
import tabs
import common
diff --git a/plugins/shuffle.py b/plugins/shuffle.py
index 55f5cad2..e4fc81c8 100644
--- a/plugins/shuffle.py
+++ b/plugins/shuffle.py
@@ -1,16 +1,6 @@
"""
Shuffle the words in every message you send in a :ref:`muctab`
-(may confuse the reader).
-
-Installation
-------------
-
-You only have to load the plugin:
-
-.. code-block:: none
-
- /load shuffle
-
+(may/should confuse the reader).
"""
from plugin import BasePlugin
from random import shuffle
diff --git a/plugins/spaces.py b/plugins/spaces.py
index 9189d18a..7885ede6 100644
--- a/plugins/spaces.py
+++ b/plugins/spaces.py
@@ -1,14 +1,6 @@
"""
-Insert a space between each character, in messages that you send.
-
-Installation
-------------
-
-You only have to load the plugin:
-
-.. code-block:: none
- /load spaces
-
+Insert a space between each character, in messages that you send, making
+them horrible to read.
"""
from plugin import BasePlugin
diff --git a/plugins/spam.py b/plugins/spam.py
index e7a93e44..9caf9eca 100644
--- a/plugins/spam.py
+++ b/plugins/spam.py
@@ -1,20 +1,13 @@
"""
Add a subtle little advertising in your messages.
-Installation
-------------
-
-You only have to load the plugin:
-
-.. code-block:: none
-
- /load spam
-
-
Configuration
-------------
-[spam]
-ad = I’m a happy poezio user. Get it at http://poezio.eu
+
+.. code-block:: ini
+
+ [spam]
+ ad = I’m a happy poezio user. Get it at http://poezio.eu
"""
diff --git a/plugins/status.py b/plugins/status.py
index 9926ffc8..5bf21702 100644
--- a/plugins/status.py
+++ b/plugins/status.py
@@ -1,14 +1,6 @@
"""
This plugin adds several aliases, to shorten status changes.
-Installation
-------------
-You only have to load the plugin.
-
-.. code-block:: none
-
- /load status
-
Aliases
-------
diff --git a/plugins/tell.py b/plugins/tell.py
index 96b5bb1e..6aa8357d 100644
--- a/plugins/tell.py
+++ b/plugins/tell.py
@@ -1,13 +1,6 @@
"""
The command added by this plugin sends a message to someone when he next joins.
-Installation
-------------
-You only have to load the plugin:
-
-
-``/load tell``
-
Usage
-----
This plugin defines two new commands for MUC tabs: :term:`/tell` and :term:`/untell`.
@@ -16,12 +9,12 @@ This plugin defines two new commands for MUC tabs: :term:`/tell` and :term:`/unt
:sorted:
/tell
- *Usage*: ``/tell <nick> <message>``
+ **Usage:** ``/tell <nick> <message>``
Send *message* to *nick* at his next join.
/untell
- *Usage:* ``/untell <nick>``
+ **Usage:** ``/untell <nick>``
Cancel all scheduled messages to *nick*.
diff --git a/plugins/time_marker.py b/plugins/time_marker.py
index 7a20af8d..8fc1c08b 100644
--- a/plugins/time_marker.py
+++ b/plugins/time_marker.py
@@ -12,15 +12,6 @@ passed between two messages, if the time is bigger than X minutes
them, letting you understand more easily what is going on without any visual
clutter.
-Installation
-------------
-
-You only have to load the plugin.
-
-.. code-block:: none
-
- /load time_marker
-
Configuration
-------------
diff --git a/plugins/uptime.py b/plugins/uptime.py
index 6138063e..c071b4e8 100644
--- a/plugins/uptime.py
+++ b/plugins/uptime.py
@@ -1,15 +1,6 @@
"""
This plugin retrieves the uptime of a server.
-Installation
-------------
-You only have to load the plugin.
-
-.. code-block:: none
-
- /load uptime
-
-
Command
-------