Expand the docs

Try to add more information on the goals around Converse.js and on how to get
started.

docs/html/_sources/index.txt

@@ -10,9 +10,35 @@
    :depth: 3
    :local:
 
-===================
-What you will need:
-===================
+============
+Introduction
+============
+
+Even though you can connect to public XMPP servers on the `conversejs.org`_
+website, *Converse.js* is not meant to be a "Software-as-a-service" (SaaS) 
+webchat.
+
+Instead, its goal is to provide the means for website owners to add a tightly
+integrated instant messaging service to their own sites.
+
+As a website owner, you are expected to host *Converse.js* yourself, and to do some legwork to
+properly configure and integrated it into your site.
+
+The benefit in doing this, is that your users have a much more streamlined and integrated
+webchat experience and that you have control over the data. The latter being a
+requirement for many sites dealing with sensitive information.
+
+You'll need to set up your own XMPP server and in order to have
+single-signon functionality, whereby users are authenticated once and stay
+logged in to XMPP upon page reload, you will also have to add some server-side
+code.
+
+The `What you will need`_ section has more information on all these
+requirements.
+
+==================
+What you will need
+==================
 
 An XMPP/Jabber server
 =====================
@@ -22,16 +48,7 @@ to connect to an XMPP/Jabber server (Jabber is really just a synonym for XMPP).
 
 You can either set up your own XMPP server, or use a public one. You can find a
 list of public XMPP servers/providers on `xmpp.net`_ and a list of servers that
-you can set up yourself on `xmpp.org`_. Personally, I'm partial towards `ejabberd`_.
-
-Session support (i.e. single site login)
-----------------------------------------
-
-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.
-
-Jack Moffitt has a great `blogpost`_ about this and even provides an `example Django application`_ to demonstrate it.
+you can set up yourself on `xmpp.org`_.
 
 Connection Manager
 ==================
@@ -76,12 +93,133 @@ If you need to support these browsers, you can add a front-end proxy in
 Apache/Nginx which serves the connection manager under the same domain as your
 website. This will remove the need for any cross-domain XHR support.
 
-====================================
-Converse.js Configuration variables:
-====================================
+Server-side authentication
+==========================
+
+Session support (i.e. single site login)
+----------------------------------------
+
+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.
+
+Jack Moffitt has a great `blogpost`_ about this and even provides an `example Django application`_ to demonstrate it.
+
+
+=========================================
+Quickstart (to get a demo up and running)
+=========================================
+
+When you download a specific release of *Converse.js*, say for example version 0.3,
+there will be two minified files inside the zip file.
+
+For version 0.3 they will be:
+
+* converse.0.3.min.js
+* converse.0.3.min.css
+
+You can include these two files in your website via the *script* and *link*
+tags:
+
+::
+
+    <link rel="stylesheet" type="text/css" media="screen" href="converse.0.3.min.css">
+    <script src="converse.0.3.min.js"></script>
+
+The *index.html* file inside the Converse.js folder serves as a nice usable
+example of this.
+
+These minified files provide the same demo-like functionality as is available
+on the `conversejs.org`_ website. Useful for testing or demoing, but not very
+practical.
+
+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.
+
+For more info on this, read `Session support (i.e. single site login)`_.
+
+You might also want to have more fine-grained control of what gets included in
+the minified Javascript file. Read `Configuration`_ and `Minification`_ for more info on how to do
+that.
+
+
+=============
+Configuration
+=============
+
+The included minified JS and CSS files can be used for demoing or testing, but
+you'll want to configure *Converse.js* to suit your needs before you deploy it
+on your website.
+
+*Converse.js* is passed its configuration settings when you call its
+*initialize* method.
+
+Please refer to the `Configuration variables`_ section below for info on
+all the available configuration settings.
+
+After you have configured *Converse.js*, you'll have to regenerate the minified
+JS file so that it will include the new settings. Please refer to the
+`Minification`_ section for more info on how to do this.
+
+Configuration variables
+=======================
+
+animate
+-------
+
+Default = True
+
+Show animations, for example when opening and closing chat boxes.
+
+auto_list_rooms
+---------------
+
+Default = False
+
+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.
+
+Not recommended for servers with lots of chat rooms.
+
+For each room on the server a query is made to fetch further details (e.g.
+features, number of occupants etc.), so on servers with many rooms this 
+option will create lots of extra connection traffic.
+
+auto_subscribe
+--------------
+
+Default = False
+
+If true, the user will automatically subscribe back to any contact requests.
+
+bosh_service_url
+----------------
+
+Connections to an XMPP server depend on a BOSH connection manager which acts as
+a middle man between HTTP and XMPP.
+
+See `here`_ for more information.
+
+fullname
+--------
+
+If you are using prebinding, you need to specify the fullname of the currently
+logged in user.
+
+hide_muc_server
+---------------
+
+Default = False
+
+Hide the ``server`` input field of the form inside the ``Room`` panel of the
+controlbox. Useful if you want to restrict users to a specific XMPP server of
+your choosing.
 
 prebind
