Chapril/xmpp.chapril.org-conversejs
Chapril/xmpp.chapril.org-conversejs
25
0
Fork 0
Code Issues Pull Requests Projects Releases Activity
3110cda38b
xmpp.chapril.org-conversejs/docs/html/index.html

623 lines
40 KiB
HTML
Raw Normal View History

Add initial documentation
2013-04-26 21:01:39 +02:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
Regenerated docs
2013-08-16 11:27:29 +02:00
<title>Quickstart (to get a demo up and running) &mdash; Converse.js 0.5.3 documentation</title>
Add initial documentation
2013-04-26 21:01:39 +02:00
Add a custom sphinx theme Makes the docs look similar to the main site
2013-04-26 21:49:26 +02:00
<link rel="stylesheet" href="_static/stylesheet.css" type="text/css" />
Add initial documentation
2013-04-26 21:01:39 +02:00
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
Regenerated docs
2013-08-16 11:27:29 +02:00
VERSION: '0.5.3',
Add initial documentation
2013-04-26 21:01:39 +02:00
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
Regenerated docs
2013-08-16 11:27:29 +02:00
<link rel="top" title="Converse.js 0.5.3 documentation" href="#" />
Add initial documentation
2013-04-26 21:01:39 +02:00
</head>
<body>
Add a custom sphinx theme Makes the docs look similar to the main site
2013-04-26 21:49:26 +02:00
<div id="header_wrap" class="outer">
<header class="inner">
<a id="forkme_banner" href="https://github.com/jcbrand/converse.js">View on GitHub</a>
<h1 id="project_title"><a href="http://conversejs.org">Converse.js</a></h1>
<h2 id="project_tagline">Documentation</h2>
<section id="downloads">
<a class="zip_download_link" href="https://github.com/jcbrand/converse.js/zipball/master">Download this project as a .zip file</a>
<a class="tar_download_link" href="https://github.com/jcbrand/converse.js/tarball/master">Download this project as a tar.gz file</a>
</section>
</header>
</div>
<div id="main_content_wrap" class="outer">
Add initial documentation
2013-04-26 21:01:39 +02:00
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
Regenerated docs
2013-08-16 11:27:29 +02:00
<li><a href="#">Converse.js 0.5.3 documentation</a> &raquo;</li>
Add initial documentation
2013-04-26 21:01:39 +02:00
</ul>
Add a custom sphinx theme Makes the docs look similar to the main site
2013-04-26 21:49:26 +02:00
</div>
<section id="main_content" class="inner">
Add initial documentation
2013-04-26 21:01:39 +02:00
<div class="document">
<div class="documentwrapper">
<div class="body">
Add a custom sphinx theme Makes the docs look similar to the main site
2013-04-26 21:49:26 +02:00
<div class="toctree-wrapper compound">
Add initial documentation
2013-04-26 21:01:39 +02:00
<ul class="simple">
</ul>
</div>
<div class="contents local topic" id="table-of-contents">
<p class="topic-title first">Table of Contents</p>
<ul class="simple">
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
<li><a class="reference internal" href="#quickstart-to-get-a-demo-up-and-running" id="id2">Quickstart (to get a demo up and running)</a></li>
<li><a class="reference internal" href="#introduction" id="id3">Introduction</a></li>
<li><a class="reference internal" href="#what-you-will-need" id="id4">What you will need</a><ul>
<li><a class="reference internal" href="#an-xmpp-jabber-server" id="id5">An XMPP/Jabber server</a></li>
<li><a class="reference internal" href="#connection-manager" id="id6">Connection Manager</a><ul>
<li><a class="reference internal" href="#overcoming-cross-domain-request-restrictions" id="id7">Overcoming cross-domain request restrictions</a></li>
Update the docs with info on connection managers etc.
2013-05-17 12:48:05 +02:00
</ul>
</li>
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
<li><a class="reference internal" href="#server-side-authentication" id="id8">Server-side authentication</a><ul>
<li><a class="reference internal" href="#pre-binding-and-single-session-support" id="id9">Pre-binding and Single Session Support</a></li>
Update the docs with info on connection managers etc.
2013-05-17 12:48:05 +02:00
</ul>
</li>
Add info on facebook integration
2013-08-13 11:19:40 +02:00
<li><a class="reference internal" href="#facebook-integration" id="id10">Facebook integration</a></li>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
</ul>
</li>
Add info on facebook integration
2013-08-13 11:19:40 +02:00
<li><a class="reference internal" href="#development" id="id11">Development</a><ul>
<li><a class="reference internal" href="#install-node-js-and-development-dependencies" id="id12">Install Node.js and development dependencies</a></li>
<li><a class="reference internal" href="#install-3rd-party-dependencies" id="id13">Install 3rd party dependencies</a></li>
<li><a class="reference internal" href="#with-amd-and-require-js-recommended" id="id14">With AMD and require.js (recommended)</a></li>
<li><a class="reference internal" href="#without-amd-and-require-js" id="id15">Without AMD and require.js</a></li>
<li><a class="reference internal" href="#before-submitting-a-pull-request" id="id16">Before submitting a pull request</a><ul>
<li><a class="reference internal" href="#add-tests-for-your-bugfix-or-feature" id="id17">Add tests for your bugfix or feature</a></li>
<li><a class="reference internal" href="#check-that-the-tests-pass" id="id18">Check that the tests pass</a></li>
<li><a class="reference internal" href="#check-your-code-for-errors-or-bad-habits-by-running-jshint" id="id19">Check your code for errors or bad habits by running JSHint</a></li>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
</ul>
</li>
</ul>
</li>
Add info on facebook integration
2013-08-13 11:19:40 +02:00
<li><a class="reference internal" href="#configuration" id="id20">Configuration</a><ul>
<li><a class="reference internal" href="#configuration-variables" id="id21">Configuration variables</a><ul>
<li><a class="reference internal" href="#animate" id="id22">animate</a></li>
<li><a class="reference internal" href="#auto-list-rooms" id="id23">auto_list_rooms</a></li>
<li><a class="reference internal" href="#auto-subscribe" id="id24">auto_subscribe</a></li>
<li><a class="reference internal" href="#bosh-service-url" id="id25">bosh_service_url</a></li>
Update docs to mention new way to minify. Fixes #39
2013-08-20 22:53:19 +02:00
<li><a class="reference internal" href="#debug" id="id26">debug</a></li>
<li><a class="reference internal" href="#fullname" id="id27">fullname</a></li>
<li><a class="reference internal" href="#hide-muc-server" id="id28">hide_muc_server</a></li>
<li><a class="reference internal" href="#prebind" id="id29">prebind</a></li>
<li><a class="reference internal" href="#show-controlbox-by-default" id="id30">show_controlbox_by_default</a></li>
<li><a class="reference internal" href="#xhr-user-search" id="id31">xhr_user_search</a></li>
Add initial documentation
2013-04-26 21:01:39 +02:00
</ul>
</li>
</ul>
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
</li>
Update docs to mention new way to minify. Fixes #39
2013-08-20 22:53:19 +02:00
<li><a class="reference internal" href="#minification" id="id32">Minification</a><ul>
<li><a class="reference internal" href="#minifying-javascript-and-css" id="id33">Minifying Javascript and CSS</a></li>
Update docs with info on tests
2013-07-29 23:22:41 +02:00
</ul>
</li>
Add info on facebook integration
2013-08-13 11:19:40 +02:00
<li><a class="reference internal" href="#translations" id="id34">Translations</a></li>
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
</ul>
</div>
<div class="section" id="quickstart-to-get-a-demo-up-and-running">
<h1><a class="toc-backref" href="#id2">Quickstart (to get a demo up and running)</a><a class="headerlink" href="#quickstart-to-get-a-demo-up-and-running" title="Permalink to this headline"></a></h1>
<p>When you download a specific release of <em>Converse.js</em> there will be two minified files inside the zip file.</p>
<ul class="simple">
<li>converse.min.js</li>
<li>converse.min.css</li>
</ul>
<p>You can include these two files inside the <em>&lt;head&gt;</em> element of your website via the <em>script</em> and <em>link</em>
tags:</p>
<div class="highlight-python"><pre>&lt;link rel="stylesheet" type="text/css" media="screen" href="converse.min.css"&gt;
&lt;script src="converse.min.js"&gt;&lt;/script&gt;</pre>
</div>
Extend docs with info on the HTML snippet converse expects. updates #31
2013-08-12 10:37:13 +02:00
<p>You need to initialize Converse.js with configuration settings particular to
your requirements.</p>
<p>Please refer to the <a class="reference internal" href="#configuration-variables">Configuration variables</a> section further below for info on
all the available configuration settings.</p>
<p>To do this, put the following inline Javascript code at the
bottom of your page (after the closing <em>&lt;/body&gt;</em> element).</p>
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
<div class="highlight-python"><pre>require(['converse'], function (converse) {
converse.initialize({
auto_list_rooms: false,
auto_subscribe: false,
bosh_service_url: 'https://bind.opkode.im', // Please use this connection manager only for testing purposes
hide_muc_server: false,
i18n: locales.en, // Refer to ./locale/locales.js to see which locales are supported
prebind: false,
show_controlbox_by_default: true,
xhr_user_search: false
});
});</pre>
</div>
Extend docs with info on the HTML snippet converse expects. updates #31
2013-08-12 10:37:13 +02:00
<p>Finally, Converse.js requires a special snippet of HTML markup to be included in your page:</p>
<div class="highlight-python"><pre>&lt;div id="chatpanel"&gt;
&lt;div id="collective-xmpp-chat-data"&gt;&lt;/div&gt;
&lt;div id="toggle-controlbox"&gt;
&lt;a href="#" class="chat toggle-online-users"&gt;
&lt;strong class="conn-feedback"&gt;Toggle chat&lt;/strong&gt; &lt;strong style="display: none" id="online-count"&gt;(0)&lt;/strong&gt;
&lt;/a&gt;
&lt;/div&gt;
&lt;/div&gt;</pre>
</div>
<p>The <a class="reference external" href="https://github.com/jcbrand/converse.js/blob/master/index.html">index.html</a> file inside the
Converse.js repository serves as a nice usable example of this.</p>
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
<p>These minified files provide the same demo-like functionality as is available
on the <a class="reference external" href="http://conversejs.org">conversejs.org</a> website. Useful for testing or demoing, but not very
practical.</p>
<p>You&#8217;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.</p>
<p>For more info on this, read: <a class="reference internal" href="#pre-binding-and-single-session-support">Pre-binding and Single Session Support</a>.</p>
<p>You might also want to have more fine-grained control of what gets included in
the minified Javascript file. Read <a class="reference internal" href="#configuration">Configuration</a> and <a class="reference internal" href="#minification">Minification</a> for more info on how to do
that.</p>
Add initial documentation
2013-04-26 21:01:39 +02:00
</div>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
<div class="section" id="introduction">
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
<h1><a class="toc-backref" href="#id3">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline"></a></h1>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
<p>Even though you can connect to public XMPP servers on the <a class="reference external" href="http://conversejs.org">conversejs.org</a>
Small updates to the documentation.
2013-05-28 21:02:11 +02:00
website, <em>Converse.js</em> is not really meant to be a &#8220;Software-as-a-service&#8221; (SaaS)
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
webchat.</p>
<p>Instead, its goal is to provide the means for website owners to add a tightly
integrated instant messaging service to their own sites.</p>
<p>As a website owner, you are expected to host <em>Converse.js</em> yourself, and to do some legwork to
Small updates to the documentation.
2013-05-28 21:02:11 +02:00
properly configure and integrate it into your site.</p>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
<p>The benefit in doing this, is that your users have a much more streamlined and integrated
webchat experience and that you have control over the data. The latter being a
requirement for many sites dealing with sensitive information.</p>
<p>You&#8217;ll need to set up your own XMPP server and in order to have
Update documentation
2013-07-25 00:09:09 +02:00
<a class="reference internal" href="#session-support">Session Support</a> (i.e. single-signon functionality whereby users are authenticated once and stay
Small updates to the documentation.
2013-05-28 21:02:11 +02:00
logged in to XMPP upon page reload) you will also have to add some server-side
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
code.</p>
<p>The <a class="reference internal" href="#what-you-will-need">What you will need</a> section has more information on all these
requirements.</p>
</div>
Update the docs with info on connection managers etc.
2013-05-17 12:48:05 +02:00
<div class="section" id="what-you-will-need">
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
<h1><a class="toc-backref" href="#id4">What you will need</a><a class="headerlink" href="#what-you-will-need" title="Permalink to this headline"></a></h1>
Update the docs with info on connection managers etc.
2013-05-17 12:48:05 +02:00
<div class="section" id="an-xmpp-jabber-server">
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
<h2><a class="toc-backref" href="#id5">An XMPP/Jabber server</a><a class="headerlink" href="#an-xmpp-jabber-server" title="Permalink to this headline"></a></h2>
Update the docs with info on connection managers etc.
2013-05-17 12:48:05 +02:00
<p><em>Converse.js</em> implements <a class="reference external" href="https://en.wikipedia.org/wiki/Xmpp">XMPP</a> as its messaging protocol, and therefore needs
to connect to an XMPP/Jabber server (Jabber is really just a synonym for XMPP).</p>
Small updates to the documentation.
2013-05-28 21:02:11 +02:00
<p>You can connect to public XMPP servers like <tt class="docutils literal"><span class="pre">jabber.org</span></tt> but if you want to
Update documentation
2013-07-25 00:09:09 +02:00
have <a class="reference internal" href="#session-support">Session Support</a> you&#8217;ll have to set up your own XMPP server.</p>
Small updates to the documentation.
2013-05-28 21:02:11 +02:00
<p>You can find a list of public XMPP servers/providers on <a class="reference external" href="http://xmpp.net">xmpp.net</a> and a list of
servers that you can set up yourself on <a class="reference external" href="http://xmpp.org/xmpp-software/servers/">xmpp.org</a>.</p>
Update the docs with info on connection managers etc.
2013-05-17 12:48:05 +02:00
</div>
<div class="section" id="connection-manager">
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
<h2><a class="toc-backref" href="#id6">Connection Manager</a><a class="headerlink" href="#connection-manager" title="Permalink to this headline"></a></h2>
Update the docs with info on connection managers etc.
2013-05-17 12:48:05 +02:00
<p>Your website and <em>Converse.js</em> use <a class="reference external" href="https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol">HTTP</a> as protocol to communicate with
the webserver. HTTP connections are stateless and usually shortlived.</p>
<p><a class="reference external" href="https://en.wikipedia.org/wiki/Xmpp">XMPP</a> on the other hand, is the protocol that enables instant messaging, and
its connections are stateful and usually longer.</p>
<p>To enable a web application like <em>Converse.js</em> to communicate with an XMPP
server, we need a proxy in the middle that can act as a bridge between the two
protocols.</p>
<p>This is the job of a connection manager. A connection manager can be either a
standalone application or part of an XMPP server. <a class="reference external" href="http://www.ejabberd.im">ejabberd</a> for example,
includes a connection manager (but you have to enable it).</p>
<p>The demo on the <a class="reference external" href="http://conversejs.org">Converse.js homepage</a> uses a a connection manager located at <a class="reference external" href="https://bind.opkode.im">https://bind.opkode.im</a>.
This connection manager is for testing purposes only, please don&#8217;t use it in
production.</p>
<div class="section" id="overcoming-cross-domain-request-restrictions">
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
<h3><a class="toc-backref" href="#id7">Overcoming cross-domain request restrictions</a><a class="headerlink" href="#overcoming-cross-domain-request-restrictions" title="Permalink to this headline"></a></h3>
Update the docs with info on connection managers etc.
2013-05-17 12:48:05 +02:00
<p>The domain of the <em>Converse.js</em> demo is <em>conversejs.org</em>, but the domain of the connection manager is <em>opkode.im</em>.
HTTP requests are made by <em>Converse.js</em> to the connection manager via XmlHttpRequests (XHR).
Until recently, it was not possible to make such requests to a different domain
than the one currently being served (to prevent XSS attacks).</p>
<p>Luckily there is now a standard called <a class="reference external" href="https://en.wikipedia.org/wiki/Cross-origin_resource_sharing">CORS</a> (Cross-origin resource sharing), which enables exactly that.
Modern browsers support CORS, but there are problems with Internet Explorer &lt;
10.</p>
<p>IE 8 and 9 partially support CORS via a proprietary implementation called
XDomainRequest. There is a <a class="reference external" href="https://gist.github.com/1095825/6b4517276f26b66b01fa97b0a78c01275fdc6ff2">Strophe.js plugin</a> which you can use to enable
support for XDomainRequest when it is present.</p>
<p>In IE &lt; 8, there is no support for CORS.</p>
<p>If you need to support these browsers, you can add a front-end proxy in
Apache/Nginx which serves the connection manager under the same domain as your
website. This will remove the need for any cross-domain XHR support.</p>
</div>
</div>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
<div class="section" id="server-side-authentication">
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
<h2><a class="toc-backref" href="#id8">Server-side authentication</a><a class="headerlink" href="#server-side-authentication" title="Permalink to this headline"></a></h2>
Add note to prebind section
2013-06-03 22:48:34 +02:00
<div class="section" id="pre-binding-and-single-session-support">
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
<span id="session-support"></span><h3><a class="toc-backref" href="#id9">Pre-binding and Single Session Support</a><a class="headerlink" href="#pre-binding-and-single-session-support" title="Permalink to this headline"></a></h3>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
<p>It&#8217;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.</p>
<p>Jack Moffitt has a great <a class="reference external" href="http://metajack.im/2008/10/03/getting-attached-to-strophe">blogpost</a> about this and even provides an <a class="reference external" href="https://github.com/metajack/strophejs/tree/master/examples/attach">example Django application</a> to demonstrate it.</p>
Add note to prebind section
2013-06-03 22:48:34 +02:00
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">If you want to enable single session support, make sure to pass <strong>prebind: true</strong>
Update documentation
2013-07-25 00:09:09 +02:00
when you call <strong>converse.initialize</strong> (see ./index.html).</p>
Add note to prebind section
2013-06-03 22:48:34 +02:00
</div>
Add more info on prebinding/session support
2013-06-03 22:42:34 +02:00
<p>When you authenticate to the XMPP server on your backend, you&#8217;ll receive two
tokens, RID (request ID) and SID (session ID).</p>
<p>These tokens then need to be passed back to the javascript running in your
browser, where you will need them attach to the existing session.</p>
<p>You can embed the RID and SID tokens in your HTML markup or you can do an
XMLHttpRequest call to you server and ask it to return them for you.</p>
<p>Below is one example of how this could work. An Ajax call is made to the
relative URL <strong>/prebind</strong> and it expects to receive JSON data back.</p>
<div class="highlight-python"><pre>$.getJSON('/prebind', function (data) {
var connection = new Strophe.Connection(converse.bosh_service_url);
connection.attach(data.jid, data.sid, data.rid, function (status) {
if ((status === Strophe.Status.ATTACHED) || (status === Strophe.Status.CONNECTED)) {
converse.onConnected(connection)
}
});
}
);</pre>
</div>
<p><strong>Here&#8217;s what&#8217;s happening:</strong></p>
<p>The JSON data contains the user&#8217;s JID (jabber ID), RID and SID. The URL to the
BOSH connection manager is already set as a configuration setting on the
<em>converse</em> object (see ./main.js), so we can reuse it from there.</p>
<p>A new Strophe.Connection object is instantiated and then <em>attach</em> is called with
the user&#8217;s JID, the necessary tokens and a callback function.</p>
<p>In the callback function, you call <em>converse.onConnected</em> together with the
connection object.</p>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
</div>
</div>
Add info on facebook integration
2013-08-13 11:19:40 +02:00
<div class="section" id="facebook-integration">
<h2><a class="toc-backref" href="#id10">Facebook integration</a><a class="headerlink" href="#facebook-integration" title="Permalink to this headline"></a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">It should be possible to integrate Converse.js with Facebook chat, and
below I&#8217;ll provide some tips and documentation on how to achieve this. That
said, I don&#8217;t have a Facebook account and therefore haven&#8217;t tried to do
this myself. Feedback and patches from people who have succesfully done this
will be appreciated.</p>
</div>
<p>Converse.js uses <a class="reference external" href="http://strophe.im/strophejs">Strophe.js</a> to connect and
communicate with the XMPP server. One nice thing about Strophe.js is that it
can be extended via <a class="reference external" href="http://github.com/strophe/strophejs-plugins">plugins</a>.</p>
<p>Here is a <a class="reference external" href="https://github.com/kissrobber/turedsocial/blob/master/strophe-plugins/src/facebook.js">plugin for authenticating with facebook</a>.</p>
<p>You will need your own BOSH connection manager to act as a proxy between
Converse.js/Strophe.js and Facebook&#8217;s XMPP server. That is because Facebook&#8217;s
XMPP server doesn&#8217;t support BOSH natively.</p>
<p>The BOSH connection manager that I make available for
testing purposes (at <a class="reference external" href="https://bind.opkode.im">https://bind.opkode.im</a>) uses <a class="reference external" href="https://github.com/twonds/punjab">Punjab</a>,
although there are quite a few other options available as well.</p>
<p>When you configure Converse.js, via its <tt class="docutils literal"><span class="pre">initialize</span></tt> method, you must specify the
<a class="reference internal" href="#bosh-service-url">bosh_service_url</a> value, which is to be your BOSH connection manager.</p>
<p>Please note, to enable Facebook integration, you&#8217;ll have to
get your hands dirty and modify Converse.js&#8217;s code, so that it calls the
<tt class="docutils literal"><span class="pre">facebookConnect</span></tt> method of the plugin above.</p>
<p>The plugin above gives the following code example for you to meditate upon:</p>
<div class="highlight-python"><pre>connection = new Strophe.Connection("http://localhost:5280/bosh");
connection.facebookConnect(
"12345@chat.facebook.com",
onConnectFacebook,
300,
1,
'5e64a30272af065bd72258c565a03f2f',
'8147a27e4a7f9b55ffc85c2683f9529a',
FB.getSession().session_key
);</pre>
</div>
<p>The connection is already created inside Converse.js, so the
<tt class="docutils literal"><span class="pre">facebookConnect</span></tt> method needs to also be called from there.</p>
<p>If someone submits a sane patch that does the above, I&#8217;ll be happy to merge it.
Until then, people will have to do this themselves.</p>
</div>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
</div>
docs w.r.t using development files with(out) require.js. Updates #9
2013-07-27 01:48:10 +02:00
<div class="section" id="development">
Add info on facebook integration
2013-08-13 11:19:40 +02:00
<h1><a class="toc-backref" href="#id11">Development</a><a class="headerlink" href="#development" title="Permalink to this headline"></a></h1>
Update development section of the docs
2013-08-09 09:21:20 +02:00
<p>If you want to work with the non-minified Javascript and CSS files you&#8217;ll soon
notice that there are references to a missing <em>components</em> folder. Please
follow the instructions below to create this folder and fetch Converse&#8217;s
3rd-party dependencies.</p>
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
<div class="section" id="install-node-js-and-development-dependencies">
Add info on facebook integration
2013-08-13 11:19:40 +02:00
<h2><a class="toc-backref" href="#id12">Install Node.js and development dependencies</a><a class="headerlink" href="#install-node-js-and-development-dependencies" title="Permalink to this headline"></a></h2>
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
<p>We use development tools (<a class="reference external" href="http://gruntjs.com">Grunt</a> and <a class="reference external" href="http://bower.io">Bower</a>)
which depend on Node.js and npm (the Node package manager).</p>
<p>If you don&#8217;t have Node.js installed, you can download and install the latest
version <a class="reference external" href="https://nodejs.org/download">here</a>.</p>
Update development section of the docs
2013-08-09 09:21:20 +02:00
<p>Once you have Node.js installed, run the following command inside the Converse.js
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
directory:</p>
<div class="highlight-python"><pre>npm install</pre>
</div>
Update development section of the docs
2013-08-09 09:21:20 +02:00
<p>This will install all the development dependencies for Converse.js. If you are
curious to know what these are, take a look at whats under the <em>devDependencies</em> key in
<cite>package.json &lt;https://github.com/jcbrand/converse.js/blob/master/package.json&gt;</cite>.</p>
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
</div>
<div class="section" id="install-3rd-party-dependencies">
Add info on facebook integration
2013-08-13 11:19:40 +02:00
<h2><a class="toc-backref" href="#id13">Install 3rd party dependencies</a><a class="headerlink" href="#install-3rd-party-dependencies" title="Permalink to this headline"></a></h2>
Update development section of the docs
2013-08-09 09:21:20 +02:00
<p>After running <tt class="docutils literal"><span class="pre">npm</span> <span class="pre">install</span></tt>, you will now have Grunt and Bower installed.</p>
<p>We use Bower to manage Converse&#8217;s front-end dependencies (e.g. Javascript that
should get loaded in the browser).</p>
<p>To fetch these dependencies, run:</p>
'build' grunt task was renamed to 'fetch'. Updated docs
2013-07-30 21:43:49 +02:00
<div class="highlight-python"><pre>grunt fetch</pre>
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
</div>
Update development section of the docs
2013-08-09 09:21:20 +02:00
<p>This will call Bower in the background to fetch all the front-end
dependencies (like backbone.js, strophe.js etc.) and then put them in the
<em>components</em> folder.</p>
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
</div>
<div class="section" id="with-amd-and-require-js-recommended">
Add info on facebook integration
2013-08-13 11:19:40 +02:00
<h2><a class="toc-backref" href="#id14">With AMD and require.js (recommended)</a><a class="headerlink" href="#with-amd-and-require-js-recommended" title="Permalink to this headline"></a></h2>
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
<p>Converse.js uses <a class="reference external" href="http://requirejs.org">require.js</a> to asynchronously load dependencies.</p>
docs w.r.t using development files with(out) require.js. Updates #9
2013-07-27 01:48:10 +02:00
<p>If you want to develop or customize converse.js, you&#8217;ll want to load the
non-minified javascript files.</p>
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
<p>Add the following two lines to the <em>&lt;head&gt;</em> section of your webpage:</p>
docs w.r.t using development files with(out) require.js. Updates #9
2013-07-27 01:48:10 +02:00
<div class="highlight-python"><pre>&lt;link rel="stylesheet" type="text/css" media="screen" href="converse.css"&gt;
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
&lt;script data-main="main" src="components/requirejs/require.js"&gt;&lt;/script&gt;</pre>
docs w.r.t using development files with(out) require.js. Updates #9
2013-07-27 01:48:10 +02:00
</div>
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
<p>require.js will then let the main.js file be parsed (because of the <em>data-main</em>
attribute on the <em>script</em> tag), which will in turn cause converse.js to be
parsed.</p>
</div>
<div class="section" id="without-amd-and-require-js">
Add info on facebook integration
2013-08-13 11:19:40 +02:00
<h2><a class="toc-backref" href="#id15">Without AMD and require.js</a><a class="headerlink" href="#without-amd-and-require-js" title="Permalink to this headline"></a></h2>
docs w.r.t using development files with(out) require.js. Updates #9
2013-07-27 01:48:10 +02:00
<p>Converse.js can also be used without require.js. If you for some reason prefer
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
to use it this way, please refer to
<a class="reference external" href="https://github.com/jcbrand/converse.js/blob/master/non_amd.html">non_amd.html</a>
for an example of how and in what order all the Javascript files that converse.js
depends on need to be loaded.</p>
</div>
Update docs with info on tests
2013-07-29 23:22:41 +02:00
<div class="section" id="before-submitting-a-pull-request">
Add info on facebook integration
2013-08-13 11:19:40 +02:00
<h2><a class="toc-backref" href="#id16">Before submitting a pull request</a><a class="headerlink" href="#before-submitting-a-pull-request" title="Permalink to this headline"></a></h2>
Update docs with info on tests
2013-07-29 23:22:41 +02:00
<div class="section" id="add-tests-for-your-bugfix-or-feature">
Add info on facebook integration
2013-08-13 11:19:40 +02:00
<h3><a class="toc-backref" href="#id17">Add tests for your bugfix or feature</a><a class="headerlink" href="#add-tests-for-your-bugfix-or-feature" title="Permalink to this headline"></a></h3>
Update docs with info on tests
2013-07-29 23:22:41 +02:00
<p>Add a test for any bug fixed or feature added. We use Jasmine
for testing.</p>
<p>Take a look at <tt class="docutils literal"><span class="pre">tests.html</span></tt> and <tt class="docutils literal"><span class="pre">spec/MainSpec.js</span></tt> to see how
the tests are implemented.</p>
<p>If you are unsure how to write tests, please
Add info on facebook integration
2013-08-13 11:19:40 +02:00
<a class="reference external" href="http://opkode.com/contact">contact me</a> and I&#8217;ll be happy to help.</p>
Update docs with info on tests
2013-07-29 23:22:41 +02:00
</div>
<div class="section" id="check-that-the-tests-pass">
Add info on facebook integration
2013-08-13 11:19:40 +02:00
<h3><a class="toc-backref" href="#id18">Check that the tests pass</a><a class="headerlink" href="#check-that-the-tests-pass" title="Permalink to this headline"></a></h3>
Update docs with info on tests
2013-07-29 23:22:41 +02:00
<p>Check that the Jasmine tests complete sucessfully. Open
<a class="reference external" href="https://github.com/jcbrand/converse.js/blob/master/tests.html">tests.html</a>
in your browser, and the tests will run automatically.</p>
<p>On the command line you can run:</p>
<div class="highlight-python"><pre>grunt test</pre>
</div>
</div>
<div class="section" id="check-your-code-for-errors-or-bad-habits-by-running-jshint">
Add info on facebook integration
2013-08-13 11:19:40 +02:00
<h3><a class="toc-backref" href="#id19">Check your code for errors or bad habits by running JSHint</a><a class="headerlink" href="#check-your-code-for-errors-or-bad-habits-by-running-jshint" title="Permalink to this headline"></a></h3>
Update docs with info on tests
2013-07-29 23:22:41 +02:00
<p><a class="reference external" href="http://jshint.com">JSHint</a> will do a static analysis of your code and hightlight potential errors
and/or bad habits.</p>
<div class="highlight-python"><pre>grunt jshint</pre>
</div>
<p>You can run both the tests and jshint in one go by calling:</p>
<div class="highlight-python"><pre>grunt check</pre>
</div>
</div>
</div>
docs w.r.t using development files with(out) require.js. Updates #9
2013-07-27 01:48:10 +02:00
</div>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
<div class="section" id="configuration">
Add info on facebook integration
2013-08-13 11:19:40 +02:00
<h1><a class="toc-backref" href="#id20">Configuration</a><a class="headerlink" href="#configuration" title="Permalink to this headline"></a></h1>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
<p>The included minified JS and CSS files can be used for demoing or testing, but
you&#8217;ll want to configure <em>Converse.js</em> to suit your needs before you deploy it
on your website.</p>
<p><em>Converse.js</em> is passed its configuration settings when you call its
<em>initialize</em> method.</p>
Update documentation
2013-07-25 00:09:09 +02:00
<p>You&#8217;ll most likely want to call the <em>initialize</em> method in your HTML page. For
an example of how this is done, please see the bottom of the <em>./index.html</em> page.</p>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
<p>Please refer to the <a class="reference internal" href="#configuration-variables">Configuration variables</a> section below for info on
all the available configuration settings.</p>
<p>After you have configured <em>Converse.js</em>, you&#8217;ll have to regenerate the minified
JS file so that it will include the new settings. Please refer to the
<a class="reference internal" href="#minification">Minification</a> section for more info on how to do this.</p>
<div class="section" id="configuration-variables">
Add info on facebook integration
2013-08-13 11:19:40 +02:00
<h2><a class="toc-backref" href="#id21">Configuration variables</a><a class="headerlink" href="#configuration-variables" title="Permalink to this headline"></a></h2>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
<div class="section" id="animate">
Add info on facebook integration
2013-08-13 11:19:40 +02:00
<h3><a class="toc-backref" href="#id22">animate</a><a class="headerlink" href="#animate" title="Permalink to this headline"></a></h3>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
<p>Default = True</p>
<p>Show animations, for example when opening and closing chat boxes.</p>
</div>
<div class="section" id="auto-list-rooms">
Add info on facebook integration
2013-08-13 11:19:40 +02:00
<h3><a class="toc-backref" href="#id23">auto_list_rooms</a><a class="headerlink" href="#auto-list-rooms" title="Permalink to this headline"></a></h3>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
<p>Default = False</p>
<p>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.</p>
<p>Not recommended for servers with lots of chat rooms.</p>
<p>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
option will create lots of extra connection traffic.</p>
</div>
<div class="section" id="auto-subscribe">
Add info on facebook integration
2013-08-13 11:19:40 +02:00
<h3><a class="toc-backref" href="#id24">auto_subscribe</a><a class="headerlink" href="#auto-subscribe" title="Permalink to this headline"></a></h3>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
<p>Default = False</p>
<p>If true, the user will automatically subscribe back to any contact requests.</p>
</div>
<div class="section" id="bosh-service-url">
Add info on facebook integration
2013-08-13 11:19:40 +02:00
<h3><a class="toc-backref" href="#id25">bosh_service_url</a><a class="headerlink" href="#bosh-service-url" title="Permalink to this headline"></a></h3>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
<p>Connections to an XMPP server depend on a BOSH connection manager which acts as
a middle man between HTTP and XMPP.</p>
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
<p>See <a class="reference external" href="http://metajack.im/2008/09/08/which-bosh-server-do-you-need">here</a> for more information.</p>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
</div>
Update docs to mention new way to minify. Fixes #39
2013-08-20 22:53:19 +02:00
<div class="section" id="debug">
<h3><a class="toc-backref" href="#id26">debug</a><a class="headerlink" href="#debug" title="Permalink to this headline"></a></h3>
<p>If set to true, debugging output will be logged to the browser console.</p>
</div>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
<div class="section" id="fullname">
Update docs to mention new way to minify. Fixes #39
2013-08-20 22:53:19 +02:00
<h3><a class="toc-backref" href="#id27">fullname</a><a class="headerlink" href="#fullname" title="Permalink to this headline"></a></h3>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
<p>If you are using prebinding, you need to specify the fullname of the currently
logged in user.</p>
</div>
<div class="section" id="hide-muc-server">
Update docs to mention new way to minify. Fixes #39
2013-08-20 22:53:19 +02:00
<h3><a class="toc-backref" href="#id28">hide_muc_server</a><a class="headerlink" href="#hide-muc-server" title="Permalink to this headline"></a></h3>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
<p>Default = False</p>
<p>Hide the <tt class="docutils literal"><span class="pre">server</span></tt> input field of the form inside the <tt class="docutils literal"><span class="pre">Room</span></tt> panel of the
controlbox. Useful if you want to restrict users to a specific XMPP server of
your choosing.</p>
Update the docs with info on connection managers etc.
2013-05-17 12:48:05 +02:00
</div>
Add initial documentation
2013-04-26 21:01:39 +02:00
<div class="section" id="prebind">
Update docs to mention new way to minify. Fixes #39
2013-08-20 22:53:19 +02:00
<h3><a class="toc-backref" href="#id29">prebind</a><a class="headerlink" href="#prebind" title="Permalink to this headline"></a></h3>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
<p>Default = False</p>
Add initial documentation
2013-04-26 21:01:39 +02:00
<p>Use this option when you want to attach to an existing XMPP connection that was
already authenticated (usually on the backend before page load).</p>
<p>This is useful when you don&#8217;t want to render the login form on the chat control
box with each page load.</p>
<p>When set to true, you&#8217;ll need to make sure that the onConnected method is
called, and passed to it a Strophe connection object.</p>
<p>Besides requiring the back-end to authenticate you, you&#8217;ll also
have to write a Javascript snippet to attach to the set up connection:</p>
<div class="highlight-python"><pre>$.JSON({
'url': 'mysite.com/xmpp-authenticate',
'success': function (data) {
connection = new Strophe.Connection(bosh_service_url);
connection.attach(data.jid, data.sid, data.rid, converse.onConnected);
}</pre>
</div>
<p>The backend must authenticate for you, and then return a SID (session ID) and
RID (Request ID), which you use when you attach to the connection.</p>
</div>
Add more info on prebinding/session support
2013-06-03 22:42:34 +02:00
<div class="section" id="show-controlbox-by-default">
Update docs to mention new way to minify. Fixes #39
2013-08-20 22:53:19 +02:00
<h3><a class="toc-backref" href="#id30">show_controlbox_by_default</a><a class="headerlink" href="#show-controlbox-by-default" title="Permalink to this headline"></a></h3>
Add more info on prebinding/session support
2013-06-03 22:42:34 +02:00
<p>Default = False</p>
<p>The &#8220;controlbox&#8221; refers to the special chatbox containing your contacts roster,
status widget, chatrooms and other controls.</p>
<p>By default this box is hidden and can be toggled by clicking on any element in
the page with class <em>toggle-online-users</em>.</p>
<p>If this options is set to true, the controlbox will by default be shown upon
page load.</p>
</div>
Add initial documentation
2013-04-26 21:01:39 +02:00
<div class="section" id="xhr-user-search">
Update docs to mention new way to minify. Fixes #39
2013-08-20 22:53:19 +02:00
<h3><a class="toc-backref" href="#id31">xhr_user_search</a><a class="headerlink" href="#xhr-user-search" title="Permalink to this headline"></a></h3>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
<p>Default = False</p>
Add initial documentation
2013-04-26 21:01:39 +02:00
<p>There are two ways to add users.</p>
<ul class="simple">
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
<li>The user inputs a valid JID (Jabber ID), and the user is added as a pending contact.</li>
<li>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.</li>
Add initial documentation
2013-04-26 21:01:39 +02:00
</ul>
<p>This setting enables the second mechanism, otherwise by default the first will
be used.</p>
</div>
</div>
Update the docs with info on connection managers etc.
2013-05-17 12:48:05 +02:00
</div>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
<div class="section" id="minification">
Update docs to mention new way to minify. Fixes #39
2013-08-20 22:53:19 +02:00
<h1><a class="toc-backref" href="#id32">Minification</a><a class="headerlink" href="#minification" title="Permalink to this headline"></a></h1>
<div class="section" id="minifying-javascript-and-css">
<h2><a class="toc-backref" href="#id33">Minifying Javascript and CSS</a><a class="headerlink" href="#minifying-javascript-and-css" title="Permalink to this headline"></a></h2>
<p>Please make sure to read the section <a class="reference internal" href="#development">Development</a> and that you have installed
all development dependencies (long story short, you can run <tt class="docutils literal"><span class="pre">npm</span> <span class="pre">install</span></tt>
and then <tt class="docutils literal"><span class="pre">grunt</span> <span class="pre">fetch</span></tt>).</p>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
<p>We use <a class="reference external" href="http://requirejs.org">require.js</a> to keep track of <em>Converse.js</em> and its dependencies and to
to bundle them together in a single minified file fit for deployment to a
production site.</p>
Update docs to mention new way to minify. Fixes #39
2013-08-20 22:53:19 +02:00
<p>To minify the Javascript and CSS, run the following command:</p>
<div class="highlight-python"><pre>grunt minify</pre>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
</div>
Update docs to mention new way to minify. Fixes #39
2013-08-20 22:53:19 +02:00
<p>Javascript will be bundled and minified via <a class="reference external" href="http://requirejs.org">require.js</a>&#8216;s optimization tool.
You can <a class="reference external" href="http://requirejs.org/docs/optimization.html">read more about require.js&#8217;s optimizer here</a>.</p>
<p>CSS is minified via <a class="reference external" href="https://github.com/gruntjs/grunt-contrib-cssmin">cssmin</a>.</p>
Add initial documentation
2013-04-26 21:01:39 +02:00
</div>
Updated documents.
2013-06-02 00:23:24 +02:00
</div>
<div class="section" id="translations">
Add info on facebook integration
2013-08-13 11:19:40 +02:00
<h1><a class="toc-backref" href="#id34">Translations</a><a class="headerlink" href="#translations" title="Permalink to this headline"></a></h1>
Update documentation
2013-07-25 00:09:09 +02:00
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Translations take up a lot of space and will bloat your minified file.
Remove no-locales file, it wasn't built properly Update docs to not mention it Conflicts: docs/doctrees/environment.pickle
2013-07-25 00:21:42 +02:00
At the time of writing, all the translations add about 50KB of extra data to
the minified javascript file. Therefore, make sure to only
Update documentation
2013-07-25 00:09:09 +02:00
include those languages that you intend to support and remove from
./locale/locales.js those which you don&#8217;t need. Remember to rebuild the
minified file afterwards.</p>
</div>
Add a note to docs about locales.js
2013-06-02 19:44:06 +02:00
<p>The gettext POT file located in ./locale/converse.pot is the template
Updated documents.
2013-06-02 00:23:24 +02:00
containing all translations and from which for each language an individual PO
file is generated.</p>
<p>The POT file contains all translateable strings extracted from converse.js.</p>
<p>To make a user facing string translateable, wrap it in the double underscore helper
function like so:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">__</span><span class="p">(</span><span class="s">&#39;This string will be translated at runtime&#39;</span><span class="p">);</span>
</pre></div>
</div>
<p>After adding the string, you&#8217;ll need to regenerate the POT file, like so:</p>
<div class="highlight-python"><pre>make pot</pre>
</div>
<p>You can then create or update the PO file for a specific language by doing the following:</p>
Add a note to docs about locales.js
2013-06-02 19:44:06 +02:00
<div class="highlight-python"><pre>msgmerge ./locale/af/LC_MESSAGES/converse.po ./locale/converse.pot -U</pre>
Updated documents.
2013-06-02 00:23:24 +02:00
</div>
<p>This PO file is then what gets translated.</p>
<p>If you&#8217;ve created a new PO file, please make sure to add the following
attributes at the top of the file (under <em>Content-Transfer-Encoding</em>). They are
required as configuration settings for Jed, the Javascript translations library
that we&#8217;re using.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="s">&quot;domain: converse</span><span class="se">\n</span><span class="s">&quot;</span>
Add a note to docs about locales.js
2013-06-02 19:44:06 +02:00
<span class="s">&quot;lang: af</span><span class="se">\n</span><span class="s">&quot;</span>
Updated documents.
2013-06-02 00:23:24 +02:00
<span class="s">&quot;plural_forms: nplurals=2; plural=(n != 1);</span><span class="se">\n</span><span class="s">&quot;</span>
</pre></div>
</div>
<p>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.</p>
<p>To generate JSON from a PO file, you&#8217;ll need po2json for node.js. Run the
following command to install it (npm being the node.js package manager):</p>
<div class="highlight-python"><pre>npm install po2json</pre>
</div>
<p>You can then convert the translations into JSON format:</p>
Add a note to docs about locales.js
2013-06-02 19:44:06 +02:00
<div class="highlight-python"><pre>po2json locale/af/LC_MESSAGES/converse.po locale/af/LC_MESSAGES/converse.json</pre>
Updated documents.
2013-06-02 00:23:24 +02:00
</div>
<p>Now from converse.json paste the data as a value for the &#8220;locale_data&#8221; key in the
object in the language&#8217;s .js file.</p>
<p>So, if you are for example translating into German (language code &#8216;de&#8217;), you&#8217;ll
create or update the file ./locale/LC_MESSAGES/de.js with the following code:</p>
<div class="highlight-python"><pre>(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;
}));</pre>
</div>
<p>making sure to also paste the JSON data as value to the &#8220;locale_data&#8221; key.</p>
Add a note to docs about locales.js
2013-06-02 19:44:06 +02:00
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">If you are adding translations for a new language that is not already supported,
you&#8217;ll have to make one more edit in ./locale/locales.js to make sure the
language is loaded by require.js.</p>
</div>
Updated documents.
2013-06-02 00:23:24 +02:00
<p>Congratulations, you&#8217;ve now succesfully added your translations. Sorry for all
those hoops you had to jump through.</p>
Add initial documentation
2013-04-26 21:01:39 +02:00
</div>
</div>
</div>
<div class="clearer"></div>
</div>
Add a custom sphinx theme Makes the docs look similar to the main site
2013-04-26 21:49:26 +02:00
</section>
Add initial documentation
2013-04-26 21:01:39 +02:00
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
Regenerated docs
2013-08-16 11:27:29 +02:00
<li><a href="#">Converse.js 0.5.3 documentation</a> &raquo;</li>
Add initial documentation
2013-04-26 21:01:39 +02:00
</ul>
</div>
Add a custom sphinx theme Makes the docs look similar to the main site
2013-04-26 21:49:26 +02:00
</div>
<div id="footer_wrap" class="outer">
<footer class="inner">
Add initial documentation
2013-04-26 21:01:39 +02:00
&copy; Copyright 2013, JC Brand.
Add a custom sphinx theme Makes the docs look similar to the main site
2013-04-26 21:49:26 +02:00
<p class="copyright">Converse.js created by <a href="http://opkode.com" target="_blank">jcbrand</a></p>
</footer>
Add initial documentation
2013-04-26 21:01:39 +02:00
</div>
</body>
</html>
Reference in New Issue Copy Permalink