pep/poezio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Replace "MUC" by "chatroom" in the documentation

Browse source 
And fix some linewrapping, obsolete references to poezio.eu, and
obsolete docs.
This commit is contained in:
mathieui 2016-10-04 00:26:54 +02:00
parent c5e80b9688
commit 5a6ba4dda8
13 changed files with 85 additions and 76 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
data/default_config.cfg
View file

@ -100,7 +100,7 @@ ca_cert_path =
# Send the initial presence # Send the initial presence
# true, unless you want to be invisible from your roster # true, unless you want to be invisible from your roster
# warning: this disables any presence sending other than MUCs or directed # warning: this disables any presence sending other than chatrooms or directed
# presences via /presence # presences via /presence
#send_initial_presence = true #send_initial_presence = true
@ -298,12 +298,12 @@ use_bookmarks_method =
# shown # shown
#show_tab_numbers = true #show_tab_numbers = true
# Use the contact name, the nick in the MUC instead of the full JID to # Use the contact name, the nick in the chatroom instead of the full JID to
# display the tab if set to true. # display the tab if set to true.
#use_tab_nicks = true #use_tab_nicks = true
# If set to false, poezio will only display the user part of the JID (before # If set to false, poezio will only display the user part of the JID (before
# the @) when displaying the MUC tab name. # the @) when displaying the chatroom tab name.
#show_muc_jid = true #show_muc_jid = true
# If this option is set to false, the roster will not show the contact JIDs # If this option is set to false, the roster will not show the contact JIDs
@ -351,11 +351,11 @@ use_bookmarks_method =
# The terminal can beep on various event. Put the event you want in a list # The terminal can beep on various event. Put the event you want in a list
# (separated by spaces). # (separated by spaces).
# The events can be # The events can be
# - highlight (when you are highlighted in a MUC) # - highlight (when you are highlighted in a chatroom)
# - private (when a new private message is received, from your contacts or # - private (when a new private message is received, from your contacts or
# someone from a MUC) # someone from a chatroiom)
# - message (any message from a MUC) # - message (any message from a chatroom)
# - invite (when you receive an invitation for joining a MUC) # - invite (when you receive an invitation for joining a chatroom)
#beep_on = highlight private invite #beep_on = highlight private invite
# Theme # Theme
@ -392,25 +392,25 @@ use_bookmarks_method =
# if set to asc, they will be displayed from bottom to top. # if set to asc, they will be displayed from bottom to top.
#vertical_tab_list_sort = desc #vertical_tab_list_sort = desc
# Show the user list at the bottom when in a MUC # Show the user list at the bottom when in a chatroom
# (useful when you want to look at the bottom of the screen only) # (useful when you want to look at the bottom of the screen only)
# possible values: desc, asc # possible values: desc, asc
#user_list_sort = desc #user_list_sort = desc
# If the MUC nicks should receive a fixed color based on their text or not # If the chatroom nicks should receive a fixed color based on their text or not
#deterministic_nick_colors = true #deterministic_nick_colors = true
# If _nick, nick_, _nick_, nick__ etc. should have the same color as nick # If _nick, nick_, _nick_, nick__ etc. should have the same color as nick
#nick_color_aliases = true #nick_color_aliases = true
# The nick of people who join, part, change their status, etc. in a MUC will # The nick of people who join, part, change their status, etc. in a chatroom
# be displayed using their nick color if true. # will be displayed using their nick color if true.
#display_user_color_in_join_part = true #display_user_color_in_join_part = true
# Display user tune notifications as information messages or not # Display user tune notifications as information messages or not
#display_tune_notifications = false #display_tune_notifications = false
# Change the tab state when receiving MUC messages. # Change the tab state when receiving chatroom messages.
# useful if you are connected to a high-volume chatroom and do not # useful if you are connected to a high-volume chatroom and do not
# want it to appear in your tab bar as active. Highlights are still # want it to appear in your tab bar as active. Highlights are still
# shown. # shown.

6
doc/source/commands.rst
View file

