Przeglądaj źródła

Update docs and regenerate

JC Brand 11 lat temu
rodzic
commit
fe7c297acc

BIN
docs/doctrees/index.doctree


+ 3 - 9
docs/html/_sources/index.txt

@@ -616,15 +616,9 @@ To minify the Javascript and CSS, run the following command:
 
 
     grunt minify
     grunt minify
 
 
-.. Note ::
-   Since release 0.6.0, I'm using `almond <https://github.com/jrburke/almond>`_
-   instead of `require.js <http://requirejs.org>`_. The
-   `grunt-contrib-requirejs <https://github.com/gruntjs/grunt-contrib-requirejs>`_
-   plugin however doesn't support *almond*. I therefore now build it manually
-   (the old way again), like this: ``r.js -o build.js``. CSS can be minimized
-   separately via ``grunt cssmin``.
-
-Javascript will be bundled and minified via `require.js`_'s optimization tool.
+Javascript will be bundled and minified with `require.js`_'s optimization tool,
+using `almond <https://github.com/jrburke/almond>`_.
+
 You can `read more about require.js's optimizer here`_.
 You can `read more about require.js's optimizer here`_.
 
 
 CSS is minified via `cssmin <https://github.com/gruntjs/grunt-contrib-cssmin>`_.
 CSS is minified via `cssmin <https://github.com/gruntjs/grunt-contrib-cssmin>`_.

+ 75 - 83
docs/html/index.html

@@ -65,62 +65,62 @@
 <div class="contents local topic" id="table-of-contents">
 <div class="contents local topic" id="table-of-contents">
 <p class="topic-title first">Table of Contents</p>
 <p class="topic-title first">Table of Contents</p>
 <ul class="simple">
 <ul class="simple">
-<li><a class="reference internal" href="#quickstart-to-get-a-demo-up-and-running" id="id3">Quickstart (to get a demo up and running)</a></li>
-<li><a class="reference internal" href="#introduction" id="id4">Introduction</a></li>
-<li><a class="reference internal" href="#what-you-will-need" id="id5">What you will need</a><ul>
-<li><a class="reference internal" href="#an-xmpp-jabber-server" id="id6">An XMPP/Jabber server</a></li>
-<li><a class="reference internal" href="#connection-manager" id="id7">Connection Manager</a><ul>
-<li><a class="reference internal" href="#overcoming-cross-domain-request-restrictions" id="id8">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>
 </ul>
 </li>
 </li>
-<li><a class="reference internal" href="#server-side-authentication" id="id9">Server-side authentication</a><ul>
-<li><a class="reference internal" href="#pre-binding-and-single-session-support" id="id10">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>
 </ul>
 </li>
 </li>
-<li><a class="reference internal" href="#facebook-integration" id="id11">Facebook integration</a></li>
+<li><a class="reference internal" href="#facebook-integration" id="id10">Facebook integration</a></li>
 </ul>
 </ul>
 </li>
 </li>
-<li><a class="reference internal" href="#development" id="id12">Development</a><ul>
-<li><a class="reference internal" href="#install-node-js-and-development-dependencies" id="id13">Install Node.js and development dependencies</a></li>
-<li><a class="reference internal" href="#install-3rd-party-dependencies" id="id14">Install 3rd party dependencies</a></li>
-<li><a class="reference internal" href="#with-amd-and-require-js-recommended" id="id15">With AMD and require.js (recommended)</a></li>
-<li><a class="reference internal" href="#without-amd-and-require-js" id="id16">Without AMD and require.js</a></li>
-<li><a class="reference internal" href="#before-submitting-a-pull-request" id="id17">Before submitting a pull request</a><ul>
-<li><a class="reference internal" href="#add-tests-for-your-bugfix-or-feature" id="id18">Add tests for your bugfix or feature</a></li>
-<li><a class="reference internal" href="#check-that-the-tests-pass" id="id19">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="id20">Check your code for errors or bad habits by running JSHint</a></li>
+<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>
 </ul>
 </ul>
 </li>
 </li>
 </ul>
 </ul>
 </li>
 </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="#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="#xhr-user-search" id="id35">xhr_user_search</a></li>