-========
+--------
+
+Default = False
 
 Use this option when you want to attach to an existing XMPP connection that was
 already authenticated (usually on the backend before page load).
@@ -105,55 +243,67 @@ have to write a Javascript snippet to attach to the set up connection::
 The backend must authenticate for you, and then return a SID (session ID) and
 RID (Request ID), which you use when you attach to the connection.
 
-fullname
-========
-
-If you are using prebinding, you need to specify the fullname of the currently
-logged in user.
-
-bosh_service_url
-================
-
-Connections to an XMPP server depend on a BOSH connection manager which acts as
-a middle man between HTTP and XMPP.
-
-See `here`_ for more information.
-
 
 xhr_user_search
-===============
+---------------
+
+Default = False
 
 There are two ways to add users. 
 
-* The user inputs a valid JID (Jabber ID), and the user is added as a pending
-contact.
+* The user inputs a valid JID (Jabber ID), and the user is added as a pending contact.
 * The user inputs some text (for example part of a firstname or lastname), an XHR will be made to a backend, and a list of matches are returned. The user can then choose one of the matches to add as a contact.
 
 This setting enables the second mechanism, otherwise by default the first will
 be used.
 
-auto_subscribe
-==============
 
-If true, the user will automatically subscribe back to any contact requests.
 
-auto_list_rooms
-===============
+============
+Minification
+============
 
-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.
+Minifying Javascript
+====================
 
-Not recommended for servers with lots of chat rooms.
+We  use `require.js`_ to keep track of *Converse.js* and its dependencies and to
+to bundle them together in a single minified file fit for deployment to a 
+production site.
+
+To use the require.js's optimization tool, you'll need Node and it's package
+manager, NPM.
+
+You can then install install require.js for Node like so:
+
+::
+
+    npm install requirejs
+
+The minified javascript file is then created like this:
+
+::
+
+    r.js -o build.js
+
+You should now have a new minified file (the name which is specified in build.js).
+
+You can `read more about require.js's optimizer here`_.
+
+Minifying CSS
+=============
+
+CSS can be minimized with Yahoo's yuicompressor tool:
+
+::
+
+    yui-compressor --type=css converse.css -o converse.min.css
 
-For each room on the server a query is made to fetch further details (e.g.
-features, number of occupants etc.), so on servers with many rooms this 
-option will create lots of extra connection traffic.
 
-animate
-=======
 
-Show animations, for example when opening and closing chat boxes.
 
+.. _`conversejs.org`: http://conversejs.org
+.. _`require.js`: http://requirejs.org
+.. _`read more about require.js's optimizer here`: http://requirejs.org/docs/optimization.html
 .. _`here`: http://metajack.im/2008/09/08/which-bosh-server-do-you-need/l
 .. _`HTTP`: https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol
 .. _`XMPP`: https://en.wikipedia.org/wiki/Xmpp

docs/html/searchindex.js