@ -344,7 +344,7 @@ MultiUserChat tab commands
this nick. this nick.
You can also use **random** to attribute a random color. You can also use **random** to attribute a random color.
/clear [MUCTab version] /clear [Chatroom version]
**Usage:** ``/clear`` **Usage:** ``/clear``
Clear the messages buffer. Clear the messages buffer.
@ -354,7 +354,7 @@ MultiUserChat tab commands
Ignore a specified nickname. Ignore a specified nickname.
/invite [MUCTab version] /invite [Chatroom version]
**Usage:** ``/invite <jid> [reason]`` **Usage:** ``/invite <jid> [reason]``
Invite *jid* to this room with *reason* (if Invite *jid* to this room with *reason* (if
@ -395,8 +395,6 @@ MultiUserChat tab commands
**Usage:** ``/nick <nickname>`` **Usage:** ``/nick <nickname>``
Change your nickname in the current room. 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 /recolor
**Usage:** ``/recolor [random]`` **Usage:** ``/recolor [random]``

72
doc/source/configuration.rst
View file

@ -490,9 +490,10 @@ or the way messages are displayed.
**Default value:** ``true`` **Default value:** ``true``
The tabs have a name, and a nick, which is, for a contact, its name in the The tabs have a name, and a nick, which is, for a contact, its name in
roster, or for a private conversation, the nickname in the MUC. Set this to the roster, or for a private conversation, the nickname in the chatroom.
``true`` if you want to have them shown instead of the jid of the contact. Set this to ``true`` if you want to have them shown instead of the jid
of the contact.
theme theme
@ -534,8 +535,9 @@ or the way messages are displayed.
**Default value:** ``desc`` **Default value:** ``desc``
If set to ``desc``, the MUC users will be displayed from top to bottom in the list, If set to ``desc``, the chatroom users will be displayed from top to
if set to ``asc``, they will be displayed from bottom to top. bottom in the list, if set to ``asc``, they will be displayed from
bottom to top.
deterministic_nick_colors deterministic_nick_colors
@ -637,8 +639,8 @@ or the way messages are displayed.
**Default value:** ``true`` **Default value:** ``true``
If set to true, the color of the nick will be used in MUCs information If set to true, the color of the nick will be used in chatroom
messages, instead of the default color from the theme. information messages, instead of the default color from the theme.
enable_vertical_tab_list enable_vertical_tab_list
@ -708,9 +710,10 @@ or the way messages are displayed.
**Default value:** ``true`` **Default value:** ``true``
Set this to ``false`` if you want to display only the “user” part of the MUC Set this to ``false`` if you want to display only the “user” part of the
jid. E.g. if you have **poezio@muc.poezio.eu**, it will be displayed as chatroom jid. E.g. if you have **poezio@muc.poez.io**, it will be
**poezio**. This will be used only if :term:`use_tab_nicks` is set to ``true``. displayed as **poezio**. This will be used only if :term:`use_tab_nicks`
is set to ``true``.
show_roster_jids show_roster_jids
@ -785,9 +788,9 @@ or the way messages are displayed.
**Default:** ``[empty]`` **Default:** ``[empty]``
Fix a color for a nick. Whenever such a nick appears in a MUC, it will Fix a color for a nick. Whenever such a nick appears in a chatroom, it
be displayed in that color. This color won't be changed by the recolor will be displayed in that color. This color won't be changed by the
command. recolor command.
User Interaction User Interaction
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
@ -820,9 +823,10 @@ Options that change the behavior of poezio in a non-visual manner.
(separated by spaces). (separated by spaces).
The events can be The events can be
- ``highlight`` (when you are highlighted in 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 MUC) - ``private`` (when a new private message is received, from your
- ``message`` (any message from a MUC) contacts or someone from a chatroom)
- ``message`` (any message from a chatroom)
separate_history separate_history
@ -973,7 +977,7 @@ Other
Send initial presence (normal behaviour). If ``false``, you will not send nor 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 receive any presence that is not directed (through :term:`/presence`) or sent by a
MUC. chatroom.
lazy_resize lazy_resize
@ -1055,8 +1059,8 @@ found.
**Default value:** ``false`` **Default value:** ``false``
Disable the beeps triggered by this conversation. Works in MucTab, Disable the beeps triggered by this conversation. Works in chatroom
PrivateTab and ConversationTab. tabs, private messaging tabs, and conversation tabs.
display_activity_notifications display_activity_notifications
@ -1083,8 +1087,8 @@ found.
**Default value:** ``false`` **Default value:** ``false``
If set to ``true``, the color of the nick will be used in MUCs information If set to ``true``, the color of the nick will be used in chatroom
messages, instead of the default color from the theme. information messages, instead of the default color from the theme.
display_tune_notifications display_tune_notifications
@ -1178,8 +1182,8 @@ found.
**Default value:** ``true`` **Default value:** ``true``
Lets you disable/enable chatstates per-JID. Works in MucTab, PrivateTab Lets you disable/enable chatstates per-JID. Works in chatroom tabs,
and ConversationTab. private messaging tabs, and normal conversation tabs.
show_useless_separator show_useless_separator
@ -1199,24 +1203,26 @@ found.
**Default value:** ``true`` **Default value:** ``true``
Only for MUC tabs: if true the tab will change its color to notify you when a new message is received. Only for chatroom tabs: if true the tab will change its color to
You will still be notified of highlights. Set to ``false`` if you’re not interested in a room non-highlight notifications. 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 self_ping_delay
**Default value:** ``0`` **Default value:** ``0``
When this option is set to a positive value ``n``, poezio will send 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 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 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 error of the type “not-allowed” which means the chatroom service
consider us to be present in that room, or on a timeout which 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 probably means that the service is down), poezio will mark that
room as not joined and will try to re-join it. This is useful to chatroom 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 know when a chatroom server crashes or becomes unavailable, because
is no mechanism to be informed of that fact in XMPP. 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 A value of at least 60 seconds is recommended, to avoid sending too
many requests. many requests.

10
doc/source/keys.rst
View file

@ -344,10 +344,10 @@ Actions list
Similar to Alt-d. 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 Similar to :term:`/server_cycle` in a chatroom. If you are not in a
an error. chatroom, you will get an error.
**_show_bookmarks**: Shows the current bookmarks. **_show_bookmarks**: Shows the current bookmarks.
@ -357,7 +357,7 @@ Actions list
Similar to Alt-e. Similar to Alt-e.
**_show_invitations**: Shows all the pending MUC invitations. **_show_invitations**: Shows all the pending chatroom invitations.
Similar to :term:`/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 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 Examples
~~~~~~~~ ~~~~~~~~

2
doc/source/misc/troubleshooting.rst
View file

@ -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) 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/ .. _mcabber: http://mcabber.com/
.. _every: https://bugs.mageia.org/show_bug.cgi?id=2156 .. _every: https://bugs.mageia.org/show_bug.cgi?id=2156
.. _significant: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=602720 .. _significant: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=602720

12
doc/source/plugins/index.rst
View file

@ -69,7 +69,7 @@ Plugin index
Admin Admin
:ref:`Documentation <admin-plugin>` :ref:`Documentation <admin-plugin>`
Creates convenient aliases for MUC administration. Creates convenient aliases for chatroom administration.
Alias Alias
:ref:`Documentation <alias-plugin>` :ref:`Documentation <alias-plugin>`
@ -85,7 +85,7 @@ Plugin index
Close all Close all
:ref:`Documentation <closeall-plugin>` :ref:`Documentation <closeall-plugin>`
Close all tabs except MUCs and the roster. Close all tabs except chatrooms and the roster.
CSI CSI
:ref:`Documentation <csi-plugin>` :ref:`Documentation <csi-plugin>`
@ -173,7 +173,8 @@ Plugin index
Screen Detach Screen Detach
:ref:`Documentation <screendetach-plugin>` :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 Send Delayed
:ref:`Documentation <senddelayed-plugin>` :ref:`Documentation <senddelayed-plugin>`
@ -183,7 +184,8 @@ Plugin index
Simple notify Simple notify
:ref:`Documentation <simplenotify-plugin>` :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 Spam
:ref:`Documentation <spam-plugin>` :ref:`Documentation <spam-plugin>`
@ -198,7 +200,7 @@ Plugin index
Tell Tell
:ref:`Documentation <tell-plugin>` :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 Uptime
:ref:`Documentation <uptime-plugin>` :ref:`Documentation <uptime-plugin>`

14
doc/source/usage.rst
View file

@ -114,8 +114,8 @@ fold or unfold a group or a contact.
.. _muctab: .. _muctab:
MultiUserChat tab Chatroom tab
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~
:ref:`Specific commands <muctab-commands>` :ref:`Specific commands <muctab-commands>`
@ -123,10 +123,12 @@ MultiUserChat tab
:ref:`Chat shortcuts <chattab-keys>` :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. This tab contains a multi-user conversation.
.. figure:: ./images/muc.png .. figure:: ./images/muc.png
:alt: The MUC tab :alt: The chatroom tab
#. The conversation window, this is where all the messages and events #. 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 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`) 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). and affiliation).
#. The topic of the room. #. The topic of the room.
@ -210,7 +212,7 @@ Dataforms tab
:ref:`Specific shortcuts <forms-keys>` :ref:`Specific shortcuts <forms-keys>`
This tab lets you view a form received from a remote entity, edit the values and 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. :term:`/configure` command but can actually be used for almost anything.
.. figure:: ./images/data_forms.png .. figure:: ./images/data_forms.png
@ -228,7 +230,7 @@ List tab
:ref:`Specific shortcuts <muclisttab-keys>` :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 It is currently very limited but will be improved in the future. There currently
is no way to search a room. is no way to search a room.