+<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="#allow-contact-requests" id="id22">allow_contact_requests</a></li>
+<li><a class="reference internal" href="#allow-muc" id="id23">allow_muc</a></li>
+<li><a class="reference internal" href="#animate" id="id24">animate</a></li>
+<li><a class="reference internal" href="#auto-list-rooms" id="id25">auto_list_rooms</a></li>
+<li><a class="reference internal" href="#auto-subscribe" id="id26">auto_subscribe</a></li>
+<li><a class="reference internal" href="#bosh-service-url" id="id27">bosh_service_url</a></li>
+<li><a class="reference internal" href="#debug" id="id28">debug</a></li>
+<li><a class="reference internal" href="#fullname" id="id29">fullname</a></li>
+<li><a class="reference internal" href="#hide-muc-server" id="id30">hide_muc_server</a></li>
+<li><a class="reference internal" href="#i18n" id="id31">i18n</a></li>
+<li><a class="reference internal" href="#prebind" id="id32">prebind</a></li>
+<li><a class="reference internal" href="#show-controlbox-by-default" id="id33">show_controlbox_by_default</a></li>
+<li><a class="reference internal" href="#xhr-user-search" id="id34">xhr_user_search</a></li>
 </ul>
 </ul>
 </li>
 </li>
 </ul>
 </ul>
 </li>
 </li>
-<li><a class="reference internal" href="#minification" id="id36">Minification</a><ul>
-<li><a class="reference internal" href="#minifying-javascript-and-css" id="id37">Minifying Javascript and CSS</a></li>
+<li><a class="reference internal" href="#minification" id="id35">Minification</a><ul>
+<li><a class="reference internal" href="#minifying-javascript-and-css" id="id36">Minifying Javascript and CSS</a></li>
 </ul>
 </ul>
 </li>
 </li>
-<li><a class="reference internal" href="#translations" id="id38">Translations</a></li>
+<li><a class="reference internal" href="#translations" id="id37">Translations</a></li>
 </ul>
 </ul>
 </div>
 </div>
 <div class="section" id="quickstart-to-get-a-demo-up-and-running">
 <div class="section" id="quickstart-to-get-a-demo-up-and-running">
-<h1><a class="toc-backref" href="#id3">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>
+<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>
 <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">
 <ul class="simple">
 <li>converse.min.js</li>
 <li>converse.min.js</li>
@@ -174,7 +174,7 @@ the minified Javascript file. Read <a class="reference internal" href="#configur
 that.</p>
 that.</p>
 </div>
 </div>
 <div class="section" id="introduction">
 <div class="section" id="introduction">
-<h1><a class="toc-backref" href="#id4">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>
 <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 &#8220;Software-as-a-service&#8221; (SaaS)
 website, <em>Converse.js</em> is not really meant to be a &#8220;Software-as-a-service&#8221; (SaaS)
 webchat.</p>
 webchat.</p>
@@ -193,9 +193,9 @@ code.</p>
 requirements.</p>
 requirements.</p>
 </div>
 </div>
 <div class="section" id="what-you-will-need">
 <div class="section" id="what-you-will-need">
-<h1><a class="toc-backref" href="#id5">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">
 <div class="section" id="an-xmpp-jabber-server">
-<h2><a class="toc-backref" href="#id6">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
 <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>
 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
 <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
@@ -204,7 +204,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>
 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>
 <div class="section" id="connection-manager">
 <div class="section" id="connection-manager">
-<h2><a class="toc-backref" href="#id7">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
 <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>
 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
 <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
@@ -219,7 +219,7 @@ includes a connection manager (but you have to enable it).</p>
 This connection manager is for testing purposes only, please don&#8217;t use it in
 This connection manager is for testing purposes only, please don&#8217;t use it in
 production.</p>
 production.</p>
 <div class="section" id="overcoming-cross-domain-request-restrictions">
 <div class="section" id="overcoming-cross-domain-request-restrictions">
-<h3><a class="toc-backref" href="#id8">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>.
 <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).
 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
 Until recently, it was not possible to make such requests to a different domain
@@ -268,9 +268,9 @@ the cross-domain restriction is <tt class="docutils literal"><span class="pre">m
 </div>
 </div>
 </div>
 </div>
 <div class="section" id="server-side-authentication">
 <div class="section" id="server-side-authentication">
-<h2><a class="toc-backref" href="#id9">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">
 <div class="section" id="pre-binding-and-single-session-support">
-<span id="session-support"></span><h3><a class="toc-backref" href="#id10">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&#8217;s possible to enable single-site login, whereby users already
 <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,
 authenticated in your website will also automatically be logged in on the chat server,
 but this will require custom code on your server.</p>
 but this will require custom code on your server.</p>
