From f8eb06b68c788eaa880a884a9b4b8797d4573993 Mon Sep 17 00:00:00 2001 From: Florent Le Coz Date: Tue, 8 Nov 2011 20:07:24 +0100 Subject: Describe tab system --- doc/en/usage.txt | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) (limited to 'doc/en/usage.txt') diff --git a/doc/en/usage.txt b/doc/en/usage.txt index c77a8076..6f28572f 100644 --- a/doc/en/usage.txt +++ b/doc/en/usage.txt @@ -8,6 +8,32 @@ 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. +Tabs +---- +On all tabs, you get a line showing the the list of all opened tabs. Each tab has a number, each time you open a new tab, it gets the next available number. + +image::../images/tab_bar.png["Example of 5 opened tabs", title="Example of 5 opened tabs"] + +The tab numbered _0_ is always the _roster_ tab, the other tabs can be of any type. + +The status of a tab is represented by its color: + +* *[navy]#blue#* (tab _0_): an inactive tab of any type, nothing new to see there. +* *[purple]#purple#* (tab _1_): a MultiUserChat tab with at least one new unread message. +* *[green]#green#* (tab _2_): a tab of a private conversation with a new message to read. +* *[teal]#cyan#* (tab _3_): the current tab. +* *[red]#red#* (tab _4_): a MultiUserChat tab with at least one new hightlight message. + +You can go from one tab to another in many ways: + +* Ctrl+n and Ctrl+p +* <> command +* <> and <> commands +* Alt+ a number +* Alt+j followed by a two-digits number +* Alt+e, this will jump to the next tab with the highest priority. Priority applies in this order: private message > highlight message > normal message. + + Commands -------- @@ -47,10 +73,13 @@ These commands work in *any* tab. */quit*:: Like /exit. +[[command-next]] */next*:: Go to the next room. +[[command-prev]] */prev*:: Go to the previous room. +[[command-win]] */win *:: Go to the specified room. */w *:: Like /win. -- cgit v1.2.3 From 08664e3ba77d0e337b3d7ca341992f8037513d88 Mon Sep 17 00:00:00 2001 From: Florent Le Coz Date: Tue, 8 Nov 2011 20:21:59 +0100 Subject: =?UTF-8?q?80=20cols=C2=B3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/en/usage.txt | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) (limited to 'doc/en/usage.txt') diff --git a/doc/en/usage.txt b/doc/en/usage.txt index 6f28572f..95530664 100644 --- a/doc/en/usage.txt +++ b/doc/en/usage.txt @@ -10,19 +10,27 @@ to the global commands and key shortcuts. Tabs ---- -On all tabs, you get a line showing the the list of all opened tabs. Each tab has a number, each time you open a new tab, it gets the next available number. +On all tabs, you get a line showing the the list of all opened tabs. Each tab +has a number, each time you open a new tab, it gets the next available number. -image::../images/tab_bar.png["Example of 5 opened tabs", title="Example of 5 opened tabs"] -The tab numbered _0_ is always the _roster_ tab, the other tabs can be of any type. +image::../images/tab_bar.png[title="Example of 5 opened tabs"] + +The tab numbered _0_ is always the _roster_ tab, the other tabs can be of any +type. + The status of a tab is represented by its color: -* *[navy]#blue#* (tab _0_): an inactive tab of any type, nothing new to see there. -* *[purple]#purple#* (tab _1_): a MultiUserChat tab with at least one new unread message. -* *[green]#green#* (tab _2_): a tab of a private conversation with a new message to read. +* *[navy]#blue#* (tab _0_): an inactive tab of any type, nothing new to see + there. +* *[purple]#purple#* (tab _1_): a MultiUserChat tab with at least one new + unread message. +* *[green]#green#* (tab _2_): a tab of a private conversation with a new + message to read. * *[teal]#cyan#* (tab _3_): the current tab. -* *[red]#red#* (tab _4_): a MultiUserChat tab with at least one new hightlight message. +* *[red]#red#* (tab _4_): a MultiUserChat tab with at least one new hightlight + message. You can go from one tab to another in many ways: @@ -31,8 +39,8 @@ You can go from one tab to another in many ways: * <> and <> commands * Alt+ a number * Alt+j followed by a two-digits number -* Alt+e, this will jump to the next tab with the highest priority. Priority applies in this order: private message > highlight message > normal message. - +* Alt+e, this will jump to the next tab with the highest priority. Priority + applies in this order: private message > highlight message > normal message. Commands -------- -- cgit v1.2.3 From 8c2cd6e52111d68baf4c10ad1a72c4d06a5d1066 Mon Sep 17 00:00:00 2001 From: Florent Le Coz Date: Tue, 8 Nov 2011 20:38:14 +0100 Subject: Describe the roster tab --- doc/en/usage.txt | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'doc/en/usage.txt') diff --git a/doc/en/usage.txt b/doc/en/usage.txt index 95530664..2bfecac8 100644 --- a/doc/en/usage.txt +++ b/doc/en/usage.txt @@ -42,6 +42,22 @@ You can go from one tab to another in many ways: * Alt+e, this will jump to the next tab with the highest priority. Priority applies in this order: private message > highlight message > normal message. +Roster tab +~~~~~~~~~~ +This is a unique tab, always numbered _0_. It contains the list of your +contacts. You can add/remove/edit/search contacts from there, and you can open +a conversation with one of them. + +Use the _arrows_ to browse the list, the _space_ key to fold or unfold a group +or a contact. + +image::../images/roster.png["The roster tab", title="The roster tab"] + +* _1_: The area where information messages are displayed. +* _2_: The actual list of contacts. The first level is group, the second is the +* contacts and the third is the resources of you online contacts. +* _3_: More informations about the selected contact. + Commands -------- -- cgit v1.2.3