Update docs to provide examples of server-side prebind code. Updates #116

42b28b84 · JC Brand · cd144a98 · 42b28b84 · 42b28b84 · 42b28b84
Commit 42b28b84 authored Jan 30, 2014 by JC Brand
9 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: 652c197d955de4d2c90bb99dc6534a15
+config: 9cade5fa70d219453c215cec2a2631df
 tags: fbb0d17656682115ca4d033fb2f83ba1
--- a/docs/html/_sources/index.txt
+++ b/docs/html/_sources/index.txt
@@ -277,6 +277,17 @@ These values are then passed to converse.js's ``initialize`` method.
   **bosh_service_url** values.


+Example code for server-side prebinding
+---------------------------------------
+
+* PHP: 
+    See `xmpp-prebind-php <https://github.com/candy-chat/xmpp-prebind-php>`_ by
+    Michael Weibel and the folks from Candy chat.
+
+* Python:
+    See this `example Django application`_ by Jack Moffitt.
+
+
 Setting up a BOSH server
 ------------------------

@@ -387,6 +398,7 @@ If you don't have grunt installed globally, you need to specify the relative
 path:

 ::
+
    ./node_modules/.bin/grunt fetch

 This will call Bower in the background to fetch all the front-end
@@ -813,6 +825,28 @@ the page with class *toggle-online-users*.
 If this options is set to true, the controlbox will by default be shown upon
 page load.

+
+show_call_button
+----------------
+
+Default = ``false``
+
+Enable to display a call button on the chatbox toolbar.
+
+When the call button is pressed, it will emit an event that can be used by a third-party library to initiate a call.
+
+::
+
+    converse.on('onCallButtonClicked', function(event, data) {
+        console.log('Call button was clicked.');
+        console.log('Strophe connection is', data.connection);
+        console.log('Bare buddy JID is', data.model.get('jid'));
+
+        // ... Third-party library code ...
+    });
+
+
+
 show_only_online_users
 ----------------------


--- a/docs/html/genindex.html
+++ b/docs/html/genindex.html
@@ -9,7 +9,7 @@
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
-    <title>Index &mdash; Converse.js 0.7.1 documentation</title>
+    <title>Index &mdash; Converse.js 0.7.2 documentation</title>
    
    <link rel="stylesheet" href="_static/stylesheet.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -17,7 +17,7 @@
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
-        VERSION:     '0.7.1',
+        VERSION:     '0.7.2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
@@ -26,7 +26,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.7.1 documentation" href="index.html" /> 
+    <link rel="top" title="Converse.js 0.7.2 documentation" href="index.html" /> 
  </head>
  <body>
    <div id="header_wrap" class="outer">
@@ -51,7 +51,7 @@
        <li class="right" style="margin-right: 10px">
          <a href="#" title="General Index"
             accesskey="I">index</a></li>
-        <li><a href="index.html">Converse.js 0.7.1 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Converse.js 0.7.2 documentation</a> &raquo;</li> 
      </ul>
    </div>
 <section id="main_content" class="inner">  
@@ -80,7 +80,7 @@
        <li class="right" style="margin-right: 10px">
          <a href="#" title="General Index"
             >index</a></li>
-        <li><a href="index.html">Converse.js 0.7.1 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Converse.js 0.7.2 documentation</a> &raquo;</li> 
      </ul>
    </div>
 </div>

--- a/docs/html/index.html
+++ b/docs/html/index.html
--- a/docs/html/objects.inv
+++ b/docs/html/objects.inv
 # Sphinx inventory version 2
 # Project: Converse.js
-# Version: 0.7.1
+# Version: 0.7.2
 # The remainder of this file is compressed using zlib.
 xm
 {"];

--- a/docs/html/search.html
+++ b/docs/html/search.html
@@ -7,7 +7,7 @@
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
-    <title>Search &mdash; Converse.js 0.7.1 documentation</title>
+    <title>Search &mdash; Converse.js 0.7.2 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.7.1',
+        VERSION:     '0.7.2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
@@ -25,7 +25,7 @@
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <script type="text/javascript" src="_static/searchtools.js"></script>
-    <link rel="top" title="Converse.js 0.7.1 documentation" href="index.html" />
+    <link rel="top" title="Converse.js 0.7.2 documentation" href="index.html" />
  <script type="text/javascript">
    jQuery(function() { Search.loadIndex("searchindex.js"); });
  </script>
@@ -55,7 +55,7 @@
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
-        <li><a href="index.html">Converse.js 0.7.1 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Converse.js 0.7.2 documentation</a> &raquo;</li> 
      </ul>
    </div>
 <section id="main_content" class="inner">  
@@ -100,7 +100,7 @@
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
-        <li><a href="index.html">Converse.js 0.7.1 documentation</a> &raquo;</li> 
+        <li><a href="index.html">Converse.js 0.7.2 documentation</a> &raquo;</li> 
      </ul>
    </div>
 </div>

--- a/docs/html/searchindex.js
+++ b/docs/html/searchindex.js
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -277,6 +277,17 @@ These values are then passed to converse.js's ``initialize`` method.
   **bosh_service_url** values.


+Example code for server-side prebinding
+---------------------------------------
+
+* PHP: 
+    See `xmpp-prebind-php <https://github.com/candy-chat/xmpp-prebind-php>`_ by
+    Michael Weibel and the folks from Candy chat.
+
+* Python:
+    See this `example Django application`_ by Jack Moffitt.
+
+
 Setting up a BOSH server
 ------------------------