Skip to content

C
converse.js
Commit 50f03c90 authored by JC Brand's avatar JC Brand
Browse files
Options

Write "chat room" as "chatroom" and "chat box" as chatbox" 

We have bedroom, bathroom, classroom and boardroom as one word.
Living room is spelled separately because of the present participle (+ing) in living.

With "chatbox" it's a bit more subjective.
We have chatbot as one word (but litter box as two).
For consistency with chatroom, I'll go with one word.
parent 055a8548
Hide whitespace changes
Inline Side-by-side
Showing with 74 additions and 72 deletions
docs/source/configuration.rst
View file @ 50f03c90
......@@ -6,7 +6,7 @@
Configuration
=============
The included minified JS and CSS files can be used for demoing or testing, but
The included minified JavaScript and CSS files can be used for demoing or testing, but
you'll want to configure *Converse.js* to suit your needs before you deploy it
on your website.
......@@ -19,7 +19,7 @@ Please refer to the `Configuration settings`_ section below for info on
all the available configuration settings.
After you have configured *Converse.js*, you'll have to regenerate the minified
JS file so that it will include the new settings. Please refer to the
JavaScript file so that it will include the new settings. Please refer to the
:ref:`minification` section for more info on how to do this.
.. _`configuration-settings`:
......@@ -133,7 +133,7 @@ allow_contact_removal
* Default: ``true``
Allow the user to remove roster contacts by clicking on the delete icon
(i.e. traschcan) next to a contact's name in the roster.
(i.e. trashcan) next to a contact's name in the roster.
allow_contact_requests
----------------------
......@@ -151,7 +151,7 @@ allow_dragresize
* Default: ``true``
Allow users to resize chats by dragging the edges. The min-height and min-width
CSS properties set on a chat boxes (specifically on the ``#converse.js .chatbox > .box-flyout`` element)
CSS properties set on a chatboxes (specifically on the ``#converse.js .chatbox > .box-flyout`` element)
will be honored, IF they are set in pixels.
allow_muc
......@@ -167,9 +167,9 @@ allow_muc_invitations
* Default: ``true``
Allows users to be invited to join MUC chat rooms. An "Invite" widget will
appear in the sidebar of the chat room where you can type in the JID of a user
to invite into the chat room.
Allows users to be invited to join MUC chatrooms. An "Invite" widget will
appear in the sidebar of the chatroom where you can type in the JID of a user
to invite into the chatroom.
.. _`allow_non_roster_messaging`:
......@@ -224,7 +224,7 @@ animate
* Default: ``true``
Show animations, for example when opening and closing chat boxes.
Show animations, for example when opening and closing chatboxes.
archived_messages_page_size
---------------------------
......@@ -237,10 +237,10 @@ This feature applies to `XEP-0313: Message Archive Management (MAM) <https://xmp
and will only take effect if your server supports MAM.
It allows you to specify the maximum amount of archived messages to be returned per query.
When you open a chat box or room, archived messages will be displayed (if
When you open a chatbox or room, archived messages will be displayed (if
available) and the amount returned will be no more than the page size.
You will be able to query for even older messages by scrolling upwards in the chat box or room
You will be able to query for even older messages by scrolling upwards in the chatbox or room
(the so-called infinite scrolling pattern).
auto_list_rooms
......@@ -251,7 +251,7 @@ auto_list_rooms
If true, and the XMPP server on which the current user is logged in supports
multi-user chat, then a list of rooms on that server will be fetched.
Not recommended for servers with lots of chat rooms.
Not recommended for servers with lots of chatrooms.
For each room on the server a query is made to fetch further details (e.g.
features, number of occupants etc.), so on servers with many rooms this
......@@ -941,15 +941,15 @@ muc_history_max_stanzas
* Default: ``undefined``
This option allows you to specify the maximum amount of messages to be shown in a
chat room when you enter it. By default, the amount specified in the room
chatroom when you enter it. By default, the amount specified in the room
configuration or determined by the server will be returned.
Please note, this option is not related to
`XEP-0313 Message Archive Management <https://xmpp.org/extensions/xep-0313.html>`_,
which also allows you to show archived chat room messages, but follows a
which also allows you to show archived chatroom messages, but follows a
different approach.
If you're using MAM for archiving chat room messages, you might want to set
If you're using MAM for archiving chatroom messages, you might want to set
this option to zero.
muc_instant_rooms
......@@ -971,9 +971,9 @@ muc_nickname_from_jid
* Default: ``false``
When set to ``true``, then users will not be prompted to provide nicknames for
chat rooms. Instead, the node part of a user's JID (i.e. JID = node@domain/resource)
chatrooms. Instead, the node part of a user's JID (i.e. JID = node@domain/resource)
will be used. If the user's nickname is already taken by another user in the
chat room, then an integer will be added to make it unique.
chatroom, then an integer will be added to make it unique.
So, for example, if john@example.com joins a chatroom, his nickname will
automatically be "john". If now john@differentdomain.com tries to join the
......@@ -985,7 +985,7 @@ muc_show_join_leave
* Default; ``true``
Determines whether Converse.js will show info messages inside a chat room
Determines whether Converse.js will show info messages inside a chatroom
whenever a user joins or leaves it.
notify_all_room_messages
......@@ -1028,7 +1028,7 @@ play_sounds
* Default: ``false``
Plays a notification sound when you receive a personal message or when your
nickname is mentioned in a chat room.
nickname is mentioned in a chatroom.
Inside the ``./sounds`` directory of the Converse.js repo you'll see MP3 and Ogg
formatted sound files. We need both, because neither format is supported by all browsers.
......@@ -1310,7 +1310,7 @@ use_otr_by_default
* Default: ``false``
If set to ``true``, Converse.js will automatically try to initiate an OTR (off-the-record)
encrypted chat session every time you open a chat box.
encrypted chat session every time you open a chatbox.
use_vcards
----------
......@@ -1335,7 +1335,7 @@ visible_toolbar_buttons
toggle_occupants: true
}
Allows you to show or hide buttons on the chat boxes' toolbars.
Allows you to show or hide buttons on the chatboxes' toolbars.
* *call*:
Provides a button with a picture of a telephone on it.
......@@ -1349,11 +1349,11 @@ Allows you to show or hide buttons on the chat boxes' toolbars.
// ... Third-party library code ...
});
* *clear*:
Provides a button for clearing messages from a chat box.
Provides a button for clearing messages from a chatbox.
* *emoji*:
Enables rendering of emoji and provides a toolbar button for choosing them.
* *toggle_occupants*:
Shows a button for toggling (i.e. showing/hiding) the list of occupants in a chat room.
Shows a button for toggling (i.e. showing/hiding) the list of occupants in a chatroom.
.. _`websocket-url`:
......@@ -1519,7 +1519,9 @@ xhr_user_search
There are two ways to add users.
* The user inputs a valid JID (Jabber ID), and the user is added as a pending contact.
* The user inputs some text (for example part of a firstname or lastname), an XHR (Ajax Request) will be made to a remote server, and a list of matches are returned. The user can then choose one of the matches to add as a contact.
* The user inputs some text (for example part of a first name or last name),
an XHR (Ajax Request) will be made to a remote server, and a list of matches are returned.
The user can then choose one of the matches to add as a contact.
This setting enables the second mechanism, otherwise by default the first will be used.
......
docs/source/developer_api.rst
View file @ 50f03c90
......@@ -751,35 +751,35 @@ You may also provide the fullname. If not present, we use the jid as fullname:
The **chats** grouping
----------------------
Note, for MUC chat rooms, you need to use the "rooms" grouping instead.
Note, for MUC chatrooms, you need to use the "rooms" grouping instead.
get
~~~
Returns an object representing a chat box. The chat box should already be open.
Returns an object representing a chatbox. The chatbox should already be open.
To return a single chat box, provide the JID of the contact you're chatting
with in that chat box:
To return a single chatbox, provide the JID of the contact you're chatting
with in that chatbox:
.. code-block:: javascript
_converse.api.chats.get('buddy@example.com')
To return an array of chat boxes, provide an array of JIDs:
To return an array of chatboxes, provide an array of JIDs:
.. code-block:: javascript
_converse.api.chats.get(['buddy1@example.com', 'buddy2@example.com'])
To return all open chat boxes, call the method without any JIDs::
To return all open chatboxes, call the method without any JIDs::
_converse.api.chats.get()
open
~~~~
Opens a chat box and returns a `Backbone.View <http://backbonejs.org/#View>`_ object
representing a chat box.
Opens a chatbox and returns a `Backbone.View <http://backbonejs.org/#View>`_ object
representing a chatbox.
Note that converse doesn't allow opening chats with users who aren't in your roster
(unless you have set :ref:`allow_non_roster_messaging` to ``true``).
......@@ -787,13 +787,13 @@ Note that converse doesn't allow opening chats with users who aren't in your ros
Before opening a chat, you should first wait until the roster has been populated.
This is the :ref:`rosterContactsFetched` event/promise.
Besides that, it's a good idea to also first wait until already opened chat boxes
Besides that, it's a good idea to also first wait until already opened chatboxes
(which are cached in sessionStorage) have also been fetched from the cache.
This is the :ref:`chatBoxesFetched` event/promise.
These two events fire only once per session, so they're also available as promises.
So, to open a single chat box:
So, to open a single chatbox:
.. code-block:: javascript
......@@ -810,7 +810,7 @@ So, to open a single chat box:
}
});
To return an array of chat boxes, provide an array of JIDs:
To return an array of chatboxes, provide an array of JIDs:
.. code-block:: javascript
......@@ -828,14 +828,14 @@ To return an array of chat boxes, provide an array of JIDs:
});
*The returned chat box object contains the following methods:*
*The returned chatbox object contains the following methods:*
+-------------------+------------------------------------------+
| Method | Description |
+===================+==========================================+
| close | Close the chat box. |
| close | Close the chatbox. |
+-------------------+------------------------------------------+
| focus | Focuses the chat box textarea |
| focus | Focuses the chatbox textarea |
+-------------------+------------------------------------------+
| model.endOTR | End an OTR (Off-the-record) session. |
+-------------------+------------------------------------------+
......@@ -843,13 +843,13 @@ To return an array of chat boxes, provide an array of JIDs:
+-------------------+------------------------------------------+
| model.initiateOTR | Start an OTR (off-the-record) session. |
+-------------------+------------------------------------------+
| model.maximize | Minimize the chat box. |
| model.maximize | Minimize the chatbox. |
+-------------------+------------------------------------------+
| model.minimize | Maximize the chat box. |
| model.minimize | Maximize the chatbox. |
+-------------------+------------------------------------------+
| model.set | Set an attribute (i.e. mutator). |
+-------------------+------------------------------------------+
| show | Opens/shows the chat box. |
| show | Opens/shows the chatbox. |
+-------------------+------------------------------------------+
*The get and set methods can be used to retrieve and change the following attributes:*
......@@ -857,9 +857,9 @@ To return an array of chat boxes, provide an array of JIDs:
+-------------+-----------------------------------------------------+
| Attribute | Description |
+=============+=====================================================+
| height | The height of the chat box. |
| height | The height of the chatbox. |
+-------------+-----------------------------------------------------+
| url | The URL of the chat box heading. |
| url | The URL of the chatbox heading. |
+-------------+-----------------------------------------------------+
.. _`listen-grouping`:
......@@ -929,7 +929,7 @@ The **rooms** grouping
get
~~~
Returns an object representing a multi user chat box (room).
Returns an object representing a multi user chatbox (room).
It takes 3 parameters:
* the room JID (if not specified, all rooms will be returned).
......@@ -961,7 +961,7 @@ It takes 3 parameters:
open
~~~~
Opens a multi user chat box and returns an object representing it.
Opens a multi user chatbox and returns an object representing it.
Similar to the ``chats.get`` API.
It takes 2 parameters:
......@@ -970,7 +970,7 @@ It takes 2 parameters:
* A map (object) containing any extra room attributes. For example, if you want
to specify the nickname, use ``{'nick': 'bloodninja'}``.
To open a single multi user chat box, provide the JID of the room:
To open a single multi user chatbox, provide the JID of the room:
.. code-block:: javascript
......@@ -1056,8 +1056,8 @@ For example, opening a room with a specific default configuration:
close
~~~~~
Lets you close open chat rooms. You can call this method without any arguments
to close all open chat rooms, or you can specify a single JID or an array of
Lets you close open chatrooms. You can call this method without any arguments
to close all open chatrooms, or you can specify a single JID or an array of
JIDs.
.. _`promises-grouping`:
......
docs/source/events.rst
View file @ 50f03c90
......@@ -50,7 +50,7 @@ Here follows the different events that are emitted:
afterMessagesFetched
~~~~~~~~~~~~~~~~~~~~
Emitted whenever a chat box has fetched its messages from ``sessionStorage`` and
Emitted whenever a chatbox has fetched its messages from ``sessionStorage`` and
**NOT** from the server.
This event is listened to by the ``converse-mam`` plugin to know when it can
......@@ -83,7 +83,7 @@ See also the `roster`_ event further down.
callButtonClicked
~~~~~~~~~~~~~~~~~
When a call button (i.e. with class .toggle-call) on a chat box has been clicked.
When a call button (i.e. with class .toggle-call) on a chatbox has been clicked.
``_converse.on('callButtonClicked', function (connection, model) { ... });``
......@@ -92,10 +92,10 @@ When a call button (i.e. with class .toggle-call) on a chat box has been clicked
chatBoxesFetched
~~~~~~~~~~~~~~~~
Any open chat boxes (from this current session) has been retrieved from the local cache (`sessionStorage`).
Any open chatboxes (from this current session) has been retrieved from the local cache (`sessionStorage`).
You should wait for this event or promise before attempting to do things
related to open chat boxes.
related to open chatboxes.
``_converse.on('chatBoxesFetched', function (items) { ... });``
......@@ -110,42 +110,42 @@ Also available as an `ES2015 Promise <http://es6-features.org/#PromiseUsage>`_:
chatBoxInitialized
~~~~~~~~~~~~~~~~~~
When a chat box has been initialized. Relevant to converse-chatview.js plugin.
When a chatbox has been initialized. Relevant to converse-chatview.js plugin.
``_converse.on('chatBoxInitialized', function (chatbox) { ... });``
chatBoxOpened
~~~~~~~~~~~~~
When a chat box has been opened. Relevant to converse-chatview.js plugin.
When a chatbox has been opened. Relevant to converse-chatview.js plugin.
``_converse.on('chatBoxOpened', function (chatbox) { ... });``
chatRoomOpened
~~~~~~~~~~~~~~
When a chat room has been opened. Relevant to converse-chatview.js plugin.
When a chatroom has been opened. Relevant to converse-chatview.js plugin.
``_converse.on('chatRoomOpened', function (chatbox) { ... });``
chatBoxClosed
~~~~~~~~~~~~~
When a chat box has been closed. Relevant to converse-chatview.js plugin.
When a chatbox has been closed. Relevant to converse-chatview.js plugin.
``_converse.on('chatBoxClosed', function (chatbox) { ... });``
chatBoxFocused
~~~~~~~~~~~~~~
When the focus has been moved to a chat box. Relevant to converse-chatview.js plugin.
When the focus has been moved to a chatbox. Relevant to converse-chatview.js plugin.
``_converse.on('chatBoxFocused', function (chatbox) { ... });``
chatBoxToggled
~~~~~~~~~~~~~~
When a chat box has been minimized or maximized. Relevant to converse-chatview.js plugin.
When a chatbox has been minimized or maximized. Relevant to converse-chatview.js plugin.
``_converse.on('chatBoxToggled', function (chatbox) { ... });``
......@@ -239,15 +239,15 @@ The user has logged out.
messageAdded
~~~~~~~~~~~~
Once a message has been added to a chat box. The passed in data object contains
a `chatbox` attribute, referring to the chat box receiving the message, as well
Once a message has been added to a chatbox. The passed in data object contains
a `chatbox` attribute, referring to the chatbox receiving the message, as well
as a `message` attribute which refers to the Message model.
.. code-block:: javascript
_converse.on('messageAdded', function (data) {
// The message is at `data.message`
// The original chat box is at `data.chatbox`.
// The original chatbox is at `data.chatbox`.
});
messageSend
......
docs/source/features.rst
View file @ 50f03c90
......@@ -69,17 +69,17 @@ Languages increase the size of the Converse.js significantly.
If you only need one, or a subset of the available languages, it's better to
make a custom build which includes only those languages that you need.
Moderating chat rooms
=====================
Moderating chatrooms
====================
Here are the different commands that may be used to moderate a chat room:
Here are the different commands that may be used to moderate a chatroom:
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| Event Type | When is it triggered? | Example (substitue $nickname with an actual user's nickname) |
+============+==============================================================================================+===============================================================+
| **ban** | Ban a user from the chat room. They will not be able to join again. | /ban $nickname |
| **ban** | Ban a user from the chatroom. They will not be able to join again. | /ban $nickname |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| **clear** | Clear the messages shown in the chat room. | /clear |
| **clear** | Clear the messages shown in the chatroom. | /clear |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| **deop** | Make a moderator a normal occupant. | /deop $nickname [$reason] |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
......@@ -95,7 +95,7 @@ Here are the different commands that may be used to moderate a chat room:
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| **op** | Make a normal occupant a moderator. | /op $nickname [$reason] |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| **topic** | Set the topic of the chat room. | /topic ${topic text} |
| **topic** | Set the topic of the chatroom. | /topic ${topic text} |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| **voice** | Allow a muted user to post messages to the room. | /voice $nickname [$reason] |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
......
docs/source/manual.rst
View file @ 50f03c90
......@@ -168,7 +168,7 @@ A normal contact
If the person accepts your contact request, they will get a *chat status
indicator* in your roster and will also become clickable. Clicking on the name
of the user will open a chat box in which you can then start chatting with that
of the user will open a chatbox in which you can then start chatting with that
user.
.. figure:: images/remove-contact.png
......
docs/source/other_frameworks.rst
View file @ 50f03c90
......@@ -52,7 +52,7 @@ Below is an example code that wraps converse.js as an angular.js service.
// file src/locales.js to include only those
// translations that you care about.
"converse-chatview", // Renders standalone chat boxes for single user chat
"converse-chatview", // Renders standalone chatboxes for single user chat
"converse-controlbox", // The control box
"converse-bookmarks", // XEP-0048 Bookmarks
"converse-mam", // XEP-0313 Message Archive Management
......@@ -62,8 +62,8 @@ Below is an example code that wraps converse.js as an angular.js service.
"converse-register", // XEP-0077 In-band registration
"converse-ping", // XEP-0199 XMPP Ping
"converse-notification", // HTML5 Notifications
"converse-minimize", // Allows chat boxes to be minimized
"converse-dragresize", // Allows chat boxes to be resized by dragging them
"converse-minimize", // Allows chatboxes to be minimized
"converse-dragresize", // Allows chatboxes to be resized by dragging them
"converse-headline", // Support for headline messages
// END: Removable components
......
docs/source/plugin_development.rst
View file @ 50f03c90
......@@ -340,7 +340,7 @@ method of the plugin:
});
In this case, the plugin waits for the ``chatBoxOpened`` event, before it then
calls ``renderMinimizeButton``, which adds a new button to the chat box (which
calls ``renderMinimizeButton``, which adds a new button to the chatbox (which
enables you to minimize it).
Finding the right promises and/or events to listen to, can be a bit
......
docs/source/quickstart.rst
View file @ 50f03c90
......@@ -100,7 +100,7 @@ Headless build
There is also the option of making a headless build of converse.js.
This means a build without any UI but still containing core functionality of
maintaining a roster, chat boxes and messages.
maintaining a roster, chatboxes and messages.
The file `src/headless.js <https://github.com/jcbrand/converse.js/blob/master/src/headless.js>`_
is used to determine which plugins are included in the build.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7