From d28b70ccd4a29c6ef5b0f7f740ac04b4348669b4 Mon Sep 17 00:00:00 2001
From: Florent Le Coz <louiz@louiz.org>
Date: Tue, 8 Nov 2011 19:39:12 +0100
Subject: Some documentation improvements.

---
 doc/en/usage.txt | 31 ++++++++++++++++++++-----------
 src/core.py      |  4 ++--
 2 files changed, 22 insertions(+), 13 deletions(-)

diff --git a/doc/en/usage.txt b/doc/en/usage.txt
index e00b88de..e7df6ce8 100644
--- a/doc/en/usage.txt
+++ b/doc/en/usage.txt
@@ -1,18 +1,27 @@
 Usage
 =====
 
+This page is the main page of the documentation for poezio, explaining how to use it and describing its interfaces.
+
+Poezio is composed of tabs which can be of various types. Each tab type has
+a distinct interface, list of commands and list of key shortcuts, in addition
+to the global commands and key shortcuts.
+
 Commands
 --------
 
-Command listing
-~~~~~~~~~~~~~~~
+Commands start with the _/_ character and can take a list of any number
+of arguments, separated by spaces. If an argument should contain a space,
+you can use the _"_ character to surround this argument.
 
-The commands are shown like this:
+The commands described in this page are shown like this:
 
+===========================================================
 /command <mandatory argument> [optional argument]
+===========================================================
 
 Global commands
-^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~
 
 These commands work in *any* tab.
 
@@ -41,7 +50,7 @@ These commands work in *any* tab.
 
 */status <availability> [status message]*:: Set your availability and (optionaly) your status message. The <availability> argument is one of "available, chat, away, afk, dnd, busy, xa" and the optional [status] argument will be your status message.'
 
-*/bookmark [roomname][/nick]*:: Bookmark the specified room (you will then auto-join it on each poezio start). This commands uses the same syntax as /join. Type /help join for syntax examples. Note that when typing /bookmark on its own, the room will be bookmarked with the nickname you're currently using in this room (instead of default_nick).
+*/bookmark [roomname][/nick]*:: Bookmark the specified room (you will then auto-join it on each poezio start). This commands uses almost the same syntax as /join. Type /help join for syntax examples. Note that when typing /bookmark on its own, the room will be bookmarked with the nickname you're currently using in this room (instead of default_nick).
 
 */set <option> [value]*:: Sets the value to the option in your configuration file. You can, for example, change your default nickname by doing "/set default_nick toto" or your resource with "/set resource blabla". You can also set an empty value (nothing) by providing no [value] after <option>.
 
@@ -55,21 +64,21 @@ These commands work in *any* tab.
 
 */server_cycle [server.tld] [message]*:: Disconnect and reconnect in all the rooms of server.tld.
 
-*/bind <key> <eq>*:: Bind a key to another key or to a "command". For example, "/bind ^H KEY_UP" makes Control + h behave the same way than the Up key.
+*/bind <key> <eq>*:: Bind a key to another key or to a "command". For example, "/bind ^H KEY_UP" makes Control + h behave the same way as the Up key. See the link:keys.html[key bindings documentation page] for more details.
 
 NOTE: The following command will work everywhere, except in the Roster tab.
 
 */close*:: Close the tab.
 
 Chat tab commands
-^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~
 
 These commands will work in any conversation tab (MultiUserChat, Private, or Conversation tabs).
 
-*/say <message>*:: Just send the message (only useful it you want your message to begin with a "/").
+*/say <message>*:: Just send the message (only useful it you want your message to begin with a _/_).Note that you can also send message starting with a _/_ by starting it with _//_.
 
 MultiUserChat tab commands
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 */ignore <nickname>*:: Ignore a specified nickname.
 
@@ -102,7 +111,7 @@ MultiUserChat tab commands
 */clear*:: Clear the current buffer.
 
 Private tab commands
-^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~
 
 */info*:: Display some info about this user in the MultiUserChat.
 
@@ -111,7 +120,7 @@ Private tab commands
 */version*:: Get the software version of the current interlocutor (usually its XMPP client and Operating System).
 
 Normal Conversation tab commands
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 */info*:: Display the status of this contact.
 