@@ -306,7 +306,7 @@ BOSH connection manager.</p>
 </div>
 </div>
 </div>
 </div>
 <div class="section" id="facebook-integration">
 <div class="section" id="facebook-integration">
-<h2><a class="toc-backref" href="#id11">Facebook integration</a><a class="headerlink" href="#facebook-integration" title="Permalink to this headline">¶</a></h2>
+<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">
 <div class="admonition note">
 <p class="first admonition-title">Note</p>
 <p class="first admonition-title">Note</p>
 <p class="last">It should be possible to integrate Converse.js with Facebook chat, and
 <p class="last">It should be possible to integrate Converse.js with Facebook chat, and
@@ -349,13 +349,13 @@ Until then, people will have to do this themselves.</p>
 </div>
 </div>
 </div>
 </div>
 <div class="section" id="development">
 <div class="section" id="development">
-<h1><a class="toc-backref" href="#id12">Development</a><a class="headerlink" href="#development" title="Permalink to this headline">¶</a></h1>
+<h1><a class="toc-backref" href="#id11">Development</a><a class="headerlink" href="#development" title="Permalink to this headline">¶</a></h1>
 <p>If you want to work with the non-minified Javascript and CSS files you&#8217;ll soon
 <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
 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
 follow the instructions below to create this folder and fetch Converse&#8217;s
 3rd-party dependencies.</p>
 3rd-party dependencies.</p>
 <div class="section" id="install-node-js-and-development-dependencies">
 <div class="section" id="install-node-js-and-development-dependencies">
-<h2><a class="toc-backref" href="#id13">Install Node.js and development dependencies</a><a class="headerlink" href="#install-node-js-and-development-dependencies" title="Permalink to this headline">¶</a></h2>
+<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>
 <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>)
 <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>
 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
 <p>If you don&#8217;t have Node.js installed, you can download and install the latest
@@ -369,7 +369,7 @@ curious to know what these are, take a look at whats under the <em>devDependenci
 <cite>package.json &lt;https://github.com/jcbrand/converse.js/blob/master/package.json&gt;</cite>.</p>
 <cite>package.json &lt;https://github.com/jcbrand/converse.js/blob/master/package.json&gt;</cite>.</p>
 </div>
 </div>
 <div class="section" id="install-3rd-party-dependencies">
 <div class="section" id="install-3rd-party-dependencies">
-<h2><a class="toc-backref" href="#id14">Install 3rd party dependencies</a><a class="headerlink" href="#install-3rd-party-dependencies" title="Permalink to this headline">¶</a></h2>
+<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>
 <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>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
 <p>We use Bower to manage Converse&#8217;s front-end dependencies (e.g. Javascript that
 should get loaded in the browser).</p>
 should get loaded in the browser).</p>
@@ -387,7 +387,7 @@ dependencies (like backbone.js, strophe.js etc.) and then put them in the
 <em>components</em> folder.</p>
 <em>components</em> folder.</p>
 </div>
 </div>
 <div class="section" id="with-amd-and-require-js-recommended">
 <div class="section" id="with-amd-and-require-js-recommended">
-<h2><a class="toc-backref" href="#id15">With AMD and require.js (recommended)</a><a class="headerlink" href="#with-amd-and-require-js-recommended" title="Permalink to this headline">¶</a></h2>
+<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>
 <p>Converse.js uses <a class="reference external" href="http://requirejs.org">require.js</a> to asynchronously load dependencies.</p>
 <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&#8217;ll want to load the
 <p>If you want to develop or customize converse.js, you&#8217;ll want to load the
 non-minified javascript files.</p>
 non-minified javascript files.</p>
@@ -400,7 +400,7 @@ attribute on the <em>script</em> tag), which will in turn cause converse.js to b
 parsed.</p>
 parsed.</p>
 </div>
 </div>
 <div class="section" id="without-amd-and-require-js">
 <div class="section" id="without-amd-and-require-js">
-<h2><a class="toc-backref" href="#id16">Without AMD and require.js</a><a class="headerlink" href="#without-amd-and-require-js" title="Permalink to this headline">¶</a></h2>
+<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>
 <p>Converse.js can also be used without require.js. If you for some reason prefer
 <p>Converse.js can also be used without require.js. If you for some reason prefer
 to use it this way, please refer to
 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>
 <a class="reference external" href="https://github.com/jcbrand/converse.js/blob/master/non_amd.html">non_amd.html</a>
