Regenerated docs

a864a7c4 · JC Brand · eb7749e6 · a864a7c4 · a864a7c4 · a864a7c4
Commit a864a7c4 authored Aug 23, 2014 by JC Brand
16 changed files
--- a/docs/doctrees/index.doctree
+++ b/docs/doctrees/index.doctree
--- a/docs/html/.buildinfo
+++ b/docs/html/.buildinfo
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: ec38a6fc765fb5f09e06d01a6497e5a9
-tags: fbb0d17656682115ca4d033fb2f83ba1
+config: a0a7e72b005f3e05b1780540e63bba52
+tags: 645f666f9bcd5a90fca523b33c5a78b7
--- a/docs/html/_sources/index.txt
+++ b/docs/html/_sources/index.txt
@@ -384,6 +384,10 @@ notice that there are references to a missing *components* folder. Please
 follow the instructions below to create this folder and fetch Converse's
 3rd-party dependencies.

+.. Note:
+    Users have reported that converse.js cannot be built on Windows. Patches to
+    fix this are welcome.
+

 Install the development and front-end dependencies
 ==================================================
@@ -403,11 +407,18 @@ directory:

    make dev

+Or alternatively, if you don't have GNU Make:
+
+::
+
+    npm install
+    bower update
+
 This will first install the Node.js development tools (like Grunt and Bower)
 and then use Bower to install all of Converse.js's front-end dependencies.

 The front-end dependencies are those javascript files on which
-Converse.js directly depends and which will therefore be loaded in the browser.
+Converse.js directly depends and which will be loaded in the browser.

 If you are curious to know what the different dependencies are:

@@ -424,7 +435,7 @@ If you are curious to know what the different dependencies are:
    which contains all the front-end dependencies of Converse.js.
    If this directory does NOT exist, something must have gone wrong.
    Double-check the output of ```make dev``` to see if there are any errors
-    listed.
+    listed. For support, you can write to the mailing list: conversejs@librelist.com


 With AMD and require.js (recommended)
@@ -773,12 +784,12 @@ Here are the different events that are emitted:
 +----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
 | **roster**                       | When the roster is updated.                                                                       | ``converse.on('roster', function (items) { ... });``                                    |
 +----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
-| **rosterViewUpdated**            | Whenever the roster view (i.e. the rendered HTML) has changed.                                    | ``converse.on('rosterViewUpdated', function (items) { ... });``                         |
-+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
 | **callButtonClicked**            | When a call button (i.e. with class .toggle-call) on a chat box has been clicked.                 | ``converse.on('callButtonClicked', function (connection, model) { ... });``             |
 +----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
 | **chatBoxOpened**                | When a chat box has been opened.                                                                  | ``converse.on('chatBoxOpened', function (chatbox) { ... });``                           |
 +----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
+| **chatRoomOpened**               | When a chat room has been opened.                                                                 | ``converse.on('chatRoomOpened', function (chatbox) { ... });``                          |
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
 | **chatBoxClosed**                | When a chat box has been closed.                                                                  | ``converse.on('chatBoxClosed', function (chatbox) { ... });``                           |
 +----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
 | **chatBoxFocused**               | When the focus has been moved to a chat box.                                                      | ``converse.on('chatBoxFocused', function (chatbox) { ... });``                          |
@@ -990,6 +1001,18 @@ values as ``jid``, ``sid``, ``rid``.

 Additionally, you have to specify ``bosh_service_url``.

+roster_groups
+-------------
+
+Default:  ``false``
+
+If set to ``true``, converse.js will show any roster groups you might have
+configured.
+
+.. Note ::
+    It's currently not possible to use converse.js to assign contacts to groups.
+    Converse.js can only show users and groups that were previously configured
+    elsewhere.

 show_controlbox_by_default
 --------------------------

--- a/docs/html/_static/basic.css
+++ b/docs/html/_static/basic.css
@@ -4,7 +4,7 @@
 *
 * Sphinx stylesheet -- basic theme.
 *
- * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
 * :license: BSD, see LICENSE for details.
 *
 */
@@ -89,6 +89,7 @@ div.sphinxsidebar #searchbox input[type="submit"] {

 img {
    border: 0;
+    max-width: 100%;
 }

 /* -- search page ----------------------------------------------------------- */
@@ -401,10 +402,6 @@ dl.glossary dt {
    margin: 0;
 }

-.refcount {
-    color: #060;
-}
-
 .optional {
    font-size: 1.3em;
 }

--- a/docs/html/_static/default.css
+++ b/docs/html/_static/default.css
@@ -4,7 +4,7 @@
 *
 * Sphinx stylesheet -- default theme.
 *
- * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
 * :license: BSD, see LICENSE for details.
 *
 */

--- a/docs/html/_static/doctools.js
+++ b/docs/html/_static/doctools.js
@@ -4,7 +4,7 @@
 *
 * Sphinx JavaScript utilities for all documentation.
 *
- * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
 * :license: BSD, see LICENSE for details.
 *
 */
@@ -32,7 +32,7 @@ if (!window.console || !console.firebug) {
 */
 jQuery.urldecode = function(x) {
  return decodeURIComponent(x).replace(/\+/g, ' ');
-}
+};

 /**
 * small helper function to urlencode strings
@@ -61,18 +61,6 @@ jQuery.getQueryParameters = function(s) {
  return result;
 };

-/**
- * small function to check if an array contains
- * a given item.
- */
-jQuery.contains = function(arr, item) {
-  for (var i = 0; i < arr.length; i++) {
-    if (arr[i] == item)
-      return true;
-  }
-  return false;
-};
-
 /**
 * highlight a given string on a jquery object by wrapping it in
 * span elements with the given class name.
@@ -180,6 +168,9 @@ var Documentation = {
    var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
    if (terms.length) {
      var body = $('div.body');
+      if (!body.length) {
+        body = $('body');
+      }
      window.setTimeout(function() {
        $.each(terms, function() {
          body.highlightText(this.toLowerCase(), 'highlighted');

--- a/docs/html/_static/jquery.js
+++ b/docs/html/_static/jquery.js
--- a/docs/html/_static/pygments.css
+++ b/docs/html/_static/pygments.css
@@ -13,11 +13,11 @@
 .highlight .gr { color: #FF0000 } /* Generic.Error */
 .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
 .highlight .gi { color: #00A000 } /* Generic.Inserted */
-.highlight .go { color: #303030 } /* Generic.Output */
+.highlight .go { color: #333333 } /* Generic.Output */
 .highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
 .highlight .gs { font-weight: bold } /* Generic.Strong */
 .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
-.highlight .gt { color: #0040D0 } /* Generic.Traceback */
+.highlight .gt { color: #0044DD } /* Generic.Traceback */
 .highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
 .highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
 .highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */

--- a/docs/html/_static/searchtools.js
+++ b/docs/html/_static/searchtools.js
--- a/docs/html/_static/sidebar.js
+++ b/docs/html/_static/sidebar.js
@@ -16,12 +16,20 @@
 * Once the browser is closed the cookie is deleted and the position
 * reset to the default (expanded).
 *
- * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
 * :license: BSD, see LICENSE for details.
 *
 */

 $(function() {
+  
+  
+  
+  
+  
+  
+  
+
  // global elements used by the functions.
  // the 'sidebarbutton' element is defined as global after its
  // creation, in the add_sidebar_button function
@@ -134,7 +142,7 @@ $(function() {
    var items = document.cookie.split(';');
    for(var k=0; k<items.length; k++) {
      var key_val = items[k].split('=');
-      var key = key_val[0];
+      var key = key_val[0].replace(/ /, "");  // strip leading spaces
      if (key == 'sidebar') {
        var value = key_val[1];
        if ((value == 'collapsed') && (!sidebar_is_collapsed()))
@@ -148,4 +156,4 @@ $(function() {
  add_sidebar_button();
  var sidebarbutton = $('#sidebarbutton');
  set_position_from_cookie();
-});
+});
\ No newline at end of file
--- a/docs/html/_static/underscore.js
+++ b/docs/html/_static/underscore.js
--- a/docs/html/_static/websupport.js
+++ b/docs/html/_static/websupport.js
@@ -4,7 +4,7 @@
 *
 * sphinx.websupport utilties for all documentation.
 *
- * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
 * :license: BSD, see LICENSE for details.
 *
 */

--- a/docs/html/genindex.html
+++ b/docs/html/genindex.html

-
-
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

@@ -16,7 +14,7 @@
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
-        URL_ROOT:    '',
+        URL_ROOT:    './',
        VERSION:     '0.8.0',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',

--- a/docs/html/index.html
+++ b/docs/html/index.html
--- a/docs/html/search.html
+++ b/docs/html/search.html
-
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

@@ -14,7 +13,7 @@
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
-        URL_ROOT:    '',
+        URL_ROOT:    './',
        VERSION:     '0.8.0',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
@@ -29,6 +28,8 @@
  <script type="text/javascript">
    jQuery(function() { Search.loadIndex("searchindex.js"); });
  </script>
+  
+  <script type="text/javascript" id="searchindexloader"></script>
   

  </head>

--- a/docs/html/searchindex.js
+++ b/docs/html/searchindex.js