diff --git a/src/core.py b/src/core.py
index b0b4a913..75cc1b90 100644
--- a/src/core.py
+++ b/src/core.py
@@ -112,7 +112,7 @@ class Core(object):
             'away': (self.command_away, _("Usage: /away [message]\nAway: Sets your availability to away and (optionaly) your status message. This is equivalent to '/status away [message]'"), None),
             'busy': (self.command_busy, _("Usage: /busy [message]\nBusy: Sets your availability to busy and (optionaly) your status message. This is equivalent to '/status busy [message]'"), None),
             'available': (self.command_avail, _("Usage: /available [message]\nAvailable: Sets your availability to available and (optionaly) your status message. This is equivalent to '/status available [message]'"), None),
-           'bookmark': (self.command_bookmark, _("Usage: /bookmark [roomname][/nick]\nBookmark: Bookmark the specified room (you will then auto-join it on each poezio start). This commands uses the same syntaxe as /join. Type /help join for syntaxe examples. Note that when typing \"/bookmark\" on its own, the room will be bookmarked with the nickname you\'re currently using in this room (instead of default_nick)"), None),
+           'bookmark': (self.command_bookmark, _("Usage: /bookmark [roomname][/nick]\nBookmark: Bookmark the specified room (you will then auto-join it on each poezio start). This commands uses almost the same syntaxe as /join. Type /help join for syntaxe examples. Note that when typing \"/bookmark\" on its own, the room will be bookmarked with the nickname you\'re currently using in this room (instead of default_nick)"), None),
             'set': (self.command_set, _("Usage: /set <option> [value]\nSet: Sets the value to the option in your configuration file. You can, for example, change your default nickname by doing `/set default_nick toto` or your resource with `/set resource blabla`. You can also set an empty value (nothing) by providing no [value] after <option>."), None),
             'theme': (self.command_theme, _('Usage: /theme [theme_name]\nTheme: Reload the theme defined in the config file. If theme_name is provided, set that theme before reloading it.'), None),
             'list': (self.command_list, _('Usage: /list\nList: get the list of public chatrooms on the specified server'), self.completion_list),
@@ -120,7 +120,7 @@ class Core(object):
             'version': (self.command_version, _('Usage: /version <jid>\nVersion: get the software version of the given JID (usually its XMPP client and Operating System)'), None),
             'connect': (self.command_reconnect, _('Usage: /connect\nConnect: disconnect from the remote server if you are currently connected and then connect to it again'), None),
             'server_cycle': (self.command_server_cycle, _('Usage: /server_cycle [domain] [message]\nServer Cycle: disconnect and reconnects in all the rooms in domain.'), None),
-            'bind': (self.command_bind, _('Usage: /bind <key> <equ>\nBind: bind a key to an other key or to a “command”. For example "/bind ^H KEY_UP" makes Control + h do the same same than the Up key.'), None),
+            'bind': (self.command_bind, _('Usage: /bind <key> <equ>\nBind: bind a key to an other key or to a “command”. For example "/bind ^H KEY_UP" makes Control + h do the same same as the Up key.'), None),
             }
 
         self.key_func = {
-- 
cgit v1.2.3


From aa2623c0c6872a456e2dcaf077910d8c5d921108 Mon Sep 17 00:00:00 2001
From: Florent Le Coz <louiz@louiz.org>
Date: Tue, 8 Nov 2011 19:40:28 +0100
Subject: change title level for Roster tab commands

---
 doc/en/usage.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/en/usage.txt b/doc/en/usage.txt
index e7df6ce8..7eb1b335 100644
--- a/doc/en/usage.txt
+++ b/doc/en/usage.txt
@@ -129,7 +129,7 @@ Normal Conversation tab commands
 */version*:: Get the software version of the current interlocutor (usually its XMPP client and Operating System).
 
 Roster tab commands
-^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~
 
 */accept [jid]*:: Authorize the provided JID (or the selected contact in the roster) to see your presence.
 
-- 
cgit v1.2.3