@@ -408,9 +408,9 @@ for an example of how and in what order all the Javascript files that converse.j
 depends on need to be loaded.</p>
 depends on need to be loaded.</p>
 </div>
 </div>
 <div class="section" id="before-submitting-a-pull-request">
 <div class="section" id="before-submitting-a-pull-request">
-<h2><a class="toc-backref" href="#id17">Before submitting a pull request</a><a class="headerlink" href="#before-submitting-a-pull-request" title="Permalink to this headline">¶</a></h2>
+<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>
 <div class="section" id="add-tests-for-your-bugfix-or-feature">
 <div class="section" id="add-tests-for-your-bugfix-or-feature">
-<h3><a class="toc-backref" href="#id18">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>
+<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>
 <p>Add a test for any bug fixed or feature added. We use Jasmine
 <p>Add a test for any bug fixed or feature added. We use Jasmine
 for testing.</p>
 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
 <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
@@ -419,7 +419,7 @@ the tests are implemented.</p>
 <a class="reference external" href="http://opkode.com/contact">contact me</a> and I&#8217;ll be happy to help.</p>
 <a class="reference external" href="http://opkode.com/contact">contact me</a> and I&#8217;ll be happy to help.</p>
 </div>
 </div>
 <div class="section" id="check-that-the-tests-pass">
 <div class="section" id="check-that-the-tests-pass">
-<h3><a class="toc-backref" href="#id19">Check that the tests pass</a><a class="headerlink" href="#check-that-the-tests-pass" title="Permalink to this headline">¶</a></h3>
+<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>
 <p>Check that the Jasmine tests complete sucessfully. Open
 <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>
 <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>
 in your browser, and the tests will run automatically.</p>
@@ -428,7 +428,7 @@ in your browser, and the tests will run automatically.</p>
 </div>
 </div>
 </div>
 </div>
 <div class="section" id="check-your-code-for-errors-or-bad-habits-by-running-jshint">
 <div class="section" id="check-your-code-for-errors-or-bad-habits-by-running-jshint">
-<h3><a class="toc-backref" href="#id20">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>
+<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>
 <p><a class="reference external" href="http://jshint.com">JSHint</a> will do a static analysis of your code and hightlight potential errors
 <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>
 and/or bad habits.</p>
 <div class="highlight-python"><pre>grunt jshint</pre>
 <div class="highlight-python"><pre>grunt jshint</pre>
@@ -440,7 +440,7 @@ and/or bad habits.</p>
 </div>
 </div>
 </div>
 </div>
 <div class="section" id="configuration">
 <div class="section" id="configuration">
-<h1><a class="toc-backref" href="#id21">Configuration</a><a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h1>
+<h1><a class="toc-backref" href="#id20">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
 <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
 you&#8217;ll want to configure <em>Converse.js</em> to suit your needs before you deploy it
 on your website.</p>
 on your website.</p>
@@ -454,9 +454,9 @@ all the available configuration settings.</p>
 JS file so that it will include the new settings. Please refer to the
 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>
 <a class="reference internal" href="#minification">Minification</a> section for more info on how to do this.</p>
 <div class="section" id="configuration-variables">
 <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>
+<h2><a class="toc-backref" href="#id21">Configuration variables</a><a class="headerlink" href="#configuration-variables" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="allow-contact-requests">
 <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>
+<h3><a class="toc-backref" href="#id22">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>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
 <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
 <strong>Add a contact</strong> widget, <strong>Contact Requests</strong> and <strong>Pending Contacts</strong> roster
@@ -464,18 +464,18 @@ sections will all not appear. Additionally, all incoming contact requests will b
 ignored.</p>
 ignored.</p>
 </div>
 </div>
 <div class="section" id="allow-muc">
 <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>
+<h3><a class="toc-backref" href="#id23">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>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
 <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>
 the <tt class="docutils literal"><span class="pre">Chatrooms</span></tt> tab from the control box.</p>
 </div>
 </div>
 <div class="section" id="animate">
 <div class="section" id="animate">
-<h3><a class="toc-backref" href="#id25">animate</a><a class="headerlink" href="#animate" title="Permalink to this headline">¶</a></h3>
+<h3><a class="toc-backref" href="#id24">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>Default = <tt class="docutils literal"><span class="pre">true</span></tt></p>
 <p>Show animations, for example when opening and closing chat boxes.</p>
 <p>Show animations, for example when opening and closing chat boxes.</p>
 </div>
 </div>
 <div class="section" id="auto-list-rooms">
 <div class="section" id="auto-list-rooms">
