diff options
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/commands.rst | 30 | ||||
| -rw-r--r-- | doc/source/configuration.rst | 24 | ||||
| -rw-r--r-- | doc/source/keys.rst | 13 | ||||
| -rw-r--r-- | doc/source/misc/personal_events.rst | 4 | ||||
| -rw-r--r-- | doc/source/plugins/index.rst | 2 | ||||
| -rw-r--r-- | doc/source/usage.rst | 11 |
6 files changed, 43 insertions, 41 deletions
diff --git a/doc/source/commands.rst b/doc/source/commands.rst index c69d6cbc..8c0e0d5b 100644 --- a/doc/source/commands.rst +++ b/doc/source/commands.rst @@ -199,8 +199,8 @@ These commands work in *any* tab. /message **Usage:** ``/message <jid> [optional message]`` - Open a conversation with the specified JID (event if it is not in our roster), - and send a message to him/her, if specified. + Open a conversation with the specified JID (event if it is not in our + contact list), and send a message to them, if specified. /version **Usage:** ``/version <jid>`` @@ -273,8 +273,8 @@ These commands work in *any* tab. /close Close the tab. - .. note:: The /close command will work everywhere, except in the Roster tab, - which can’t be closed. + .. note:: The /close command will work everywhere, except in the + Contact list tab, which can’t be closed. .. _chattab-commands: @@ -467,8 +467,8 @@ Normal Conversation tab commands .. _rostertab-commands: -Roster tab commands -~~~~~~~~~~~~~~~~~~~ +Contact list tab commands +~~~~~~~~~~~~~~~~~~~~~~~~~ .. glossary:: :sorted: @@ -476,25 +476,25 @@ Roster tab commands **Usage:** ``/accept [jid]`` Authorize the provided JID (or the selected contact in the - roster) to see your presence. + contact list) to see your presence. /deny **Usage:** ``/deny [jid]`` Prevent the provided JID (or the selected contact in the - roster) from seeing your presence. + contact list) from seeing your presence. /add **Usage:** ``/add <jid>`` - Add the specified JID to your roster and authorize him to see - your presence. If he accepts you, the subscription will be mutual (and if he - doesn’t, you can still /remove him). + Add the specified JID to your contact list and authorize them to see + your presence. If they accepts you, the subscription will be mutual + (and if they don’t, you can still /remove them). /name **Usage:** ``/name <jid> <name>`` - Set the given JID’s name in your roster. + Set the given JID’s name in your contact list. /password **Usage:** ``/password <password>`` @@ -506,7 +506,7 @@ Roster tab commands Add the given JID to the given group (if the group does not exist, it will be created). If no jid is provided, - the currently selected item on the roster (resource or JID) + the currently selected item on the contact list (resource or JID) will be used. /groupmove @@ -525,9 +525,9 @@ Roster tab commands /remove **Usage:** ``/remove [jid]`` - Remove the specified JID from your roster. This will + Remove the specified JID from your contact list. This will unsubscribe you from its presence, cancel its subscription to yours, and - remove the item from your roster. + remove the item from your contact list. /reconnect diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst index db762daa..24d82f71 100644 --- a/doc/source/configuration.rst +++ b/doc/source/configuration.rst @@ -491,9 +491,9 @@ or the way messages are displayed. **Default value:** ``true`` The tabs have a name, and a nick, which is, for a contact, its name in - the roster, or for a private conversation, the nickname in the chatroom. - Set this to ``true`` if you want to have them shown instead of the jid - of the contact. + the contact list, or for a private conversation, the nickname in the + chatroom. Set this to ``true`` if you want to have them shown instead + of the jid of the contact. theme @@ -661,8 +661,8 @@ or the way messages are displayed. **Default value:** ``name`` - How to sort the roster groups. The principles are the same as :term:`roster_sort` - (see below). + How to sort the contact list groups. The principles are the same + as :term:`roster_sort` (see below). Available methods are: * ``reverse``: reverse the current sorting @@ -682,7 +682,7 @@ or the way messages are displayed. **Default value:** ``jid:show`` - How you want the contacts to be sorted inside the roster groups. The given + How you want the contacts to be sorted inside the contact list groups. The given methods are used sequentially (from left to right), so the last one is the one on the far right. @@ -691,7 +691,7 @@ or the way messages are displayed. * ``reverse``: reverse the current sorting * ``jid``: sort by JID (alphabetical order) * ``show``: sort by show (available/away/xa/…) - * ``name``: sort by roster name (if no name, then the bare jid is used) + * ``name``: sort by given name (if no name, then the bare jid is used) * ``resource``: sort by resource number * ``online``: sort by online presence (online or not) @@ -719,9 +719,9 @@ or the way messages are displayed. **Default value:** ``true`` - Set this to ``false`` if you want to hide the JIDs in the roster (and keep only - the contact names). If there is no contact name, the JID will still be - displayed. + Set this to ``false`` if you want to hide the JIDs in the contact list + (and keep only the contact names). If there is no contact name, the + JID will still be displayed. show_jid_in_conversations @@ -734,13 +734,13 @@ or the way messages are displayed. **Default value:** ``true`` - Show s2s errors in the roster or not. + Show s2s errors in the contact list or not. show_roster_subscriptions **Defalt value:** ``[empty]`` - Select the level of display of subscriptions with a char the roster + Select the level of display of subscriptions with a char in the contact list. - ``all`` to display all subscriptions - ``incomplete`` to display *from*, *to* and *none* diff --git a/doc/source/keys.rst b/doc/source/keys.rst index 41b71078..57b8c22e 100644 --- a/doc/source/keys.rst +++ b/doc/source/keys.rst @@ -34,7 +34,7 @@ highlight > message > non-empty input). **Alt-z**: Go to the previously selected tab. -**Alt-r**: Go to the roster tab. +**Alt-r**: Go to the contact list tab. **F4**: Toggle the left pane. @@ -165,10 +165,10 @@ These keys work only in the MultiUserChat List tab (obtained with :term:`/list`) .. _rostertab-keys: -Roster tab input keys -~~~~~~~~~~~~~~~~~~~~~ +Contact list tab input keys +~~~~~~~~~~~~~~~~~~~~~~~~~~~ -These keys work only in the Roster tab (the tab number 0). +These keys work only in the Contact list tab (the tab number 0). **/**: Open a prompt for commands. @@ -292,7 +292,8 @@ Actions list **_close_tab**: Closes the current tab. - This is the same as :term:`/close`. The first tab (the roster) can not be closed. + This is the same as :term:`/close`. The first tab (the contact list) can + not be closed. **_disconnect**: Disconnects poezio from the server. @@ -324,7 +325,7 @@ Actions list Similar to the default Ctrl-n action. -**_show_roster**: Goes to the roster. +**_show_roster**: Goes to the contact list Similar to Alt-r action. diff --git a/doc/source/misc/personal_events.rst b/doc/source/misc/personal_events.rst index 6bb1ee23..16dd8a5e 100644 --- a/doc/source/misc/personal_events.rst +++ b/doc/source/misc/personal_events.rst @@ -10,7 +10,7 @@ Those extensions are standardized ways to broadcast informations that might be useful to your contacts (they will receive those informations only if they have indicated their interest in them). -The events are also shown in the roster, next to the contact line: +The events are also shown in the contact list, next to the contact line: .. figure:: ../images/pep.png :alt: Personal Events @@ -18,7 +18,7 @@ The events are also shown in the roster, next to the contact line: On the above figure, A stands for Activity, M for Mood, and G for Gaming. The details are shown with notifications if configured, and in the detailed -contact information window, on the bottom left in the roster tab. +contact information window, on the bottom left in the contact list tab. .. figure:: ../images/pep_infos.png :alt: Personal Events details diff --git a/doc/source/plugins/index.rst b/doc/source/plugins/index.rst index ea9e13de..1ea4d952 100644 --- a/doc/source/plugins/index.rst +++ b/doc/source/plugins/index.rst @@ -85,7 +85,7 @@ Plugin index Close all :ref:`Documentation <closeall-plugin>` - Close all tabs except chatrooms and the roster. + Close all tabs except chatrooms and the contact list. CSI :ref:`Documentation <csi-plugin>` diff --git a/doc/source/usage.rst b/doc/source/usage.rst index ebe7f483..477de690 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -59,7 +59,7 @@ Generalities :ref:`Global shortcuts <global-keys>` -The tab numbered **0** is always the **roster** tab, the other tabs can be of any +The tab numbered **0** is always the **Contact list** tab, the other tabs can be of any type. .. figure:: ./images/tab_bar.png @@ -89,8 +89,8 @@ You can go from one tab to another in many ways: .. _rostertab: -Roster tab -~~~~~~~~~~ +Contact list tab +~~~~~~~~~~~~~~~~ :ref:`Specific commands <rostertab-commands>` @@ -105,7 +105,7 @@ Use the **direction arrows** (↑↓) to browse the list, the ``Space`` key to fold or unfold a group or a contact. .. figure:: ./images/roster.png - :alt: The roster tab + :alt: The contact list tab #. Area where information messages are displayed. #. Actual list of contacts. The first level is group, the second is the @@ -195,7 +195,8 @@ Conversation tab :ref:`Chat shortcuts <chattab-keys>` -A tab opened from the roster or :term:`/message`, to talk in private with one of your contacts. +A tab opened by interacting with the contact list or :term:`/message`, +to talk in private with one of your contacts. .. figure:: ./images/conversation.png :alt: The conversation tab |