-Search.setIndex({objects:{},terms:{xdomainrequest:0,code:0,protocol:0,just:0,show:0,xmpp:0,detail:0,session:0,partial:0,find:0,web:0,jid:0,middl:0,depend:0,firstnam:0,explor:0,configur:0,apach:0,add:0,pend:0,text:0,input:0,therefor:0,match:0,applic:0,anim:0,"return":0,between:0,opkod:0,nginx:0,mechan:0,jack:0,front:0,resourc:0,now:0,requir:0,like:0,xss:0,enabl:0,success:0,list:0,authent:0,"public":0,"default":0,either:0,each:0,manag:0,pleas:0,prevent:0,domain:0,set:0,some:0,back:0,stroph:0,realli:0,see:0,connect:0,pass:0,further:0,fullnam:0,server:0,variabl:0,what:0,jabber:0,content:0,state:0,overcom:0,internet:0,"new":0,net:0,method:0,ejabberd:0,proxi:0,javascript:0,onli:0,here:0,standard:0,standalon:0,job:0,bosh:0,locat:0,box:0,great:0,cor:0,instant:0,convers:0,mysit:0,via:0,conversej:0,current:0,page:0,etc:0,act:0,mani:0,login:0,com:0,other:0,first:0,load:0,own:0,render:0,extra:0,lastnam:0,number:0,automat:0,yourself:0,restrict:0,alreadi:0,org:0,auto_list_room:0,open:0,your:0,backend:0,differ:0,log:0,wai:0,commun:0,homepag:0,support:0,two:0,messag:0,custom:0,websit:0,attach:0,json:0,call:0,includ:0,lot:0,recommend:0,besid:0,recent:0,until:0,more:0,"function":0,luckili:0,option:0,form:0,blogpost:0,under:0,about:0,specifi:0,site:0,part:0,don:0,exactli:0,"true":0,than:0,present:0,must:0,serv:0,multi:0,made:0,room:0,possibl:0,provid:0,xmlhttprequest:0,remov:0,shortliv:0,second:0,xhr:0,bridg:0,can:0,otherwis:0,problem:0,toward:0,fetch:0,browser:0,control:0,featur:0,have:0,creat:0,demo:0,auto_subscrib:0,modern:0,share:0,ani:0,origin:0,proprietari:0,chat:0,tabl:0,close:0,exist:0,moffitt:0,bosh_service_url:0,occup:0,subscrib:0,write:0,end:0,want:0,inform:0,make:0,when:0,cross:0,same:0,contact:0,snippet:0,also:0,need:0,valid:0,rid:0,which:0,sid:0,test:0,you:0,purpos:0,singl:0,even:0,product:0,sure:0,http:0,webserv:0,prebind:0,object:0,hand:0,befor:0,plugin:0,queri:0,user:0,attack:0,thi:0,data:0,implement:0,demonstr:0,man:0,stateless:0,synonym:0,longer:0,url:0,bind:0,request:0,django:0,person:0,exampl:0,wherebi:0,onconnect:0,choos:0,traffic:0,xhr_user_search:0,usual:0},objtypes:{},titles:["What you will need:"],objnames:{},filenames:["index"]})
+Search.setIndex({objects:{},terms:{all:0,code:0,partial:0,queri:0,webchat:0,middl:0,depend:0,sensit:0,under:0,fals:0,mechan:0,jack:0,veri:0,list:0,pleas:0,prevent:0,second:0,pass:0,download:0,further:0,fullnam:0,even:0,index:0,what:0,hide:0,section:0,current:0,version:0,"new":0,net:0,method:0,here:0,box:0,great:0,convers:0,mysit:0,implement:0,via:0,extra:0,solut:0,href:0,auto_list_room:0,instal:0,zip:0,commun:0,two:0,websit:0,stylesheet:0,call:0,recommend:0,type:0,until:0,tightli:0,more:0,yahoo:0,must:0,room:0,setup:[],xhr:0,can:0,purpos:0,fetch:0,control:0,quickstart:0,share:0,tag:0,proprietari:0,explor:0,occup:0,end:0,goal:0,snippet:0,how:0,sid:0,instead:0,css:0,npm:0,regener:0,product:0,resourc:0,after:0,usabl:0,befor:0,data:0,demonstr:0,man:0,practic:0,bind:0,django:0,inform:0,order:0,xmpp:0,over:0,streamlin:0,write:0,jid:0,fit:0,pend:0,therefor:0,might:0,them:0,anim:0,"return":0,thei:0,initi:0,front:0,now:0,introduct:0,name:0,authent:0,ejabberd:0,each:0,side:0,mean:0,domain:0,realli:0,legwork:0,connect:0,variabl:0,open:0,content:0,rel:0,internet:0,proxi:0,insid:0,standard:0,standalon:0,releas:0,org:0,blogpost:0,keep:0,yui:0,first:0,origin:0,softwar:0,render:0,onc:0,lastnam:0,number:0,yourself:0,restrict:0,alreadi:0,owner:0,jabber:0,differ:0,script:0,messag:0,attach:0,attack:0,luckili:0,option:0,tool:0,specifi:0,compressor:0,part:0,exactli:0,than:0,serv:0,kind:0,provid:0,remov:0,bridg:0,toward:[],browser:0,sai:0,saa:0,modern:0,ani:0,packag:0,have:0,tabl:0,need:0,moffitt:0,bosh_service_url:0,prebind:0,min:0,latter:0,also:0,exampl:0,build:0,which:0,singl:0,sure:0,though:0,track:0,object:0,most:0,deploi:0,homepag:0,don:0,url:0,request:0,xdomainrequest:0,show:0,text:0,session:0,fine:0,find:0,onli:0,locat:0,firstnam:0,configur:0,apach:0,should:0,folder:0,meant:0,get:0,opkod:0,requir:0,enabl:0,"public":0,reload:0,integr:0,where:0,set:0,stroph:0,see:0,close:0,state:0,between:0,experi:0,hide_muc_serv:0,screen:0,javascript:0,job:0,bosh:0,cor:0,instant:0,shortliv:0,conversej:0,etc:0,grain:0,mani:0,login:0,com:0,load:0,backend:0,onconnect:0,json:0,much:0,besid:0,subscrib:0,minifi:0,togeth:0,present:0,multi:0,servic:0,plugin:0,chat:0,demo:0,auto_subscrib:0,site:0,rid:0,minim:0,media:0,make:0,minif:0,cross:0,same:0,html:0,signon:0,http:0,webserv:0,optim:0,upon:0,hand:0,user:0,xhr_user_search:0,recent:0,stateless:0,person:[],contact:0,wherebi:0,thi:0,choos:0,usual:0,protocol:0,just:0,web:0,xmlhttprequest:0,add:0,other:0,input:0,yuicompressor:0,match:0,applic:0,read:0,nginx:0,traffic:0,like:0,xss:0,success:0,specif:0,server:0,benefit:0,either:0,page:0,deal:0,some:0,back:0,deploy:0,overcom:0,refer:0,run:0,host:0,panel:0,src:0,about:0,controlbox:0,manag:0,act:0,own:0,automat:0,your:0,log:0,wai:0,support:0,custom:0,avail:0,start:[],includ:0,lot:0,suit:0,"function":0,properli:0,form:0,bundl:0,link:0,synonym:0,"true":0,longer:0,info:0,made:0,possibl:0,"default":0,below:0,otherwis:0,problem:0,expect:0,featur:0,creat:0,exist:0,file:0,want:0,when:0,detail:0,field:0,valid:0,test:0,you:0,nice:0,node:0,stai:0,requirej:0},objtypes:{},titles:["Introduction"],objnames:{},filenames:["index"]})
\ No newline at end of file