-<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>
+<h3><a class="toc-backref" href="#id25">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>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
 <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>
 multi-user chat, then a list of rooms on that server will be fetched.</p>
@@ -485,40 +485,40 @@ features, number of occupants etc.), so on servers with many rooms this
 option will create lots of extra connection traffic.</p>
 option will create lots of extra connection traffic.</p>
 </div>
 </div>
 <div class="section" id="auto-subscribe">
 <div class="section" id="auto-subscribe">
-<h3><a class="toc-backref" href="#id27">auto_subscribe</a><a class="headerlink" href="#auto-subscribe" title="Permalink to this headline">¶</a></h3>
+<h3><a class="toc-backref" href="#id26">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>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>
 <p>If true, the user will automatically subscribe back to any contact requests.</p>
 </div>
 </div>
 <div class="section" id="bosh-service-url">
 <div class="section" id="bosh-service-url">
-<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>
+<h3><a class="toc-backref" href="#id27">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
 <p>Connections to an XMPP server depend on a BOSH connection manager which acts as
 a middle man between HTTP and XMPP.</p>
 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>
 <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>
 <div class="section" id="debug">
 <div class="section" id="debug">
-<h3><a class="toc-backref" href="#id29">debug</a><a class="headerlink" href="#debug" title="Permalink to this headline">¶</a></h3>
+<h3><a class="toc-backref" href="#id28">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>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>
 <p>If set to true, debugging output will be logged to the browser console.</p>
 </div>
 </div>
 <div class="section" id="fullname">
 <div class="section" id="fullname">
-<h3><a class="toc-backref" href="#id30">fullname</a><a class="headerlink" href="#fullname" title="Permalink to this headline">¶</a></h3>
+<h3><a class="toc-backref" href="#id29">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
 <p>If you are using prebinding, can specify the fullname of the currently
 logged in user, otherwise the user&#8217;s vCard will be fetched.</p>
 logged in user, otherwise the user&#8217;s vCard will be fetched.</p>
 </div>
 </div>
 <div class="section" id="hide-muc-server">
 <div class="section" id="hide-muc-server">
-<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>
+<h3><a class="toc-backref" href="#id30">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>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
 <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
 controlbox. Useful if you want to restrict users to a specific XMPP server of
 your choosing.</p>
 your choosing.</p>
 </div>
 </div>
 <div class="section" id="i18n">
 <div class="section" id="i18n">
-<h3><a class="toc-backref" href="#id32">i18n</a><a class="headerlink" href="#i18n" title="Permalink to this headline">¶</a></h3>
+<h3><a class="toc-backref" href="#id31">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
 <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>
 <tt class="docutils literal"><span class="pre">./locale/locales.js</span></tt> to see which locales are supported.</p>
 </div>
 </div>
 <div class="section" id="prebind">
 <div class="section" id="prebind">
-<h3><a class="toc-backref" href="#id33">prebind</a><a class="headerlink" href="#prebind" title="Permalink to this headline">¶</a></h3>
+<h3><a class="toc-backref" href="#id32">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>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
 <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>
 already authenticated (usually on the backend before page load).</p>
@@ -531,7 +531,7 @@ 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>
 <p>Additionally, you have to specify <tt class="docutils literal"><span class="pre">bosh_service_url</span></tt>.</p>
 </div>
 </div>
 <div class="section" id="show-controlbox-by-default">
 <div class="section" id="show-controlbox-by-default">
-<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>
+<h3><a class="toc-backref" href="#id33">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>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
 <p>The &#8220;controlbox&#8221; refers to the special chatbox containing your contacts roster,
 <p>The &#8220;controlbox&#8221; refers to the special chatbox containing your contacts roster,
 status widget, chatrooms and other controls.</p>
 status widget, chatrooms and other controls.</p>
@@ -541,7 +541,7 @@ the page with class <em>toggle-online-users</em>.</p>
 page load.</p>
 page load.</p>
 </div>
 </div>
 <div class="section" id="xhr-user-search">
 <div class="section" id="xhr-user-search">
-<h3><a class="toc-backref" href="#id35">xhr_user_search</a><a class="headerlink" href="#xhr-user-search" title="Permalink to this headline">¶</a></h3>
+<h3><a class="toc-backref" href="#id34">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>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
 <p>There are two ways to add users.</p>
 <p>There are two ways to add users.</p>
 <ul class="simple">
 <ul class="simple">