6
plugins/close_all.py
View file

@ -1,5 +1,5 @@
""" """
``close_all`` plugin: close all tabs except MUCs and the roster. ``close_all`` plugin: close all tabs except chatrooms and the roster.
Commands Commands
-------- --------
@ -9,7 +9,7 @@ Commands
/closeall /closeall
**Usage:** ``/closeall`` **Usage:** ``/closeall``
Close all tabs except the roster and MUC tabs. Close all tabs except the roster and chatroom tabs.
""" """
from poezio.plugin import BasePlugin from poezio.plugin import BasePlugin
from poezio import tabs from poezio import tabs
@ -19,7 +19,7 @@ from poezio.decorators import command_args_parser
class Plugin(BasePlugin): class Plugin(BasePlugin):
def init(self): def init(self):
self.api.add_command('closeall', self.command_closeall, self.api.add_command('closeall', self.command_closeall,
help='Close all non-muc tabs.') help='Close all non-chatroom tabs.')
@command_args_parser.ignored @command_args_parser.ignored
def command_closeall(self): def command_closeall(self):

2
plugins/random_nick.py
View file

@ -1,5 +1,5 @@
""" """
This plugin makes you have a random nick when joining a MUC. This plugin makes you have a random nick when joining a chatroom.
Usage Usage
----- -----

