summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2016-10-04 00:26:54 +0200
committermathieui <mathieui@mathieui.net>2016-10-04 00:29:19 +0200
commit5a6ba4dda826308fd3ba5abd8cc25fba2166a431 (patch)
tree8ef6c6f010ff1feed1a4fb56e17fe955a7ff9ae7 /doc/source
parentc5e80b968862b4fe54d394ed278466f3eb02dd41 (diff)
downloadpoezio-5a6ba4dda826308fd3ba5abd8cc25fba2166a431.tar.gz
poezio-5a6ba4dda826308fd3ba5abd8cc25fba2166a431.tar.bz2
poezio-5a6ba4dda826308fd3ba5abd8cc25fba2166a431.tar.xz
poezio-5a6ba4dda826308fd3ba5abd8cc25fba2166a431.zip
Replace "MUC" by "chatroom" in the documentation
And fix some linewrapping, obsolete references to poezio.eu, and obsolete docs.
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/commands.rst6
-rw-r--r--doc/source/configuration.rst72
-rw-r--r--doc/source/keys.rst10
-rw-r--r--doc/source/misc/troubleshooting.rst2
-rw-r--r--doc/source/plugins/index.rst12
-rw-r--r--doc/source/usage.rst14
6 files changed, 62 insertions, 54 deletions
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index a73fa9b3..c69d6cbc 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -344,7 +344,7 @@ MultiUserChat tab commands
this nick.
You can also use **random** to attribute a random color.
- /clear [MUCTab version]
+ /clear [Chatroom version]
**Usage:** ``/clear``
Clear the messages buffer.
@@ -354,7 +354,7 @@ MultiUserChat tab commands
Ignore a specified nickname.
- /invite [MUCTab version]
+ /invite [Chatroom version]
**Usage:** ``/invite <jid> [reason]``
Invite *jid* to this room with *reason* (if
@@ -395,8 +395,6 @@ MultiUserChat tab commands
**Usage:** ``/nick <nickname>``
Change your nickname in the current room.
- **Except for gmail users** because gmail.com sucks and will do weird things
- if you change your nickname in a MUC.
/recolor
**Usage:** ``/recolor [random]``
diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst
index 4f11a558..db762daa 100644
--- a/doc/source/configuration.rst
+++ b/doc/source/configuration.rst
@@ -490,9 +490,10 @@ 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 MUC. Set this to
- ``true`` if you want to have them shown instead of the jid of the contact.
+ 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.
theme
@@ -534,8 +535,9 @@ or the way messages are displayed.
**Default value:** ``desc``
- If set to ``desc``, the MUC users will be displayed from top to bottom in the list,
- if set to ``asc``, they will be displayed from bottom to top.
+ If set to ``desc``, the chatroom users will be displayed from top to
+ bottom in the list, if set to ``asc``, they will be displayed from
+ bottom to top.
deterministic_nick_colors
@@ -637,8 +639,8 @@ or the way messages are displayed.
**Default value:** ``true``
- If set to true, the color of the nick will be used in MUCs information
- messages, instead of the default color from the theme.
+ If set to true, the color of the nick will be used in chatroom
+ information messages, instead of the default color from the theme.
enable_vertical_tab_list
@@ -708,9 +710,10 @@ or the way messages are displayed.
**Default value:** ``true``
- Set this to ``false`` if you want to display only the “user” part of the MUC
- jid. E.g. if you have **poezio@muc.poezio.eu**, it will be displayed as
- **poezio**. This will be used only if :term:`use_tab_nicks` is set to ``true``.
+ Set this to ``false`` if you want to display only the “user” part of the
+ chatroom jid. E.g. if you have **poezio@muc.poez.io**, it will be
+ displayed as **poezio**. This will be used only if :term:`use_tab_nicks`
+ is set to ``true``.
show_roster_jids
@@ -785,9 +788,9 @@ or the way messages are displayed.
**Default:** ``[empty]``
- Fix a color for a nick. Whenever such a nick appears in a MUC, it will
- be displayed in that color. This color won't be changed by the recolor
- command.
+ Fix a color for a nick. Whenever such a nick appears in a chatroom, it
+ will be displayed in that color. This color won't be changed by the
+ recolor command.
User Interaction
~~~~~~~~~~~~~~~~
@@ -820,9 +823,10 @@ Options that change the behavior of poezio in a non-visual manner.
(separated by spaces).
The events can be
- - ``highlight`` (when you are highlighted in a MUC)
- - ``private`` (when a new private message is received, from your contacts or someone from a MUC)
- - ``message`` (any message from a MUC)
+ - ``highlight`` (when you are highlighted in a chatroom)
+ - ``private`` (when a new private message is received, from your
+ contacts or someone from a chatroom)
+ - ``message`` (any message from a chatroom)
separate_history
@@ -973,7 +977,7 @@ Other
Send initial presence (normal behaviour). If ``false``, you will not send nor
receive any presence that is not directed (through :term:`/presence`) or sent by a
- MUC.
+ chatroom.
lazy_resize
@@ -1055,8 +1059,8 @@ found.
**Default value:** ``false``
- Disable the beeps triggered by this conversation. Works in MucTab,
- PrivateTab and ConversationTab.
+ Disable the beeps triggered by this conversation. Works in chatroom
+ tabs, private messaging tabs, and conversation tabs.
display_activity_notifications
@@ -1083,8 +1087,8 @@ found.
**Default value:** ``false``
- If set to ``true``, the color of the nick will be used in MUCs information
- messages, instead of the default color from the theme.
+ If set to ``true``, the color of the nick will be used in chatroom
+ information messages, instead of the default color from the theme.
display_tune_notifications
@@ -1178,8 +1182,8 @@ found.
**Default value:** ``true``
- Lets you disable/enable chatstates per-JID. Works in MucTab, PrivateTab
- and ConversationTab.
+ Lets you disable/enable chatstates per-JID. Works in chatroom tabs,
+ private messaging tabs, and normal conversation tabs.
show_useless_separator
@@ -1199,24 +1203,26 @@ found.
**Default value:** ``true``
- Only for MUC tabs: if true the tab will change its color to notify you when a new message is received.
- You will still be notified of highlights. Set to ``false`` if you’re not interested in a room non-highlight notifications.
+ Only for chatroom tabs: if true the tab will change its color to
+ notify you when a new message is received.
+ You will still be notified of highlights. Set to ``false`` if you are
+ not interested in a room non-highlight notifications.
self_ping_delay
**Default value:** ``0``
When this option is set to a positive value ``n``, poezio will send
- a ping request to its own nick in the MUC every n seconds of
+ a ping request to its own nick in the chatroom every n seconds of
inactivity (whenever no new message or presence is received from the
- MUC room for more than n seconds). If the MUC service does not
+ chatroom for more than n seconds). If the chatroom service does not
respond with a successful pong within 60 seconds (that is: on an
- error of the type “not-allowed” which means the MUC service doesn’t
- consider us to be present in that room, or on a timeout which
- probably means that the service is down), poezio will mark that MUC
- room as not joined and will try to re-join it. This is useful to
- know when a MUC server crashes or becomes unavailable, because there
- is no mechanism to be informed of that fact in XMPP.
+ error of the type “not-allowed” which means the chatroom service
+ doesn’t consider us to be present in that room, or on a timeout which
+ probably means that the service is down), poezio will mark that
+ chatroom as not joined and will try to re-join it. This is useful to
+ know when a chatroom server crashes or becomes unavailable, because
+ there is no mechanism to be informed of that fact in XMPP.
A value of at least 60 seconds is recommended, to avoid sending too
many requests.
diff --git a/doc/source/keys.rst b/doc/source/keys.rst
index f1d47b91..41b71078 100644
--- a/doc/source/keys.rst
+++ b/doc/source/keys.rst
@@ -344,10 +344,10 @@ Actions list
Similar to Alt-d.
-**_server_cycle**: Cycles in the current MUC server.
+**_server_cycle**: Cycles in the current chatroom server.
- Similar to :term:`/server_cycle` in a MUC. If you are not in a MUC, you will get
- an error.
+ Similar to :term:`/server_cycle` in a chatroom. If you are not in a
+ chatroom, you will get an error.
**_show_bookmarks**: Shows the current bookmarks.
@@ -357,7 +357,7 @@ Actions list
Similar to Alt-e.
-**_show_invitations**: Shows all the pending MUC invitations.
+**_show_invitations**: Shows all the pending chatroom invitations.
Similar to :term:`/invitations`.
@@ -414,7 +414,7 @@ You only have to prefix your command line with ``_exc_``, and without the ``/``
That key binding will only work in the tabs defining the command (here, the
-MUC tab), and will show an error message in the others.
+chatroom tab), and will show an error message in the others.
Examples
~~~~~~~~
diff --git a/doc/source/misc/troubleshooting.rst b/doc/source/misc/troubleshooting.rst
index 3c79a62d..6f8f9316 100644
--- a/doc/source/misc/troubleshooting.rst
+++ b/doc/source/misc/troubleshooting.rst
@@ -34,7 +34,7 @@ Other issues
Some things may appear in ``$XDG_DATA_HOME/poezio/logs/errors.log``. (or a user-defined :term:`log_dir`/errors.log)
-.. _web client: https://jappix.com/?r=poezio@muc.poezio.eu
+.. _web client: https://jappix.com/?r=poezio@muc.poez.io
.. _mcabber: http://mcabber.com/
.. _every: https://bugs.mageia.org/show_bug.cgi?id=2156
.. _significant: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=602720
diff --git a/doc/source/plugins/index.rst b/doc/source/plugins/index.rst
index 397ffefe..ea9e13de 100644
--- a/doc/source/plugins/index.rst
+++ b/doc/source/plugins/index.rst
@@ -69,7 +69,7 @@ Plugin index
Admin
:ref:`Documentation <admin-plugin>`
- Creates convenient aliases for MUC administration.
+ Creates convenient aliases for chatroom administration.
Alias
:ref:`Documentation <alias-plugin>`
@@ -85,7 +85,7 @@ Plugin index
Close all
:ref:`Documentation <closeall-plugin>`
- Close all tabs except MUCs and the roster.
+ Close all tabs except chatrooms and the roster.
CSI
:ref:`Documentation <csi-plugin>`
@@ -173,7 +173,8 @@ Plugin index
Screen Detach
:ref:`Documentation <screendetach-plugin>`
- Changes your status to **away** if the screen (or tmux) poezio is in gets detached.
+ Changes your status to **away** if the screen (or tmux) poezio is in
+ gets detached.
Send Delayed
:ref:`Documentation <senddelayed-plugin>`
@@ -183,7 +184,8 @@ Plugin index
Simple notify
:ref:`Documentation <simplenotify-plugin>`
- Sends a notification with a command of your choice on (non-MUC) messages.
+ Sends a notification with a command of your choice on (non-chatroom)
+ messages.
Spam
:ref:`Documentation <spam-plugin>`
@@ -198,7 +200,7 @@ Plugin index
Tell
:ref:`Documentation <tell-plugin>`
- Tells a message to a nick when he connects to a MUC.
+ Sends a message to a nick when he connects to a chatroom.
Uptime
:ref:`Documentation <uptime-plugin>`
diff --git a/doc/source/usage.rst b/doc/source/usage.rst
index d74db5ed..ebe7f483 100644
--- a/doc/source/usage.rst
+++ b/doc/source/usage.rst
@@ -114,8 +114,8 @@ fold or unfold a group or a contact.
.. _muctab:
-MultiUserChat tab
-~~~~~~~~~~~~~~~~~
+Chatroom tab
+~~~~~~~~~~~~
:ref:`Specific commands <muctab-commands>`
@@ -123,10 +123,12 @@ MultiUserChat tab
:ref:`Chat shortcuts <chattab-keys>`
+.. note:: A chatroom is also called a MUC (for Multi-User-Chat) in XMPP terms.
+
This tab contains a multi-user conversation.
.. figure:: ./images/muc.png
- :alt: The MUC tab
+ :alt: The chatroom tab
#. 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
@@ -159,7 +161,7 @@ This tab contains a multi-user conversation.
The nicks have a random color given by poezio (which can be changed with :term:`/recolor`)
-#. Your information in that MUC (the name of the room, your nick, your role
+#. Your information in that chatroom (the name of the room, your nick, your role
and affiliation).
#. The topic of the room.
@@ -210,7 +212,7 @@ Dataforms tab
:ref:`Specific shortcuts <forms-keys>`
This tab lets you view a form received from a remote entity, edit the values and
-send everything back. It is mostly used to configure MUCs with the
+send everything back. It is mostly used to configure chatrooms with the
:term:`/configure` command but can actually be used for almost anything.
.. figure:: ./images/data_forms.png
@@ -228,7 +230,7 @@ List tab
:ref:`Specific shortcuts <muclisttab-keys>`
-This tab lists all public rooms on a MUC service (with the :term:`/list` command).
+This tab lists all public rooms on a chatroom service (with the :term:`/list` command).
It is currently very limited but will be improved in the future. There currently
is no way to search a room.