|
@@ -7,7 +7,7 @@
|
|
|
<head>
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
|
|
- <title>Quickstart (to get a demo up and running) — Converse.js 0.6.4 documentation</title>
|
|
|
+ <title>Quickstart (to get a demo up and running) — Converse.js 0.6.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.6.4',
|
|
|
+ VERSION: '0.6.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.6.4 documentation" href="#" />
|
|
|
+ <link rel="top" title="Converse.js 0.6.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.6.4 documentation</a> »</li>
|
|
|
+ <li><a href="#">Converse.js 0.6.5 documentation</a> »</li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
<section id="main_content" class="inner">
|
|
@@ -95,26 +95,29 @@
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#configuration" id="id21">Configuration</a><ul>
|
|
|
<li><a class="reference internal" href="#configuration-variables" id="id22">Configuration variables</a><ul>
|
|
|
-<li><a class="reference internal" href="#animate" id="id23">animate</a></li>
|
|
|
-<li><a class="reference internal" href="#auto-list-rooms" id="id24">auto_list_rooms</a></li>
|
|
|
-<li><a class="reference internal" href="#auto-subscribe" id="id25">auto_subscribe</a></li>
|
|
|
-<li><a class="reference internal" href="#bosh-service-url" id="id26">bosh_service_url</a></li>
|
|
|
-<li><a class="reference internal" href="#debug" id="id27">debug</a></li>
|
|
|
-<li><a class="reference internal" href="#fullname" id="id28">fullname</a></li>
|
|
|
-<li><a class="reference internal" href="#hide-muc-server" id="id29">hide_muc_server</a></li>
|
|
|
-<li><a class="reference internal" href="#i18n" id="id30">i18n</a></li>
|
|
|
-<li><a class="reference internal" href="#prebind" id="id31">prebind</a></li>
|
|
|
-<li><a class="reference internal" href="#show-controlbox-by-default" id="id32">show_controlbox_by_default</a></li>
|
|
|
-<li><a class="reference internal" href="#xhr-user-search" id="id33">xhr_user_search</a></li>
|
|
|
+<li><a class="reference internal" href="#allow-contact-requests" id="id23">allow_contact_requests</a></li>
|
|
|
+<li><a class="reference internal" href="#allow-muc" id="id24">allow_muc</a></li>
|
|
|
+<li><a class="reference internal" href="#animate" id="id25">animate</a></li>
|
|
|
+<li><a class="reference internal" href="#auto-list-rooms" id="id26">auto_list_rooms</a></li>
|
|
|
+<li><a class="reference internal" href="#auto-subscribe" id="id27">auto_subscribe</a></li>
|
|
|
+<li><a class="reference internal" href="#bosh-service-url" id="id28">bosh_service_url</a></li>
|
|
|
+<li><a class="reference internal" href="#debug" id="id29">debug</a></li>
|
|
|
+<li><a class="reference internal" href="#fullname" id="id30">fullname</a></li>
|
|
|
+<li><a class="reference internal" href="#hide-muc-server" id="id31">hide_muc_server</a></li>
|
|
|
+<li><a class="reference internal" href="#i18n" id="id32">i18n</a></li>
|
|
|
+<li><a class="reference internal" href="#prebind" id="id33">prebind</a></li>
|
|
|
+<li><a class="reference internal" href="#show-controlbox-by-default" id="id34">show_controlbox_by_default</a></li>
|
|
|
+<li><a class="reference internal" href="#show-only-online-users" id="id35">show_only_online_users</a></li>
|
|
|
+<li><a class="reference internal" href="#xhr-user-search" id="id36">xhr_user_search</a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
-<li><a class="reference internal" href="#minification" id="id34">Minification</a><ul>
|
|
|
-<li><a class="reference internal" href="#minifying-javascript-and-css" id="id35">Minifying Javascript and CSS</a></li>
|
|
|
+<li><a class="reference internal" href="#minification" id="id37">Minification</a><ul>
|
|
|
+<li><a class="reference internal" href="#minifying-javascript-and-css" id="id38">Minifying Javascript and CSS</a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
-<li><a class="reference internal" href="#translations" id="id36">Translations</a></li>
|
|
|
+<li><a class="reference internal" href="#translations" id="id39">Translations</a></li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
<div class="section" id="quickstart-to-get-a-demo-up-and-running">
|
|
@@ -453,14 +456,28 @@ 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="#id22">Configuration variables</a><a class="headerlink" href="#configuration-variables" title="Permalink to this headline">¶</a></h2>
|
|
|
+<div class="section" id="allow-contact-requests">
|
|
|
+<h3><a class="toc-backref" href="#id23">allow_contact_requests</a><a class="headerlink" href="#allow-contact-requests" title="Permalink to this headline">¶</a></h3>
|
|
|
+<p>Default = <tt class="docutils literal"><span class="pre">true</span></tt></p>
|
|
|
+<p>Allow users to add one another as contacts. If this is set to false, the
|
|
|
+<strong>Add a contact</strong> widget, <strong>Contact Requests</strong> and <strong>Pending Contacts</strong> roster
|
|
|
+sections will all not appear. Additionally, all incoming contact requests will be
|
|
|
+ignored.</p>
|
|
|
+</div>
|
|
|
+<div class="section" id="allow-muc">
|
|
|
+<h3><a class="toc-backref" href="#id24">allow_muc</a><a class="headerlink" href="#allow-muc" title="Permalink to this headline">¶</a></h3>
|
|
|
+<p>Default = <tt class="docutils literal"><span class="pre">true</span></tt></p>
|
|
|
+<p>Allow multi-user chat (muc) in chatrooms. Setting this to <tt class="docutils literal"><span class="pre">false</span></tt> will remove
|
|
|
+the <tt class="docutils literal"><span class="pre">Chatrooms</span></tt> tab from the control box.</p>
|
|
|
+</div>
|
|
|
<div class="section" id="animate">
|
|
|
-<h3><a class="toc-backref" href="#id23">animate</a><a class="headerlink" href="#animate" title="Permalink to this headline">¶</a></h3>
|
|
|
-<p>Default = True</p>
|
|
|
+<h3><a class="toc-backref" href="#id25">animate</a><a class="headerlink" href="#animate" title="Permalink to this headline">¶</a></h3>
|
|
|
+<p>Default = <tt class="docutils literal"><span class="pre">true</span></tt></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="#id24">auto_list_rooms</a><a class="headerlink" href="#auto-list-rooms" title="Permalink to this headline">¶</a></h3>
|
|
|
-<p>Default = False</p>
|
|
|
+<h3><a class="toc-backref" href="#id26">auto_list_rooms</a><a class="headerlink" href="#auto-list-rooms" title="Permalink to this headline">¶</a></h3>
|
|
|
+<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></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>
|
|
@@ -469,40 +486,41 @@ 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="#id25">auto_subscribe</a><a class="headerlink" href="#auto-subscribe" title="Permalink to this headline">¶</a></h3>
|
|
|
-<p>Default = False</p>
|
|
|
+<h3><a class="toc-backref" href="#id27">auto_subscribe</a><a class="headerlink" href="#auto-subscribe" title="Permalink to this headline">¶</a></h3>
|
|
|
+<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></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="#id26">bosh_service_url</a><a class="headerlink" href="#bosh-service-url" title="Permalink to this headline">¶</a></h3>
|
|
|
+<h3><a class="toc-backref" href="#id28">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">here</a> for more information.</p>
|
|
|
</div>
|
|
|
<div class="section" id="debug">
|
|
|
-<h3><a class="toc-backref" href="#id27">debug</a><a class="headerlink" href="#debug" title="Permalink to this headline">¶</a></h3>
|
|
|
+<h3><a class="toc-backref" href="#id29">debug</a><a class="headerlink" href="#debug" title="Permalink to this headline">¶</a></h3>
|
|
|
+<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
|
|
|
<p>If set to true, debugging output will be logged to the browser console.</p>
|
|
|
</div>
|
|
|
<div class="section" id="fullname">
|
|
|
-<h3><a class="toc-backref" href="#id28">fullname</a><a class="headerlink" href="#fullname" title="Permalink to this headline">¶</a></h3>
|
|
|
+<h3><a class="toc-backref" href="#id30">fullname</a><a class="headerlink" href="#fullname" title="Permalink to this headline">¶</a></h3>
|
|
|
<p>If you are using prebinding, can specify the fullname of the currently
|
|
|
logged in user, otherwise the user’s vCard will be fetched.</p>
|
|
|
</div>
|
|
|
<div class="section" id="hide-muc-server">
|
|
|
-<h3><a class="toc-backref" href="#id29">hide_muc_server</a><a class="headerlink" href="#hide-muc-server" title="Permalink to this headline">¶</a></h3>
|
|
|
-<p>Default = false</p>
|
|
|
+<h3><a class="toc-backref" href="#id31">hide_muc_server</a><a class="headerlink" href="#hide-muc-server" title="Permalink to this headline">¶</a></h3>
|
|
|
+<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></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="i18n">
|
|
|
-<h3><a class="toc-backref" href="#id30">i18n</a><a class="headerlink" href="#i18n" title="Permalink to this headline">¶</a></h3>
|
|
|
+<h3><a class="toc-backref" href="#id32">i18n</a><a class="headerlink" href="#i18n" title="Permalink to this headline">¶</a></h3>
|
|
|
<p>Specify the locale/language. The language must be in the <tt class="docutils literal"><span class="pre">locales</span></tt> object. Refer to
|
|
|
<tt class="docutils literal"><span class="pre">./locale/locales.js</span></tt> to see which locales are supported.</p>
|
|
|
</div>
|
|
|
<div class="section" id="prebind">
|
|
|
-<h3><a class="toc-backref" href="#id31">prebind</a><a class="headerlink" href="#prebind" title="Permalink to this headline">¶</a></h3>
|
|
|
-<p>Default = false</p>
|
|
|
+<h3><a class="toc-backref" href="#id33">prebind</a><a class="headerlink" href="#prebind" title="Permalink to this headline">¶</a></h3>
|
|
|
+<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></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>
|
|
|
<p>This is useful when you don’t want to render the login form on the chat control
|
|
@@ -514,8 +532,8 @@ values as <tt class="docutils literal"><span class="pre">jid</span></tt>, <tt cl
|
|
|
<p>Additionally, you have to specify <tt class="docutils literal"><span class="pre">bosh_service_url</span></tt>.</p>
|
|
|
</div>
|
|
|
<div class="section" id="show-controlbox-by-default">
|
|
|
-<h3><a class="toc-backref" href="#id32">show_controlbox_by_default</a><a class="headerlink" href="#show-controlbox-by-default" title="Permalink to this headline">¶</a></h3>
|
|
|
-<p>Default = false</p>
|
|
|
+<h3><a class="toc-backref" href="#id34">show_controlbox_by_default</a><a class="headerlink" href="#show-controlbox-by-default" title="Permalink to this headline">¶</a></h3>
|
|
|
+<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
|
|
|
<p>The “controlbox” 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
|
|
@@ -523,9 +541,15 @@ 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>
|
|
|
+<div class="section" id="show-only-online-users">
|
|
|
+<h3><a class="toc-backref" href="#id35">show_only_online_users</a><a class="headerlink" href="#show-only-online-users" title="Permalink to this headline">¶</a></h3>
|
|
|
+<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
|
|
|
+<p>If set to <tt class="docutils literal"><span class="pre">true</span></tt>, only online users will be shown in the contacts roster.
|
|
|
+Users with any other status (e.g. away, busy etc.) will not be shown.</p>
|
|
|
+</div>
|
|
|
<div class="section" id="xhr-user-search">
|
|
|
-<h3><a class="toc-backref" href="#id33">xhr_user_search</a><a class="headerlink" href="#xhr-user-search" title="Permalink to this headline">¶</a></h3>
|
|
|
-<p>Default = False</p>
|
|
|
+<h3><a class="toc-backref" href="#id36">xhr_user_search</a><a class="headerlink" href="#xhr-user-search" title="Permalink to this headline">¶</a></h3>
|
|
|
+<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
|
|
|
<p>There are two ways to add users.</p>
|
|
|
<ul class="simple">
|
|
|
<li>The user inputs a valid JID (Jabber ID), and the user is added as a pending contact.</li>
|
|
@@ -537,9 +561,9 @@ be used.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="section" id="minification">
|
|
|
-<h1><a class="toc-backref" href="#id34">Minification</a><a class="headerlink" href="#minification" title="Permalink to this headline">¶</a></h1>
|
|
|
+<h1><a class="toc-backref" href="#id37">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="#id35">Minifying Javascript and CSS</a><a class="headerlink" href="#minifying-javascript-and-css" title="Permalink to this headline">¶</a></h2>
|
|
|
+<h2><a class="toc-backref" href="#id38">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>
|
|
@@ -564,7 +588,7 @@ You can <a class="reference external" href="http://requirejs.org/docs/optimizati
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="section" id="translations">
|
|
|
-<h1><a class="toc-backref" href="#id36">Translations</a><a class="headerlink" href="#translations" title="Permalink to this headline">¶</a></h1>
|
|
|
+<h1><a class="toc-backref" href="#id39">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.
|
|
@@ -653,7 +677,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.6.4 documentation</a> »</li>
|
|
|
+ <li><a href="#">Converse.js 0.6.5 documentation</a> »</li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
</div>
|