summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2011-11-08 22:04:11 +0100
committermathieui <mathieui@mathieui.net>2011-11-08 22:04:11 +0100
commit767c16bf167e80e4eaa77e66800f056e0e7a4f8b (patch)
treed743f25370d25190689c6390ad0c50228755bef3 /doc
parent08349495af2618de761e874d1daa149c390501bb (diff)
parent5cf4bb1a65fb0dd5b8e1c5016bb1e48a979fae91 (diff)
downloadpoezio-767c16bf167e80e4eaa77e66800f056e0e7a4f8b.tar.gz
poezio-767c16bf167e80e4eaa77e66800f056e0e7a4f8b.tar.bz2
poezio-767c16bf167e80e4eaa77e66800f056e0e7a4f8b.tar.xz
poezio-767c16bf167e80e4eaa77e66800f056e0e7a4f8b.zip
Merge branch 'master' of https://git.louiz.org/poezio
Diffstat (limited to 'doc')
-rw-r--r--doc/en/usage.txt78
-rw-r--r--doc/images/conversation.pngbin0 -> 12992 bytes
-rw-r--r--doc/images/data_forms.pngbin0 -> 8624 bytes
-rw-r--r--doc/images/list.pngbin0 -> 7768 bytes
-rw-r--r--doc/images/muc.pngbin0 -> 42090 bytes
-rw-r--r--doc/images/private.pngbin0 -> 9145 bytes
-rw-r--r--doc/images/roster.pngbin0 -> 14736 bytes
-rw-r--r--doc/images/tab_bar.pngbin0 -> 956 bytes
8 files changed, 78 insertions, 0 deletions
diff --git a/doc/en/usage.txt b/doc/en/usage.txt
index 2bfecac8..d0a58a8f 100644
--- a/doc/en/usage.txt
+++ b/doc/en/usage.txt
@@ -58,6 +58,84 @@ image::../images/roster.png["The roster tab", title="The roster tab"]
* contacts and the third is the resources of you online contacts.
* _3_: More informations about the selected contact.
+MultiUserChat tab
+~~~~~~~~~~~~~~~~~
+
+This tab contains a multi-users conversation.
+
+image::../images/muc.png["The MUC tab", title="The MUC tab"]
+
+* _1_: The conversation window, this is where all the messages and events
+ related to the muc will be displayed. It can be scrolled up and down with
+ PageUp and PageDown.
+* _2_: The participant list. Participants are listed by their role first, and
+ then alphabetically.
+ In the default theme, The nick colors mean:
+ - Red: moderator
+ - Blue: participant
+ - gray: visitor +
+ +
+ The status of each participant is symbolized using the _color_ of the
+ character on the left of its nick.
+ That character also shows the chatstate of each participant:
+ - _|_: inactive
+ - _X_: composing
+ - _A_: active
+ - _p_: paused
+* _3_: Your information in that MUC (the name of the room, your nick, your role
+ and affiliation).
+* _4_: The topic of the room.
+
+You can configure the room (if you have the rights to do it) using the
+_/configure_ command, open a private conversation with someone using the
+_/query_ command, change or view the topic using the _/topic_ command…
+
+Private tab
+~~~~~~~~~~~
+This is the tab opened with the _/query_ command, letting you talk in private
+with a participant of a multi-users chat.
+
+image::../images/muc.png["The private tab", title="The private tab"]
+
+This is just a simple one to one conversation, with a line showing the status,
+name and chatstate of the participant.
+
+Conversation tab
+~~~~~~~~~~~~~~~~
+A tab opened from the roster, to talk in private with one of your contacts.
+
+image::../images/conversation.png["The conversation tab", title="The conversation tab"]
+
+This is also just a simple one to one conversation, with a line showing the status,
+name and chatstate of the participant, as well as a line at the top showing the
+status message of the contact.
+
+Dataforms tab
+~~~~~~~~~~~~~
+
+This tab lets you view a form receive from a remote entity, edit the values and
+send everything back. It is mostly used to configure MUCs with the _/configure_
+command but can actually be used for almost anything.
+
+image::../images/data_forms.png["The dataform tab", title="The dataform tab"]
+
+Use the _up_ and _down_ keys to go from one field to the other, and edit the
+value using the _space_, _left_ or _right_ keys, or by entering text.
+
+You can then send the completed form using _Ctrl+y_ or cancel using _Ctrl+g_.
+
+List tab
+~~~~~~~~
+
+This tab lists all public rooms on a MUC service. It is currently very limited
+but will be improved in the future. There currently is no way to search a room
+or even to sort them.
+
+image::../images/list.png["The list tab", title="The list tab"]
+
+Use the _up_ and _down_ or _PageUp_ and _PageDown_ keys to browse the list, and
+use _Enter_ or _j_ to join the selected room.
+
Commands
--------
diff --git a/doc/images/conversation.png b/doc/images/conversation.png
new file mode 100644
index 00000000..f5347178
--- /dev/null
+++ b/doc/images/conversation.png
Binary files differ
diff --git a/doc/images/data_forms.png b/doc/images/data_forms.png
new file mode 100644
index 00000000..d6e53cd9
--- /dev/null
+++ b/doc/images/data_forms.png
Binary files differ
diff --git a/doc/images/list.png b/doc/images/list.png
new file mode 100644
index 00000000..768ca41f
--- /dev/null
+++ b/doc/images/list.png
Binary files differ
diff --git a/doc/images/muc.png b/doc/images/muc.png
new file mode 100644
index 00000000..1e431e4a
--- /dev/null
+++ b/doc/images/muc.png
Binary files differ
diff --git a/doc/images/private.png b/doc/images/private.png
new file mode 100644
index 00000000..7d604dc2
--- /dev/null
+++ b/doc/images/private.png
Binary files differ
diff --git a/doc/images/roster.png b/doc/images/roster.png
new file mode 100644
index 00000000..d853c1cb
--- /dev/null
+++ b/doc/images/roster.png
Binary files differ
diff --git a/doc/images/tab_bar.png b/doc/images/tab_bar.png
new file mode 100644
index 00000000..fc482ffd
--- /dev/null
+++ b/doc/images/tab_bar.png
Binary files differ