in your browser, and the tests will run automatically.
in your browser, and the tests will run automatically.
...
@@ -470,7 +470,7 @@ allow_contact_requests
...
@@ -470,7 +470,7 @@ allow_contact_requests
Default = ``true``
Default = ``true``
Allow users to add one another as contacts. If this is set to false, the
Allow users to add one another as contacts. If this is set to false, the
**Add a contact** widget, **Contact Requests** and **Pending Contacts** roster
**Add a contact** widget, **Contact Requests** and **Pending Contacts** roster
sections will all not appear. Additionally, all incoming contact requests will be
sections will all not appear. Additionally, all incoming contact requests will be
ignored.
ignored.
...
@@ -501,7 +501,7 @@ multi-user chat, then a list of rooms on that server will be fetched.
...
@@ -501,7 +501,7 @@ 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 chat rooms.
For each room on the server a query is made to fetch further details (e.g.
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
features, number of occupants etc.), so on servers with many rooms this
option will create lots of extra connection traffic.
option will create lots of extra connection traffic.
auto_subscribe
auto_subscribe
...
@@ -558,7 +558,7 @@ already authenticated (usually on the backend before page load).
...
@@ -558,7 +558,7 @@ already authenticated (usually on the backend before page load).
This is useful when you don't want to render the login form on the chat control
This is useful when you don't want to render the login form on the chat control
box with each page load.
box with each page load.
For prebinding to work, your backend server must authenticate for you, and
For prebinding to work, your backend server must authenticate for you, and
then return a JID (jabber ID), SID (session ID) and RID (Request ID).
then return a JID (jabber ID), SID (session ID) and RID (Request ID).
If you set ``prebind`` to ``true``, you have to make sure to also pass in these
If you set ``prebind`` to ``true``, you have to make sure to also pass in these
...
@@ -589,18 +589,64 @@ Default = ``false``
...
@@ -589,18 +589,64 @@ Default = ``false``
If set to ``true``, only online users will be shown in the contacts roster.
If set to ``true``, only online users will be shown in the contacts roster.
Users with any other status (e.g. away, busy etc.) will not be shown.
Users with any other status (e.g. away, busy etc.) will not be shown.
xhr_custom_status
-----------------
Default = ``false``
Note::
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
This option will let converse.js make an AJAX POST with your changed custom chat status to a
remote server.
xhr_custom_status_url
---------------------
Note::
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
Default = Empty string
Used only in conjunction with ``xhr_custom_status``.
This is the URL to which the AJAX POST request to set the user's custom status
message will be made.
The message itself is sent in the request under the key ``msg``.
xhr_user_search
xhr_user_search
---------------
---------------
Default = ``false``
Default = ``false``
There are two ways to add users.
Note::
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
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 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 will be made to a backend, 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 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.
This setting enables the second mechanism, otherwise by default the first will be used.
*What is expected from the remote server?*
A default JSON encoded list of objects must be returned. Each object
corresponds to a matched user and needs the keys ``id`` and ``fullname``.
xhr_user_search_url
-------------------
This setting enables the second mechanism, otherwise by default the first will
Note::
be used.
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
Default = Empty string
Used only in conjunction with ``xhr_user_search``.
This is the URL to which an AJAX GET request will be made to fetch user data from your remote server.
The query string will be included in the request with ``q`` as its key.
============
============
Minification
Minification
...
@@ -614,7 +660,7 @@ all development dependencies (long story short, you can run ``npm install``
...
@@ -614,7 +660,7 @@ all development dependencies (long story short, you can run ``npm install``
and then ``grunt fetch``).
and then ``grunt fetch``).
We use `require.js`_ to keep track of *Converse.js* and its dependencies and to
We use `require.js`_ to keep track of *Converse.js* and its dependencies and to
to bundle them together in a single minified file fit for deployment to a
to bundle them together in a single minified file fit for deployment to a
production site.
production site.
To minify the Javascript and CSS, run the following command:
To minify the Javascript and CSS, run the following command:
...
@@ -635,7 +681,7 @@ CSS is minified via `cssmin <https://github.com/gruntjs/grunt-contrib-cssmin>`_.
...
@@ -635,7 +681,7 @@ CSS is minified via `cssmin <https://github.com/gruntjs/grunt-contrib-cssmin>`_.
Translations
Translations
============
============
.. Note ::
.. Note ::
Translations take up a lot of space and will bloat your minified file.
Translations take up a lot of space and will bloat your minified file.
At the time of writing, all the translations add about 50KB of extra data to
At the time of writing, all the translations add about 50KB of extra data to
the minified javascript file. Therefore, make sure to only
the minified javascript file. Therefore, make sure to only
...
@@ -686,9 +732,9 @@ that we're using.
...
@@ -686,9 +732,9 @@ that we're using.
"domain: converse\n"
"domain: converse\n"
"lang: de\n"
"lang: de\n"
"plural_forms: nplurals=2; plural=(n != 1);\n"
"plural_forms: nplurals=2; plural=(n != 1);\n"
Unfortunately `Jed <http://slexaxton.github.io/Jed>`_ cannot use the PO files directly. We have to generate from it
Unfortunately `Jed <http://slexaxton.github.io/Jed>`_ cannot use the PO files directly. We have to generate from it
a file in JSON format and then put that in a .js file for the specific
a file in JSON format and then put that in a .js file for the specific
language.
language.
...
@@ -698,7 +744,7 @@ following command to install it (npm being the node.js package manager):
...
@@ -698,7 +744,7 @@ following command to install it (npm being the node.js package manager):
::
::
npm install po2json
npm install po2json
You can then convert the translations into JSON format:
You can then convert the translations into JSON format:
::
::
...
@@ -722,13 +768,13 @@ create or update the file ./locale/LC_MESSAGES/de.js with the following code:
...
@@ -722,13 +768,13 @@ create or update the file ./locale/LC_MESSAGES/de.js with the following code:
}
}
})
})
}
}
}(this, function (i18n) {
}(this, function (i18n) {
return i18n;
return i18n;
}));
}));
making sure to also paste the JSON data as value to the "locale_data" key.
making sure to also paste the JSON data as value to the "locale_data" key.
.. Note ::
.. Note ::
If you are adding translations for a new language that is not already supported,
If you are adding translations for a new language that is not already supported,
you'll have to make one more edit in ./locale/locales.js to make sure the
you'll have to make one more edit in ./locale/locales.js to make sure the
