summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2013-04-10 01:42:34 +0200
committermathieui <mathieui@mathieui.net>2013-04-10 01:42:34 +0200
commit4c2553bbed66e7e92964aaf72ba43bd70245724b (patch)
treeb24d829e34e5b63c50bb7712cda33ffe23632d5e /doc/source
parentbf8e2a942c884a4a35e297734ce6c098849ac086 (diff)
downloadpoezio-4c2553bbed66e7e92964aaf72ba43bd70245724b.tar.gz
poezio-4c2553bbed66e7e92964aaf72ba43bd70245724b.tar.bz2
poezio-4c2553bbed66e7e92964aaf72ba43bd70245724b.tar.xz
poezio-4c2553bbed66e7e92964aaf72ba43bd70245724b.zip
Add the message correction note
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/commands.rst5
-rw-r--r--doc/source/misc/correct.rst24
-rw-r--r--doc/source/misc/index.rst1
3 files changed, 30 insertions, 0 deletions
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index ccc73821..962be9dd 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -223,6 +223,11 @@ These commands will work in any conversation tab (MultiUserChat, Private, or
.. glossary::
:sorted:
+ /correct
+ **Usage:** ``/correct <corrected message>``
+
+ Replace the content of the last sent message with *corrected message*.
+
/say
**Usage:** ``/say <message>``
diff --git a/doc/source/misc/correct.rst b/doc/source/misc/correct.rst
new file mode 100644
index 00000000..a5d7a9c7
--- /dev/null
+++ b/doc/source/misc/correct.rst
@@ -0,0 +1,24 @@
+Message Correction
+==================
+
+Poezio implements the `XEP-0308`_
+which allows the correction of the last message sent.
+
+The corrections are signalled with a number append to the nick of the user, in
+a different color.
+
+.. figure:: ../images/correct.png
+ :alt: Corrected message
+
+The **9** here represents the number of times this message has been corrected.
+
+
+You can show the revisions of a message by loading the
+*display_corrections* plugin, and you
+can correct your own messages with the :term:`/correct` command.
+
+
+.. note:: Please do not abuse of this feature, as it will simply be displayed as
+ another plain message in the clients that do not support correction.
+
+.. _XEP-0308: http://xmpp.org/extensions/xep-0308.html
diff --git a/doc/source/misc/index.rst b/doc/source/misc/index.rst
index bf8fcb90..60a2a4e1 100644
--- a/doc/source/misc/index.rst
+++ b/doc/source/misc/index.rst
@@ -6,6 +6,7 @@ Contents:
.. toctree::
:maxdepth: 2
+ correct
ssl