2
plugins/server_part.py
View file

@ -11,7 +11,7 @@ Command
**Usage:** ``/server_part [<server> [message]]`` **Usage:** ``/server_part [<server> [message]]``
Leave all rooms on ``<server>``, if not provided and the current Leave all rooms on ``<server>``, if not provided and the current
tab is a MUC tab, it will leave all rooms on the current server. tab is a chatroom tab, it will leave all rooms on the current server.
``[message]`` can indicate a quit message. ``[message]`` can indicate a quit message.

3
plugins/tell.py
View file

@ -3,7 +3,8 @@ The command added by this plugin sends a message to someone when he next joins.
Usage Usage
----- -----
This plugin defines two new commands for MUC tabs: :term:`/tell` and :term:`/untell`. This plugin defines two new commands for chatroom tabs:
:term:`/tell`, :term:`/untell`, and :term:`/list_tell`.
.. glossary:: .. glossary::
:sorted: :sorted:

4
plugins/time_marker.py
View file

@ -3,8 +3,8 @@ Display the time between two messages.
Helps you identify the times of a conversation. For example Helps you identify the times of a conversation. For example
if you disable the timestamps, and remove the join/quit notifications in a if you disable the timestamps, and remove the join/quit notifications in a
MUC, you can’t really distinguish when a conversation stopped and when a new chatroom, you can’t really distinguish when a conversation stopped and when
one started, because you don’t have a visual separation between the two. a new one started, because you don’t have a visual separation between the two.
This plugin displays a message in the conversation indicating the time that This plugin displays a message in the conversation indicating the time that
passed between two messages, if the time is bigger than X minutes passed between two messages, if the time is bigger than X minutes

4
plugins/vcard.py
View file

@ -11,13 +11,13 @@ Command
**Usage (globally):** ``/vcard <jid>`` **Usage (globally):** ``/vcard <jid>``
**Usage (in a MUC tab):** ``/vcard <jid or nick>`` **Usage (in a chatroom tab):** ``/vcard <jid or nick>``
**Usage (in a conversation or roster tab):** ``/vcard [jid]`` **Usage (in a conversation or roster tab):** ``/vcard [jid]``
Globally, you can do ``/vcard user@server.example`` to get a vcard. Globally, you can do ``/vcard user@server.example`` to get a vcard.
In a MUC, you can either do it on a JID or a nick (``/vcard nick``, In a chatroom , you can either do it on a JID or a nick (``/vcard nick``,
``/vcard room@muc.server.example/nick`` or ``/vcard ``/vcard room@muc.server.example/nick`` or ``/vcard
user@server.example``). user@server.example``).