@@ -113,7 +114,7 @@ properly configure and integrate it into your site.
webchat experience and that you have control over the data. The latter being a
requirement for many sites dealing with sensitive information.
You’ll need to set up your own XMPP server and in order to have
-Session support (i.e. single-signon functionality whereby users are authenticated once and stay
+Session Support (i.e. single-signon functionality whereby users are authenticated once and stay
logged in to XMPP upon page reload) you will also have to add some server-side
code.
The What you will need section has more information on all these
@@ -126,7 +127,7 @@ requirements.
Converse.js implements XMPP as its messaging protocol, and therefore needs
to connect to an XMPP/Jabber server (Jabber is really just a synonym for XMPP).
You can connect to public XMPP servers like jabber.org but if you want to
-have Session support you’ll have to set up your own XMPP server.
+have
Session Support you’ll have to set up your own XMPP server.
You can find a list of public XMPP servers/providers on xmpp.net and a list of
servers that you can set up yourself on xmpp.org.
-
+
It’s possible to enable single-site login, whereby users already
authenticated in your website will also automatically be logged in on the chat server,
but this will require custom code on your server.
@@ -196,7 +197,7 @@ practical.
You’ll most likely want to implement some kind of single-signon solution for
your website, where users authenticate once in your website and then stay
logged into their XMPP session upon page reload.
-
For more info on this, read Session support.
+
For more info on this, read Session Support.
You might also want to have more fine-grained control of what gets included in
the minified Javascript file. Read Configuration and Minification for more info on how to do
that.
@@ -311,6 +312,64 @@ manager, NPM.
yui-compressor --type=css converse.css -o converse.min.css
+
+
+
+
The gettext POT file located in ./locales/converse.pot is the template
+containing all translations and from which for each language an individual PO
+file is generated.
+
The POT file contains all translateable strings extracted from converse.js.
+
To make a user facing string translateable, wrap it in the double underscore helper
+function like so:
+
__('This string will be translated at runtime');
+
+
+
After adding the string, you’ll need to regenerate the POT file, like so:
+
+
You can then create or update the PO file for a specific language by doing the following:
+
msgmerge ./locales/af/LC_MESSAGES/converse.po ./locales/converse.pot -U
+
+
This PO file is then what gets translated.
+
If you’ve created a new PO file, please make sure to add the following
+attributes at the top of the file (under Content-Transfer-Encoding). They are
+required as configuration settings for Jed, the Javascript translations library
+that we’re using.
+
"domain: converse\n"
+"lang: af\n",
+"plural_forms: nplurals=2; plural=(n != 1);\n"
+
+
+
Unfortunately 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
+language.
+
To generate JSON from a PO file, you’ll need po2json for node.js. Run the
+following command to install it (npm being the node.js package manager):
+
+
You can then convert the translations into JSON format:
+
po2json locales/af/LC_MESSAGES/converse.po locales/af/LC_MESSAGES/converse.json
+
+
Now from converse.json paste the data as a value for the “locale_data” key in the
+object in the language’s .js file.
+
So, if you are for example translating into German (language code ‘de’), you’ll
+create or update the file ./locale/LC_MESSAGES/de.js with the following code:
+
(function (root, factory) {
+ define("af", ['jed'], function () {
+ return factory(new Jed({
+ "domain": "converse",
+ "locale_data": {
+ // Paste the JSON data from converse.json here
+ }
+ })
+ }
+}(this, function (i18n) {
+ return i18n;
+}));
+
+
making sure to also paste the JSON data as value to the “locale_data” key.
+
Congratulations, you’ve now succesfully added your translations. Sorry for all
+those hoops you had to jump through.