diff options
| author | mathieui <mathieui@mathieui.net> | 2013-01-19 00:00:57 +0100 |
|---|---|---|
| committer | mathieui <mathieui@mathieui.net> | 2013-01-19 00:00:57 +0100 |
| commit | dcd82d93b2d8401ae5f999865fb608a8b780cdeb (patch) | |
| tree | d854bd143dffc1e64df02e7682268b3ac1aa1772 | |
| parent | 3755b51430f5532e2cf3934f027537b832c07b2a (diff) | |
| download | poezio-dcd82d93b2d8401ae5f999865fb608a8b780cdeb.tar.gz poezio-dcd82d93b2d8401ae5f999865fb608a8b780cdeb.tar.bz2 poezio-dcd82d93b2d8401ae5f999865fb608a8b780cdeb.tar.xz poezio-dcd82d93b2d8401ae5f999865fb608a8b780cdeb.zip | |
Add some documentation about message correction
| -rw-r--r-- | doc/en/index.txt | 1 | ||||
| -rw-r--r-- | doc/en/misc/correct.txt | 21 | ||||
| -rw-r--r-- | doc/en/misc/index.txt | 8 | ||||
| -rw-r--r-- | doc/en/plugins/display_corrections.txt | 8 |
4 files changed, 34 insertions, 4 deletions
diff --git a/doc/en/index.txt b/doc/en/index.txt index e7d89277..9b9c6630 100644 --- a/doc/en/index.txt +++ b/doc/en/index.txt @@ -14,6 +14,7 @@ Available pages * link:themes.html[Theming] * link:keys.html[Keys] * link:plugins/index.html[Available Plugins] +* link:misc/index.html[Other topics] * link:plugins.html[Developing plugins] * link:dev/index.html[Developing Poezio] * link:xep.html[Current XEP support] diff --git a/doc/en/misc/correct.txt b/doc/en/misc/correct.txt new file mode 100644 index 00000000..eadcde2b --- /dev/null +++ b/doc/en/misc/correct.txt @@ -0,0 +1,21 @@ +Message Correction +================== + +Poezio implements the link:http://xmpp.org/extensions/xep-0308.html[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. + +image::../../images/correct.png["Corrected message", title="A 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 +link:../plugins/display_corrections.html[display_corrections] plugin, and you +can correct your own messages with the */correct* command. + + +NOTE: Please do not abuse of this feature, as it will simply be displayed as +another message in the other clients. diff --git a/doc/en/misc/index.txt b/doc/en/misc/index.txt new file mode 100644 index 00000000..52331942 --- /dev/null +++ b/doc/en/misc/index.txt @@ -0,0 +1,8 @@ +Other topics +============ + +Available pages in this topic +----------------------------- + + +* link:correct.html[Message Correction] diff --git a/doc/en/plugins/display_corrections.txt b/doc/en/plugins/display_corrections.txt index 570556b2..dff55afe 100644 --- a/doc/en/plugins/display_corrections.txt +++ b/doc/en/plugins/display_corrections.txt @@ -8,19 +8,19 @@ Installation ============================ - /load display\_corrections + /load display_corrections ============================ Usage ----- -This plugin adds a _/display\_corrections command that will display a list of +This plugin adds a _/display_corrections_ command that will display a list of old versions of a message. -_/display\_corrections_ without argument will list the last corrected message, -if any is found. If an integer argument is given, /display\_corrections will +_display_corrections_ without argument will list the last corrected message, +if any is found. If an integer argument is given, _display_corrections_ will go back gradually in the buffer to list the previous corrected messages, and so on. |