|
|
@@ -7,7 +7,7 @@
|
|
|
<head>
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
|
|
- <title>Introduction — Converse.js 0.3 documentation</title>
|
|
|
+ <title>Quickstart (to get a demo up and running) — Converse.js 0.5 documentation</title>
|
|
|
|
|
|
<link rel="stylesheet" href="_static/stylesheet.css" type="text/css" />
|
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
|
@@ -15,7 +15,7 @@
|
|
|
<script type="text/javascript">
|
|
|
var DOCUMENTATION_OPTIONS = {
|
|
|
URL_ROOT: '',
|
|
|
- VERSION: '0.3',
|
|
|
+ VERSION: '0.5',
|
|
|
COLLAPSE_INDEX: false,
|
|
|
FILE_SUFFIX: '.html',
|
|
|
HAS_SOURCE: true
|
|
|
@@ -24,7 +24,7 @@
|
|
|
<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>
|
|
|
- <link rel="top" title="Converse.js 0.3 documentation" href="#" />
|
|
|
+ <link rel="top" title="Converse.js 0.5 documentation" href="#" />
|
|
|
</head>
|
|
|
<body>
|
|
|
<div id="header_wrap" class="outer">
|
|
|
@@ -49,7 +49,7 @@
|
|
|
<li class="right" style="margin-right: 10px">
|
|
|
<a href="genindex.html" title="General Index"
|
|
|
accesskey="I">index</a></li>
|
|
|
- <li><a href="#">Converse.js 0.3 documentation</a> »</li>
|
|
|
+ <li><a href="#">Converse.js 0.5 documentation</a> »</li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
<section id="main_content" class="inner">
|
|
|
@@ -65,46 +65,92 @@
|
|
|
<div class="contents local topic" id="table-of-contents">
|
|
|
<p class="topic-title first">Table of Contents</p>
|
|
|
<ul class="simple">
|
|
|
-<li><a class="reference internal" href="#introduction" id="id1">Introduction</a></li>
|
|
|
-<li><a class="reference internal" href="#what-you-will-need" id="id2">What you will need</a><ul>
|
|
|
-<li><a class="reference internal" href="#an-xmpp-jabber-server" id="id3">An XMPP/Jabber server</a></li>
|
|
|
-<li><a class="reference internal" href="#connection-manager" id="id4">Connection Manager</a><ul>
|
|
|
-<li><a class="reference internal" href="#overcoming-cross-domain-request-restrictions" id="id5">Overcoming cross-domain request restrictions</a></li>
|
|
|
+<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>
|
|
|
</ul>
|
|
|
</li>
|
|
|
-<li><a class="reference internal" href="#server-side-authentication" id="id6">Server-side authentication</a><ul>
|
|
|
-<li><a class="reference internal" href="#pre-binding-and-single-session-support" id="id7">Pre-binding and Single Session Support</a></li>
|
|
|
+<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>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
-<li><a class="reference internal" href="#quickstart-to-get-a-demo-up-and-running" id="id8">Quickstart (to get a demo up and running)</a></li>
|
|
|
-<li><a class="reference internal" href="#development" id="id9">Development</a></li>
|
|
|
-<li><a class="reference internal" href="#configuration" id="id10">Configuration</a><ul>
|
|
|
-<li><a class="reference internal" href="#configuration-variables" id="id11">Configuration variables</a><ul>
|
|
|
-<li><a class="reference internal" href="#animate" id="id12">animate</a></li>
|
|
|
-<li><a class="reference internal" href="#auto-list-rooms" id="id13">auto_list_rooms</a></li>
|
|
|
-<li><a class="reference internal" href="#auto-subscribe" id="id14">auto_subscribe</a></li>
|
|
|
-<li><a class="reference internal" href="#bosh-service-url" id="id15">bosh_service_url</a></li>
|
|
|
-<li><a class="reference internal" href="#fullname" id="id16">fullname</a></li>
|
|
|
-<li><a class="reference internal" href="#hide-muc-server" id="id17">hide_muc_server</a></li>
|
|
|
-<li><a class="reference internal" href="#prebind" id="id18">prebind</a></li>
|
|
|
-<li><a class="reference internal" href="#show-controlbox-by-default" id="id19">show_controlbox_by_default</a></li>
|
|
|
-<li><a class="reference internal" href="#xhr-user-search" id="id20">xhr_user_search</a></li>
|
|
|
+<li><a class="reference internal" href="#development" id="id10">Development</a><ul>
|
|
|
+<li><a class="reference internal" href="#install-node-js-and-development-dependencies" id="id11">Install Node.js and development dependencies</a></li>
|
|
|
+<li><a class="reference internal" href="#install-3rd-party-dependencies" id="id12">Install 3rd party dependencies</a></li>
|
|
|
+<li><a class="reference internal" href="#with-amd-and-require-js-recommended" id="id13">With AMD and require.js (recommended)</a></li>
|
|
|
+<li><a class="reference internal" href="#without-amd-and-require-js" id="id14">Without AMD and require.js</a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
+<li><a class="reference internal" href="#configuration" id="id15">Configuration</a><ul>
|
|
|
+<li><a class="reference internal" href="#configuration-variables" id="id16">Configuration variables</a><ul>
|
|
|
+<li><a class="reference internal" href="#animate" id="id17">animate</a></li>
|
|
|
+<li><a class="reference internal" href="#auto-list-rooms" id="id18">auto_list_rooms</a></li>
|
|
|
+<li><a class="reference internal" href="#auto-subscribe" id="id19">auto_subscribe</a></li>
|
|
|
+<li><a class="reference internal" href="#bosh-service-url" id="id20">bosh_service_url</a></li>
|
|
|
+<li><a class="reference internal" href="#fullname" id="id21">fullname</a></li>
|
|
|
+<li><a class="reference internal" href="#hide-muc-server" id="id22">hide_muc_server</a></li>
|
|
|
+<li><a class="reference internal" href="#prebind" id="id23">prebind</a></li>
|
|
|
+<li><a class="reference internal" href="#show-controlbox-by-default" id="id24">show_controlbox_by_default</a></li>
|
|
|
+<li><a class="reference internal" href="#xhr-user-search" id="id25">xhr_user_search</a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
-<li><a class="reference internal" href="#minification" id="id21">Minification</a><ul>
|
|
|
-<li><a class="reference internal" href="#minifying-javascript" id="id22">Minifying Javascript</a></li>
|
|
|
-<li><a class="reference internal" href="#minifying-css" id="id23">Minifying CSS</a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
-<li><a class="reference internal" href="#translations" id="id24">Translations</a></li>
|
|
|
+<li><a class="reference internal" href="#minification" id="id26">Minification</a><ul>
|
|
|
+<li><a class="reference internal" href="#minifying-javascript" id="id27">Minifying Javascript</a></li>
|
|
|
+<li><a class="reference internal" href="#minifying-css" id="id28">Minifying CSS</a></li>
|
|
|
</ul>
|
|
|
+</li>
|
|
|
+<li><a class="reference internal" href="#translations" id="id29">Translations</a></li>
|
|
|
+</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><head></em> element of your website via the <em>script</em> and <em>link</em>
|
|
|
+tags:</p>
|
|
|
+<div class="highlight-python"><pre><link rel="stylesheet" type="text/css" media="screen" href="converse.min.css">
|
|
|
+<script src="converse.min.js"></script></pre>
|
|
|
+</div>
|
|
|
+<p>Then, at the bottom of your page, after the closing <em></body></em> element, put the
|
|
|
+following inline Javascript code:</p>
|
|
|
+<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>
|
|
|
+<p>The <em>index.html</em> file inside the Converse.js folder serves as a nice usable
|
|
|
+example of this.</p>
|
|
|
+<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’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>
|
|
|
</div>
|
|
|
<div class="section" id="introduction">
|
|
|
-<h1><a class="toc-backref" href="#id1">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h1>
|
|
|
+<h1><a class="toc-backref" href="#id3">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h1>
|
|
|
<p>Even though you can connect to public XMPP servers on the <a class="reference external" href="http://conversejs.org">conversejs.org</a>
|
|
|
website, <em>Converse.js</em> is not really meant to be a “Software-as-a-service” (SaaS)
|
|
|
webchat.</p>
|
|
|
@@ -123,9 +169,9 @@ code.</p>
|
|
|
requirements.</p>
|
|
|
</div>
|
|
|
<div class="section" id="what-you-will-need">
|
|
|
-<h1><a class="toc-backref" href="#id2">What you will need</a><a class="headerlink" href="#what-you-will-need" title="Permalink to this headline">¶</a></h1>
|
|
|
+<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>
|
|
|
<div class="section" id="an-xmpp-jabber-server">
|
|
|
-<h2><a class="toc-backref" href="#id3">An XMPP/Jabber server</a><a class="headerlink" href="#an-xmpp-jabber-server" title="Permalink to this headline">¶</a></h2>
|
|
|
+<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>
|
|
|
<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>
|
|
|
<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
|
|
|
@@ -134,7 +180,7 @@ have <a class="reference internal" href="#session-support">Session Support</a> y
|
|
|
servers that you can set up yourself on <a class="reference external" href="http://xmpp.org/xmpp-software/servers/">xmpp.org</a>.</p>
|
|
|
</div>
|
|
|
<div class="section" id="connection-manager">
|
|
|
-<h2><a class="toc-backref" href="#id4">Connection Manager</a><a class="headerlink" href="#connection-manager" title="Permalink to this headline">¶</a></h2>
|
|
|
+<h2><a class="toc-backref" href="#id6">Connection Manager</a><a class="headerlink" href="#connection-manager" title="Permalink to this headline">¶</a></h2>
|
|
|
<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
|
|
|
@@ -149,7 +195,7 @@ includes a connection manager (but you have to enable it).</p>
|
|
|
This connection manager is for testing purposes only, please don’t use it in
|
|
|
production.</p>
|
|
|
<div class="section" id="overcoming-cross-domain-request-restrictions">
|
|
|
-<h3><a class="toc-backref" href="#id5">Overcoming cross-domain request restrictions</a><a class="headerlink" href="#overcoming-cross-domain-request-restrictions" title="Permalink to this headline">¶</a></h3>
|
|
|
+<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>
|
|
|
<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
|
|
|
@@ -167,9 +213,9 @@ website. This will remove the need for any cross-domain XHR support.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="section" id="server-side-authentication">
|
|
|
-<h2><a class="toc-backref" href="#id6">Server-side authentication</a><a class="headerlink" href="#server-side-authentication" title="Permalink to this headline">¶</a></h2>
|
|
|
+<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>
|
|
|
<div class="section" id="pre-binding-and-single-session-support">
|
|
|
-<span id="session-support"></span><h3><a class="toc-backref" href="#id7">Pre-binding and Single Session Support</a><a class="headerlink" href="#pre-binding-and-single-session-support" title="Permalink to this headline">¶</a></h3>
|
|
|
+<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>
|
|
|
<p>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.</p>
|
|
|
@@ -208,62 +254,50 @@ connection object.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
-<div class="section" id="quickstart-to-get-a-demo-up-and-running">
|
|
|
-<h1><a class="toc-backref" href="#id8">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><head></em> element of your website via the <em>script</em> and <em>link</em>
|
|
|
-tags:</p>
|
|
|
-<div class="highlight-python"><pre><link rel="stylesheet" type="text/css" media="screen" href="converse.min.css">
|
|
|
-<script src="converse.min.js"></script></pre>
|
|
|
-</div>
|
|
|
-<p>Then, at the bottom of your page, after the closing <em></body></em> element, put the
|
|
|
-following inline Javascript code:</p>
|
|
|
-<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>
|
|
|
-<p>The <em>index.html</em> file inside the Converse.js folder serves as a nice usable
|
|
|
-example of this.</p>
|
|
|
-<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’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>
|
|
|
-</div>
|
|
|
<div class="section" id="development">
|
|
|
-<h1><a class="toc-backref" href="#id9">Development</a><a class="headerlink" href="#development" title="Permalink to this headline">¶</a></h1>
|
|
|
-<p>Converse.js uses <a class="reference external" href="http://requirejs.org">require.js</a> to track and load dependencies.</p>
|
|
|
+<h1><a class="toc-backref" href="#id10">Development</a><a class="headerlink" href="#development" title="Permalink to this headline">¶</a></h1>
|
|
|
+<div class="section" id="install-node-js-and-development-dependencies">
|
|
|
+<h2><a class="toc-backref" href="#id11">Install Node.js and development dependencies</a><a class="headerlink" href="#install-node-js-and-development-dependencies" title="Permalink to this headline">¶</a></h2>
|
|
|
+<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’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>
|
|
|
+<p>Once you have Node.js installed, run the following command in the Converse.js
|
|
|
+directory:</p>
|
|
|
+<div class="highlight-python"><pre>npm install</pre>
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<div class="section" id="install-3rd-party-dependencies">
|
|
|
+<h2><a class="toc-backref" href="#id12">Install 3rd party dependencies</a><a class="headerlink" href="#install-3rd-party-dependencies" title="Permalink to this headline">¶</a></h2>
|
|
|
+<p>Now that we have Grunt and Bower, you can install and configure Converse’s
|
|
|
+3rd party dependencies with the following command:</p>
|
|
|
+<div class="highlight-python"><pre>grunt build</pre>
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<div class="section" id="with-amd-and-require-js-recommended">
|
|
|
+<h2><a class="toc-backref" href="#id13">With AMD and require.js (recommended)</a><a class="headerlink" href="#with-amd-and-require-js-recommended" title="Permalink to this headline">¶</a></h2>
|
|
|
+<p>Converse.js uses <a class="reference external" href="http://requirejs.org">require.js</a> to asynchronously load dependencies.</p>
|
|
|
<p>If you want to develop or customize converse.js, you’ll want to load the
|
|
|
non-minified javascript files.</p>
|
|
|
-<p>Add the following two lines to the <em><head></em> section of your webpage.</p>
|
|
|
+<p>Add the following two lines to the <em><head></em> section of your webpage:</p>
|
|
|
<div class="highlight-python"><pre><link rel="stylesheet" type="text/css" media="screen" href="converse.css">
|
|
|
-<script data-main="main" src="Libraries/require-jquery.js"></script></pre>
|
|
|
+<script data-main="main" src="components/requirejs/require.js"></script></pre>
|
|
|
</div>
|
|
|
+<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">
|
|
|
+<h2><a class="toc-backref" href="#id14">Without AMD and require.js</a><a class="headerlink" href="#without-amd-and-require-js" title="Permalink to this headline">¶</a></h2>
|
|
|
<p>Converse.js can also be used without require.js. If you for some reason prefer
|
|
|
-to use it this way, please refer to <em>non_amd.html</em> for an example of how and in
|
|
|
-what order all the Javascript files that converse.js depends on need to be
|
|
|
-loaded.</p>
|
|
|
+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>
|
|
|
</div>
|
|
|
<div class="section" id="configuration">
|
|
|
-<h1><a class="toc-backref" href="#id10">Configuration</a><a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h1>
|
|
|
+<h1><a class="toc-backref" href="#id15">Configuration</a><a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h1>
|
|
|
<p>The included minified JS and CSS files can be used for demoing or testing, but
|
|
|
you’ll want to configure <em>Converse.js</em> to suit your needs before you deploy it
|
|
|
on your website.</p>
|
|
|
@@ -277,14 +311,14 @@ all the available configuration settings.</p>
|
|
|
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">
|
|
|
-<h2><a class="toc-backref" href="#id11">Configuration variables</a><a class="headerlink" href="#configuration-variables" title="Permalink to this headline">¶</a></h2>
|
|
|
+<h2><a class="toc-backref" href="#id16">Configuration variables</a><a class="headerlink" href="#configuration-variables" title="Permalink to this headline">¶</a></h2>
|
|
|
<div class="section" id="animate">
|
|
|
-<h3><a class="toc-backref" href="#id12">animate</a><a class="headerlink" href="#animate" title="Permalink to this headline">¶</a></h3>
|
|
|
+<h3><a class="toc-backref" href="#id17">animate</a><a class="headerlink" href="#animate" title="Permalink to this headline">¶</a></h3>
|
|
|
<p>Default = True</p>
|
|
|
<p>Show animations, for example when opening and closing chat boxes.</p>
|
|
|
</div>
|
|
|
<div class="section" id="auto-list-rooms">
|
|
|
-<h3><a class="toc-backref" href="#id13">auto_list_rooms</a><a class="headerlink" href="#auto-list-rooms" title="Permalink to this headline">¶</a></h3>
|
|
|
+<h3><a class="toc-backref" href="#id18">auto_list_rooms</a><a class="headerlink" href="#auto-list-rooms" title="Permalink to this headline">¶</a></h3>
|
|
|
<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>
|
|
|
@@ -294,30 +328,30 @@ 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">
|
|
|
-<h3><a class="toc-backref" href="#id14">auto_subscribe</a><a class="headerlink" href="#auto-subscribe" title="Permalink to this headline">¶</a></h3>
|
|
|
+<h3><a class="toc-backref" href="#id19">auto_subscribe</a><a class="headerlink" href="#auto-subscribe" title="Permalink to this headline">¶</a></h3>
|
|
|
<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">
|
|
|
-<h3><a class="toc-backref" href="#id15">bosh_service_url</a><a class="headerlink" href="#bosh-service-url" title="Permalink to this headline">¶</a></h3>
|
|
|
+<h3><a class="toc-backref" href="#id20">bosh_service_url</a><a class="headerlink" href="#bosh-service-url" title="Permalink to this headline">¶</a></h3>
|
|
|
<p>Connections to an XMPP server depend on a BOSH connection manager which acts as
|
|
|
a middle man between HTTP and XMPP.</p>
|
|
|
-<p>See <a class="reference external" href="http://metajack.im/2008/09/08/which-bosh-server-do-you-need/l">here</a> for more information.</p>
|
|
|
+<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>
|
|
|
</div>
|
|
|
<div class="section" id="fullname">
|
|
|
-<h3><a class="toc-backref" href="#id16">fullname</a><a class="headerlink" href="#fullname" title="Permalink to this headline">¶</a></h3>
|
|
|
+<h3><a class="toc-backref" href="#id21">fullname</a><a class="headerlink" href="#fullname" title="Permalink to this headline">¶</a></h3>
|
|
|
<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">
|
|
|
-<h3><a class="toc-backref" href="#id17">hide_muc_server</a><a class="headerlink" href="#hide-muc-server" title="Permalink to this headline">¶</a></h3>
|
|
|
+<h3><a class="toc-backref" href="#id22">hide_muc_server</a><a class="headerlink" href="#hide-muc-server" title="Permalink to this headline">¶</a></h3>
|
|
|
<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>
|
|
|
</div>
|
|
|
<div class="section" id="prebind">
|
|
|
-<h3><a class="toc-backref" href="#id18">prebind</a><a class="headerlink" href="#prebind" title="Permalink to this headline">¶</a></h3>
|
|
|
+<h3><a class="toc-backref" href="#id23">prebind</a><a class="headerlink" href="#prebind" title="Permalink to this headline">¶</a></h3>
|
|
|
<p>Default = False</p>
|
|
|
<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>
|
|
|
@@ -338,7 +372,7 @@ have to write a Javascript snippet to attach to the set up connection:</p>
|
|
|
RID (Request ID), which you use when you attach to the connection.</p>
|
|
|
</div>
|
|
|
<div class="section" id="show-controlbox-by-default">
|
|
|
-<h3><a class="toc-backref" href="#id19">show_controlbox_by_default</a><a class="headerlink" href="#show-controlbox-by-default" title="Permalink to this headline">¶</a></h3>
|
|
|
+<h3><a class="toc-backref" href="#id24">show_controlbox_by_default</a><a class="headerlink" href="#show-controlbox-by-default" title="Permalink to this headline">¶</a></h3>
|
|
|
<p>Default = False</p>
|
|
|
<p>The “controlbox” refers to the special chatbox containing your contacts roster,
|
|
|
status widget, chatrooms and other controls.</p>
|
|
|
@@ -348,7 +382,7 @@ the page with class <em>toggle-online-users</em>.</p>
|
|
|
page load.</p>
|
|
|
</div>
|
|
|
<div class="section" id="xhr-user-search">
|
|
|
-<h3><a class="toc-backref" href="#id20">xhr_user_search</a><a class="headerlink" href="#xhr-user-search" title="Permalink to this headline">¶</a></h3>
|
|
|
+<h3><a class="toc-backref" href="#id25">xhr_user_search</a><a class="headerlink" href="#xhr-user-search" title="Permalink to this headline">¶</a></h3>
|
|
|
<p>Default = False</p>
|
|
|
<p>There are two ways to add users.</p>
|
|
|
<ul class="simple">
|
|
|
@@ -361,9 +395,9 @@ be used.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="section" id="minification">
|
|
|
-<h1><a class="toc-backref" href="#id21">Minification</a><a class="headerlink" href="#minification" title="Permalink to this headline">¶</a></h1>
|
|
|
+<h1><a class="toc-backref" href="#id26">Minification</a><a class="headerlink" href="#minification" title="Permalink to this headline">¶</a></h1>
|
|
|
<div class="section" id="minifying-javascript">
|
|
|
-<h2><a class="toc-backref" href="#id22">Minifying Javascript</a><a class="headerlink" href="#minifying-javascript" title="Permalink to this headline">¶</a></h2>
|
|
|
+<h2><a class="toc-backref" href="#id27">Minifying Javascript</a><a class="headerlink" href="#minifying-javascript" title="Permalink to this headline">¶</a></h2>
|
|
|
<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>
|
|
|
@@ -379,14 +413,14 @@ manager, NPM.</p>
|
|
|
<p>You can <a class="reference external" href="http://requirejs.org/docs/optimization.html">read more about require.js’s optimizer here</a>.</p>
|
|
|
</div>
|
|
|
<div class="section" id="minifying-css">
|
|
|
-<h2><a class="toc-backref" href="#id23">Minifying CSS</a><a class="headerlink" href="#minifying-css" title="Permalink to this headline">¶</a></h2>
|
|
|
+<h2><a class="toc-backref" href="#id28">Minifying CSS</a><a class="headerlink" href="#minifying-css" title="Permalink to this headline">¶</a></h2>
|
|
|
<p>CSS can be minimized with Yahoo’s yuicompressor tool:</p>
|
|
|
<div class="highlight-python"><pre>yui-compressor --type=css converse.css -o converse.min.css</pre>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="section" id="translations">
|
|
|
-<h1><a class="toc-backref" href="#id24">Translations</a><a class="headerlink" href="#translations" title="Permalink to this headline">¶</a></h1>
|
|
|
+<h1><a class="toc-backref" href="#id29">Translations</a><a class="headerlink" href="#translations" title="Permalink to this headline">¶</a></h1>
|
|
|
<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.
|
|
|
@@ -472,7 +506,7 @@ those hoops you had to jump through.</p>
|
|
|
<li class="right" style="margin-right: 10px">
|
|
|
<a href="genindex.html" title="General Index"
|
|
|
>index</a></li>
|
|
|
- <li><a href="#">Converse.js 0.3 documentation</a> »</li>
|
|
|
+ <li><a href="#">Converse.js 0.5 documentation</a> »</li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
</div>
|
JC Brand