docs/html/static/stylesheet.css

@@ -28,4 +28,8 @@ h1#project_title a {
 
 h1 a {
     color: #0069ba;
-}
+}
\ No newline at end of file
+
+ul {
+    margin-bottom: 0;
+}

docs/source/index.rst

@@ -10,9 +10,35 @@
    :depth: 3
    :local:
 
-===================
-What you will need:
-===================
+============
+Introduction
+============
+
+Even though you can connect to public XMPP servers on the `conversejs.org`_
+website, *Converse.js* is not meant to be a "Software-as-a-service" (SaaS) 
+webchat.
+
+Instead, its goal is to provide the means for website owners to add a tightly
+integrated instant messaging service to their own sites.
+
+As a website owner, you are expected to host *Converse.js* yourself, and to do some legwork to
+properly configure and integrated it into your site.
+
+The benefit in doing this, is that your users have a much more streamlined and integrated
+webchat experience and that you have control over the data. The latter being a
+requirement for many sites dealing with sensitive information.
+
+You'll need to set up your own XMPP server and in order to have
+single-signon functionality, whereby users are authenticated once and stay
+logged in to XMPP upon page reload, you will also have to add some server-side
+code.
+
+The `What you will need`_ section has more information on all these
+requirements.
+
+==================
+What you will need
+==================
 
 An XMPP/Jabber server
 =====================
@@ -22,16 +48,7 @@ to connect to an XMPP/Jabber server (Jabber is really just a synonym for XMPP).
 
 You can either set up your own XMPP server, or use a public one. You can find a
 list of public XMPP servers/providers on `xmpp.net`_ and a list of servers that
-you can set up yourself on `xmpp.org`_. Personally, I'm partial towards `ejabberd`_.
-
-Session support (i.e. single site login)
-----------------------------------------
-
-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.
-
-Jack Moffitt has a great `blogpost`_ about this and even provides an `example Django application`_ to demonstrate it.
+you can set up yourself on `xmpp.org`_.
 
 Connection Manager
 ==================
@@ -76,19 +93,87 @@ If you need to support these browsers, you can add a front-end proxy in
 Apache/Nginx which serves the connection manager under the same domain as your
 website. This will remove the need for any cross-domain XHR support.
 
