From 4c2553bbed66e7e92964aaf72ba43bd70245724b Mon Sep 17 00:00:00 2001 From: mathieui Date: Wed, 10 Apr 2013 01:42:34 +0200 Subject: [PATCH] Add the message correction note --- doc/source/commands.rst | 5 +++++ doc/source/misc/correct.rst | 24 ++++++++++++++++++++++++ doc/source/misc/index.rst | 1 + 3 files changed, 30 insertions(+) create mode 100644 doc/source/misc/correct.rst 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 `` + + Replace the content of the last sent message with *corrected message*. + /say **Usage:** ``/say `` 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