@@ -554,9 +554,9 @@ be used.</p>
 </div>
 </div>
 </div>
 </div>
 <div class="section" id="minification">
 <div class="section" id="minification">
-<h1><a class="toc-backref" href="#id36">Minification</a><a class="headerlink" href="#minification" title="Permalink to this headline">¶</a></h1>
+<h1><a class="toc-backref" href="#id35">Minification</a><a class="headerlink" href="#minification" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="minifying-javascript-and-css">
 <div class="section" id="minifying-javascript-and-css">
-<h2><a class="toc-backref" href="#id37">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="#id36">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
 <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>
 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>
 and then <tt class="docutils literal"><span class="pre">grunt</span> <span class="pre">fetch</span></tt>).</p>
@@ -566,22 +566,14 @@ production site.</p>
 <p>To minify the Javascript and CSS, run the following command:</p>
 <p>To minify the Javascript and CSS, run the following command:</p>
 <div class="highlight-python"><pre>grunt minify</pre>
 <div class="highlight-python"><pre>grunt minify</pre>
 </div>
 </div>
-<div class="admonition note">
-<p class="first admonition-title">Note</p>
-<p class="last">Since release 0.6.0, I&#8217;m using <a class="reference external" href="https://github.com/jrburke/almond">almond</a>
-instead of <a class="reference external" href="http://requirejs.org">require.js</a>. The
-<a class="reference external" href="https://github.com/gruntjs/grunt-contrib-requirejs">grunt-contrib-requirejs</a>
-plugin however doesn&#8217;t support <em>almond</em>. I therefore now build it manually
-(the old way again), like this: <tt class="docutils literal"><span class="pre">r.js</span> <span class="pre">-o</span> <span class="pre">build.js</span></tt>. CSS can be minimized
-separately via <tt class="docutils literal"><span class="pre">grunt</span> <span class="pre">cssmin</span></tt>.</p>
-</div>
-<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>Javascript will be bundled and minified with <a class="reference external" href="http://requirejs.org">require.js</a>&#8216;s optimization tool,
+using <a class="reference external" href="https://github.com/jrburke/almond">almond</a>.</p>
+<p>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>
 <p>CSS is minified via <a class="reference external" href="https://github.com/gruntjs/grunt-contrib-cssmin">cssmin</a>.</p>
 </div>
 </div>
 </div>
 </div>
 <div class="section" id="translations">
 <div class="section" id="translations">
-<h1><a class="toc-backref" href="#id38">Translations</a><a class="headerlink" href="#translations" title="Permalink to this headline">¶</a></h1>
+<h1><a class="toc-backref" href="#id37">Translations</a><a class="headerlink" href="#translations" title="Permalink to this headline">¶</a></h1>
 <div class="admonition note">
 <div class="admonition note">
 <p class="first admonition-title">Note</p>
 <p class="first admonition-title">Note</p>
 <p class="last">Translations take up a lot of space and will bloat your minified file.
 <p class="last">Translations take up a lot of space and will bloat your minified file.

Plik diff jest za duży
+ 0 - 0
docs/html/searchindex.js


+ 3 - 9
docs/source/index.rst

@@ -616,15 +616,9 @@ To minify the Javascript and CSS, run the following command:
 
 
     grunt minify
     grunt minify
 
 
-.. Note ::
-   Since release 0.6.0, I'm using `almond <https://github.com/jrburke/almond>`_
-   instead of `require.js <http://requirejs.org>`_. The
-   `grunt-contrib-requirejs <https://github.com/gruntjs/grunt-contrib-requirejs>`_
-   plugin however doesn't support *almond*. I therefore now build it manually
-   (the old way again), like this: ``r.js -o build.js``. CSS can be minimized
-   separately via ``grunt cssmin``.
-
-Javascript will be bundled and minified via `require.js`_'s optimization tool.
+Javascript will be bundled and minified with `require.js`_'s optimization tool,
+using `almond <https://github.com/jrburke/almond>`_.
+
 You can `read more about require.js's optimizer here`_.
 You can `read more about require.js's optimizer here`_.
 
 
 CSS is minified via `cssmin <https://github.com/gruntjs/grunt-contrib-cssmin>`_.
 CSS is minified via `cssmin <https://github.com/gruntjs/grunt-contrib-cssmin>`_.

Niektóre pliki nie zostały wyświetlone z powodu dużej ilości zmienionych plików