-====================================
-Converse.js Configuration variables:
-====================================
+Server-side authentication
+==========================
+
+Session support (i.e. single site login)
+----------------------------------------
+
+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.
+
+Jack Moffitt has a great `blogpost`_ about this and even provides an `example Django application`_ to demonstrate it.
+
+
+=========================================
+Quickstart (to get a demo up and running)
+=========================================
+
+When you download a specific release of *Converse.js*, say for example version 0.3,
+there will be two minified files inside the zip file.
+
+For version 0.3 they will be:
+
+* converse.0.3.min.js
+* converse.0.3.min.css
+
+You can include these two files in your website via the *script* and *link*
+tags:
+
+::
+
+    <link rel="stylesheet" type="text/css" media="screen" href="converse.0.3.min.css">
+    <script src="converse.0.3.min.js"></script>
+
+The *index.html* file inside the Converse.js folder serves as a nice usable
+example of this.
+
+These minified files provide the same demo-like functionality as is available
+on the `conversejs.org`_ website. Useful for testing or demoing, but not very
+practical.
+
+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.
+
+For more info on this, read `Session support (i.e. single site login)`_.
+
+You might also want to have more fine-grained control of what gets included in
+the minified Javascript file. Read `Configuration`_ and `Minification`_ for more info on how to do
+that.
+
+
+=============
+Configuration
+=============
+
+The included minified JS and CSS files can be used for demoing or testing, but
+you'll want to configure *Converse.js* to suit your needs before you deploy it
+on your website.
+
+*Converse.js* is passed its configuration settings when you call its
+*initialize* method.
+
+Please refer to the `Configuration variables`_ section below for info on
+all the available configuration settings.
+
+After you have configured *Converse.js*, you'll have to regenerate the minified
+JS file so that it will include the new settings. Please refer to the
+`Minification`_ section for more info on how to do this.
+
+Configuration variables
+=======================
 
 animate
-=======
+-------
 
 Default = True
 
 Show animations, for example when opening and closing chat boxes.
 
 auto_list_rooms
-===============
+---------------
 
 Default = False
 
@@ -102,14 +187,14 @@ features, number of occupants etc.), so on servers with many rooms this
 option will create lots of extra connection traffic.
 
 auto_subscribe
-==============
+--------------
 
 Default = False
 
 If true, the user will automatically subscribe back to any contact requests.
 
 bosh_service_url
-================
+----------------
 
 Connections to an XMPP server depend on a BOSH connection manager which acts as
 a middle man between HTTP and XMPP.
@@ -117,13 +202,13 @@ a middle man between HTTP and XMPP.
 See `here`_ for more information.
 
 fullname
-========
+--------
 
 If you are using prebinding, you need to specify the fullname of the currently
 logged in user.
 
 hide_muc_server
-===============
+---------------
 
 Default = False
 
@@ -132,7 +217,7 @@ controlbox. Useful if you want to restrict users to a specific XMPP server of
 your choosing.
 
 prebind
-========
+--------
 
 Default = False
 
@@ -160,20 +245,65 @@ RID (Request ID), which you use when you attach to the connection.
 
 
 xhr_user_search
-===============
+---------------
 
 Default = False
 
 There are two ways to add users. 
 
-* The user inputs a valid JID (Jabber ID), and the user is added as a pending
-contact.
+* The user inputs a valid JID (Jabber ID), and the user is added as a pending contact.
 * The user inputs some text (for example part of a firstname or lastname), an XHR will be made to a backend, and a list of matches are returned. The user can then choose one of the matches to add as a contact.
 
 This setting enables the second mechanism, otherwise by default the first will
 be used.
 
 
+
+============
+Minification
+============
+
+Minifying Javascript
+====================
+
+We  use `require.js`_ to keep track of *Converse.js* and its dependencies and to
+to bundle them together in a single minified file fit for deployment to a 
+production site.
+
+To use the require.js's optimization tool, you'll need Node and it's package
+manager, NPM.
+
+You can then install install require.js for Node like so:
+
+::
+
+    npm install requirejs
+
+The minified javascript file is then created like this:
+
+::
+
+    r.js -o build.js
+
+You should now have a new minified file (the name which is specified in build.js).
+
+You can `read more about require.js's optimizer here`_.
+
+Minifying CSS
+=============
+
+CSS can be minimized with Yahoo's yuicompressor tool:
+
+::
+
+    yui-compressor --type=css converse.css -o converse.min.css
+
+
+
+
+.. _`conversejs.org`: http://conversejs.org
+.. _`require.js`: http://requirejs.org
+.. _`read more about require.js's optimizer here`: http://requirejs.org/docs/optimization.html
 .. _`here`: http://metajack.im/2008/09/08/which-bosh-server-do-you-need/l
 .. _`HTTP`: https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol
 .. _`XMPP`: https://en.wikipedia.org/wiki/Xmpp