Commit 550aa6ef authored by mathieui's avatar mathieui

Remove useless "installation" parts from the plugin documentations

parent e80ea90e
......@@ -152,7 +152,12 @@ Plugin index
Screen Detach
:ref:`Documentation <screendetach-plugin>`
Changes your status to _away_ if the screen poezio is in is detached.
Changes your status to **away** if the screen poezio is in is detached.
Send Delayed
:ref:`Documentation <senddelayed-plugin>`
Program the sending of futur messages.
Simple notify
:ref:`Documentation <simplenotify-plugin>`
......
......@@ -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
---------------
......
......@@ -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
......
"""
This plugin lets you perform simple replacements on the last message.
Installation
------------
Load the plugin::
/load autocorrect
Usage
-----
......
"""
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
......
......@@ -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 _
......
"""
Lists old versions of a corrected message.
Installation
------------
::
/load display_corrections
Usage
-----
......
"""
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
......
"""
This plugin lets you execute a system command through poezio.
Installation
------------
You only have to load the plugin. ::
/load exec
Usage
-----
......
......@@ -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
-----
......
"""
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
......
"""
Repeats the last message in the conversation.
Installation
------------
You only have to load the plugin:
.. code-block:: none
/load mirror
Command
-------
......
"""
This plugin is here to send what you are listening to in a chat tab.
Installation
------------
......
"""
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
-----
......
"""
This plugin allows you to ping an entity.
Installation
------------
You only have to load the plugin.
.. code-block:: none
/load ping
Command
-------
......
......@@ -28,6 +28,8 @@ Command
/pointpoint
**Usage:** ``/pointpoint``
"""
......
"""
This plugin allows you to quote messages easily.
Installation
------------
You only have to load the plugin.
.. code-block:: none
/load quote
Usage
-------
-----
.. glossary::
......
"""
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
-----
......
"""
This plugin makes you have a random nick when joining a MUC.
Installation
------------
You only have to load the plugin.::
/load random_nick
Usage
-----
......
......@@ -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
--------
......
"""
Installation
------------
You only have to load the plugin:
.. code-block:: none
/load reminder
Usage
-----
......
"""
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
......
"""
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
......
"""
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
......
"""
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
......
"""
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
......
"""
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
......
"""
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
......
"""
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
"""
......
"""
This plugin adds several aliases, to shorten status changes.
Installation
------------
You only have to load the plugin.
.. code-block:: none
/load status
Aliases
-------
......
"""
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*.
......
......@@ -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
-------------
......
"""
This plugin retrieves the uptime of a server.
Installation
------------
You only have to load the plugin.
.. code-block:: none
/load uptime
Command
-------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment