Add info on facebook integration

docs/html/_sources/index.txt

@@ -226,6 +226,60 @@ In the callback function, you call *converse.onConnected* together with the
 connection object.
 
 
+Facebook integration
+====================
+
+.. Note :: 
+    It should be possible to integrate Converse.js with Facebook chat, and
+    below I'll provide some tips and documentation on how to achieve this. That
+    said, I don't have a Facebook account and therefore haven't tried to do
+    this myself. Feedback and patches from people who have succesfully done this
+    will be appreciated.
+
+
+Converse.js uses `Strophe.js <http://strophe.im/strophejs>`_ to connect and
+communicate with the XMPP server. One nice thing about Strophe.js is that it 
+can be extended via `plugins <http://github.com/strophe/strophejs-plugins>`_.
+
+Here is a `plugin for authenticating with facebook 
+<https://github.com/kissrobber/turedsocial/blob/master/strophe-plugins/src/facebook.js>`_.
+
+You will need your own BOSH connection manager to act as a proxy between
+Converse.js/Strophe.js and Facebook's XMPP server. That is because Facebook's
+XMPP server doesn't support BOSH natively.
+
+The BOSH connection manager that I make available for
+testing purposes (at https://bind.opkode.im) uses `Punjab <https://github.com/twonds/punjab>`_,
+although there are quite a few other options available as well.
+
+When you configure Converse.js, via its ``initialize`` method, you must specify the 
+`bosh_service_url`_ value, which is to be your BOSH connection manager.
+
+Please note, to enable Facebook integration, you'll have to
+get your hands dirty and modify Converse.js's code, so that it calls the
+``facebookConnect`` method of the plugin above.
+
+The plugin above gives the following code example for you to meditate upon:
+
+::
+
+    connection = new Strophe.Connection("http://localhost:5280/bosh");
+    connection.facebookConnect(
+        "12345@chat.facebook.com",
+        onConnectFacebook,
+        300,
+        1,
+        '5e64a30272af065bd72258c565a03f2f',
+        '8147a27e4a7f9b55ffc85c2683f9529a',
+        FB.getSession().session_key
+    );
+
+The connection is already created inside Converse.js, so the
+``facebookConnect`` method needs to also be called from there.
+
+If someone submits a sane patch that does the above, I'll be happy to merge it.
+Until then, people will have to do this themselves.
+
 ===========
 Development
 ===========
@@ -316,7 +370,7 @@ Take a look at ``tests.html`` and ``spec/MainSpec.js`` to see how
 the tests are implemented.
 
 If you are unsure how to write tests, please 
-`contact me <http://conversejs.org>`_ and I'll be happy to help.
+`contact me <http://opkode.com/contact>`_ and I'll be happy to help.
 
 Check that the tests pass
 -------------------------

docs/html/_static/stylesheet.css

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

docs/html/searchindex.js

-Search.setIndex({objects:{},terms:{all:0,code:0,partial:0,queri:0,webchat:0,follow:0,middl:0,depend:0,sensit:0,sorri:0,specif:0,present:0,under:0,spec:0,string:0,fals:0,mechan:0,jack:0,veri:0,chatpanel:0,list:0,div:0,pleas:0,prevent:0,past:0,second:0,pass:0,download:0,further:0,fullnam:0,click:0,even:0,index:0,what:0,hide:0,section:0,current:0,version:0,"new":0,net:0,method:0,widget:0,gener:0,here:0,bodi:0,let:0,strong:0,valu:0,box:0,convert:0,convers:0,mysit:0,ajax:0,fetch:0,implement:0,via:0,extra:0,solut:0,prefer:0,put:0,href:0,succesfulli:0,auto_list_room:0,instal:0,from:0,zip:0,commun:0,doubl:0,two:0,websit:0,stylesheet:0,call:0,recommend:0,type:0,until:0,tightli:0,more:0,yahoo:0,notic:0,conjunct:[],particular:0,must:0,none:0,room:0,setup:[],work:0,xhr:0,can:0,lc_messag:0,purpos:0,root:0,blogpost:0,control:0,quickstart:0,share:0,templat:0,tag:0,proprietari:0,explor:0,onlin:0,occup:0,end:0,goal:0,snippet:0,how:0,sid:0,roster:0,instead:0,css:0,updat:0,npm:0,regener:0,product:0,resourc:0,after:0,usabl:0,befor:0,callback:0,underscor:0,data:0,demonstr:0,man:0,github:0,practic:0,bind:0,show_controlbox_by_default:0,element:0,caus:0,inform:0,parti:0,order:0,help:0,chatbox:0,xmpp:0,over:0,becaus:0,through:0,streamlin:0,write:0,jid:0,directli:0,fit:0,fix:0,pend:0,hidden:0,therefor:0,might:0,them:0,anim:0,"return":0,thei:0,initi:0,front:0,now:0,introduct:0,name:0,edit:0,authent:0,token:0,ejabberd:0,each:0,side:0,mean:0,domain:0,individu:0,realli:0,legwork:0,connect:0,happen:0,extract:0,special:0,variabl:0,shown:0,"3rd":0,space:0,open:0,content:0,rel:0,internet:0,plural:0,factori:0,po2json:0,proxi:0,insid:0,standard:0,standalon:0,reason:0,ask:0,org:0,afterward:0,could:0,keep:0,yui:0,turn:0,first:0,origin:0,softwar:0,render:0,onc:0,hoop:0,lastnam:0,number:0,yourself:0,restrict:0,instruct:0,alreadi:0,done:0,owner:0,custom:0,miss:0,differ:0,script:0,top:0,messag:0,attach:0,attack:0,master:0,jed:0,jcbrand:0,"final":0,luckili:0,option:0,tool:0,specifi:0,compressor:0,part:0,bower:0,grunt:0,than:0,serv:0,jump:0,kind:0,bloat:0,provid:0,remov:0,exampl:0,jqueri:[],reus:0,toward:[],browser:0,pre:0,"function":0,sai:[],saa:0,modern:0,ani:0,packag:0,have:0,tabl:0,need:0,moffitt:0,django:0,bosh_service_url:0,prebind:0,min:0,latter:0,note:0,also:0,without:0,build:0,which:0,singl:0,sure:0,though:0,track:0,object:0,most:0,deploi:0,homepag:0,"class":0,don:0,url:0,request:0,face:0,runtim:0,pars:0,latest:0,xdomainrequest:0,devdepend:0,show:0,german:0,text:0,session:0,fine:0,find:0,feedback:0,onli:0,exactli:0,locat:0,firstnam:0,configur:0,apach:0,should:0,folder:0,local:0,meant:0,info:0,get:0,soon:0,opkod:0,cannot:0,requir:0,enabl:0,emb:0,mainspec:0,"public":0,reload:0,bad:0,integr:0,contain:0,where:0,set:0,habit:0,stroph:0,see:0,close:0,statu:0,state:0,bridg:0,between:0,experi:0,jasmin:0,hide_muc_serv:0,attribut:0,kei:0,screen:0,javascript:0,style:0,job:0,bosh:0,otherwis:0,both:0,cor:0,instant:0,shortliv:0,conversej:0,etc:0,grain:0,mani:0,login:0,com:0,load:0,instanti:0,pot:0,non:0,backend:0,sucessfulli:0,rebuild:0,compon:0,json:0,much:0,besid:0,subscrib:0,blob:0,msgmerg:0,great:0,minifi:0,togeth:0,i18n:0,those:0,multi:0,main:0,look:0,servic:0,plugin:0,defin:0,error:0,hightlight:0,chat:0,helper:0,demo:0,auto_subscrib:0,site:0,rid:0,conn:0,develop:0,minim:0,receiv:0,media:0,make:0,minif:0,cross:0,same:0,read:0,html:0,chatroom:0,complet:0,signon:0,http:0,webserv:0,optim:0,upon:0,hand:0,"50kb":0,user:0,xhr_user_search:0,recent:0,stateless:0,markup:0,person:[],contact:0,command:0,wherebi:0,thi:0,choos:0,usual:0,plural_form:0,protocol:0,just:0,jshint:0,languag:0,web:0,xmlhttprequest:0,had:0,onconnect:0,add:0,other:0,non_amd:0,input:0,yuicompressor:0,match:0,take:0,applic:0,format:0,webpag:0,amd:0,nginx:0,traffic:0,know:0,background:0,backbon:0,xss:0,like:0,success:0,server:0,collect:0,benefit:0,necessari:0,either:0,page:0,deal:0,nplural:0,some:0,back:0,librari:0,bottom:0,deploy:0,unsur:0,overcom:0,refer:0,run:0,host:0,repositori:0,panel:0,src:0,about:0,obj:[],controlbox:0,unfortun:0,act:0,own:0,curiou:0,encod:0,automat:0,wrap:0,your:0,manag:0,log:0,wai:0,transfer:0,support:0,submit:0,happi:0,avail:0,start:[],includ:0,lot:0,suit:0,"var":0,analysi:0,head:0,properli:0,form:0,bundl:0,link:0,translat:0,synonym:0,line:0,inlin:0,"true":0,bug:0,congratul:0,longer:0,count:0,pull:0,made:0,locale_data:0,possibl:0,"default":0,bugfix:0,displai:0,asynchron:0,below:0,toggl:0,"static":0,problem:0,expect:0,featur:0,creat:0,"100kb":[],exist:0,file:0,check:0,want:0,when:0,detail:0,gettext:0,field:0,valid:0,rememb:0,test:0,you:0,nice:0,node:0,intend:0,releas:0,stai:0,lang:0,requirej:0,jabber:0,directori:0,getjson:0,potenti:0,time:0},objtypes:{},titles:["Quickstart (to get a demo up and running)"],objnames:{},filenames:["index"]})
\ No newline at end of file
+Search.setIndex({objects:{},terms:{all:0,code:0,partial:0,queri:0,webchat:0,follow:0,middl:0,depend:0,sensit:0,sorri:0,specif:0,present:0,under:0,spec:0,sourc:[],string:0,fals:0,account:0,jid:0,mechan:0,jack:0,veri:0,tri:0,chatpanel:0,list:0,sane:0,div:0,pleas:0,prevent:0,past:0,second:0,pass:0,download:0,further:0,fullnam:0,click:0,even:0,index:0,what:0,hide:0,section:0,current:0,"public":0,version:0,"new":0,net:0,method:0,widget:0,themselv:0,gener:0,here:0,bodi:0,let:0,strong:0,modifi:0,valu:0,box:0,convert:0,convers:0,mysit:0,ajax:0,fetch:0,implement:0,punjab:0,via:0,although:0,extra:0,solut:0,prefer:0,put:0,href:0,succesfulli:0,auto_list_room:0,instal:0,getsess:0,from:0,zip:0,commun:0,doubl:0,two:0,websit:0,few:0,stylesheet:0,call:0,recommend:0,type:0,until:0,tightli:0,more:0,peopl:0,yahoo:0,notic:0,particular:0,must:0,none:0,room:0,setup:[],work:0,xhr:0,can:0,lc_messag:0,purpos:0,root:0,blogpost:0,control:0,quickstart:0,give:0,share:0,templat:0,tag:0,proprietari:0,explor:0,onlin:0,occup:0,end:0,goal:0,thing:0,snippet:0,how:0,sid:0,roster:0,instead:0,css:0,updat:0,npm:0,regener:0,product:0,resourc:0,haven:0,after:0,usabl:0,befor:0,callback:0,underscor:0,data:0,demonstr:0,man:0,github:0,practic:0,bind:0,show_controlbox_by_default:0,element:0,caus:0,inform:0,parti:0,facebook:0,order:0,help:0,chatbox:0,xmpp:0,over:0,becaus:0,through:0,streamlin:0,write:0,conjunct:[],"8147a27e4a7f9b55ffc85c2683f9529a":0,directli:0,fit:0,fix:0,pend:0,hidden:0,therefor:0,might:0,them:0,anim:0,"return":0,thei:0,initi:0,front:0,now:0,introduct:0,name:0,edit:0,authent:0,token:0,ejabberd:0,each:0,side:0,mean:0,domain:0,individu:0,realli:0,legwork:0,connect:0,happen:0,extract:0,special:0,variabl:0,shown:0,"3rd":0,space:0,open:0,content:0,rel:0,internet:0,merg:0,plural:0,factori:0,po2json:0,proxi:0,insid:0,free:[],standard:0,standalon:0,reason:0,ask:0,org:0,afterward:0,could:0,keep:0,yui:0,turn:0,stuck:[],first:0,origin:0,softwar:0,render:0,onc:0,hoop:0,lastnam:0,number:0,yourself:0,restrict:0,instruct:0,alreadi:0,done:0,owner:0,custom:0,miss:0,differ:0,script:0,top:0,messag:0,attach:0,attack:0,master:0,jed:0,jcbrand:0,"final":0,luckili:0,option:0,tool:0,specifi:0,compressor:0,part:0,pars:0,grunt:0,than:0,serv:0,jump:0,kind:0,bloat:0,provid:0,remov:0,rate:[],exampl:0,jqueri:[],reus:0,toward:[],browser:0,pre:0,"function":0,sai:[],saa:0,modern:0,ani:0,packag:0,have:0,tabl:0,need:0,moffitt:0,django:0,bosh_service_url:0,prebind:0,min:0,latter:0,note:0,also:0,without:0,build:0,which:0,singl:0,sure:0,though:0,track:0,object:0,most:0,deploi:0,homepag:0,"class":0,don:0,url:0,request:0,face:0,runtim:0,bower:0,latest:0,xdomainrequest:0,devdepend:0,show:0,german:0,text:0,session:0,fine:0,find:0,feedback:0,onli:0,exactli:0,locat:0,firstnam:0,configur:0,apach:0,should:0,folder:0,local:0,meant:0,info:0,get:0,soon:0,opkod:0,nativ:0,cannot:0,requir:0,enabl:0,emb:0,mainspec:0,patch:0,reload:0,bad:0,integr:0,contain:0,where:0,set:0,habit:0,stroph:0,see:0,result:[],close:0,statu:0,said:0,extend:0,state:0,bridg:0,between:0,experi:0,jasmin:0,hide_muc_serv:0,attribut:0,appreci:0,kei:0,screen:0,javascript:0,style:0,job:0,bosh:0,otherwis:0,"5e64a30272af065bd72258c565a03f2f":0,both:0,cor:0,instant:0,shortliv:0,conversej:0,myself:0,etc:0,grain:0,mani:0,login:0,com:0,load:0,instanti:0,pot:0,non:0,backend:0,quit:0,sucessfulli:0,rebuild:0,compon:0,json:0,much:0,besid:0,subscrib:0,blob:0,session_kei:0,great:0,minifi:0,togeth:0,i18n:0,those:0,multi:0,main:0,look:0,servic:0,plugin:0,defin:0,abov:0,error:0,hightlight:0,chat:0,helper:0,demo:0,auto_subscrib:0,site:0,rid:0,conn:0,develop:0,minim:0,receiv:0,media:0,make:0,minif:0,cross:0,same:0,read:0,onconnectfacebook:0,html:0,chatroom:0,document:0,medit:0,complet:0,signon:0,http:0,webserv:0,optim:0,upon:0,someon:0,hand:0,"50kb":0,user:0,xhr_user_search:0,recent:0,stateless:0,markup:0,well:0,person:[],contact:0,command:0,wherebi:0,thi:0,choos:0,usual:0,plural_form:0,protocol:0,just:0,tip:0,jshint:0,languag:0,web:0,xmlhttprequest:0,had:0,onconnect:0,add:0,other:0,non_amd:0,input:0,yuicompressor:0,match:0,take:0,applic:0,format:0,webpag:0,amd:0,nginx:0,traffic:0,know:0,background:0,backbon:0,xss:0,like:0,success:0,server:0,collect:0,benefit:0,necessari:0,either:0,page:0,facebookconnect:0,deal:0,nplural:0,some:0,back:0,librari:0,bottom:0,deploy:0,achiev:0,unsur:0,overcom:0,localhost:0,refer:0,who:0,run:0,host:0,repositori:0,panel:0,src:0,about:0,obj:[],greatli:[],controlbox:0,unfortun:0,act:0,own:0,curiou:0,encod:0,automat:0,wrap:0,your:0,manag:0,log:0,wai:0,transfer:0,support:0,submit:0,happi:0,avail:0,start:[],includ:0,lot:0,suit:0,"var":0,analysi:0,head:0,properli:0,form:0,bundl:0,link:0,translat:0,synonym:0,line:0,inlin:0,"true":0,bug:0,congratul:0,longer:0,count:0,pull:0,made:0,dirti:0,locale_data:0,possibl:0,"default":0,bugfix:0,displai:0,asynchron:0,below:0,toggl:0,"static":0,problem:0,expect:0,featur:0,creat:0,"100kb":[],doesn:0,msgmerg:0,exist:0,file:0,doe:0,check:0,want:0,when:0,detail:0,gettext:0,field:0,valid:0,rememb:0,test:0,you:0,nice:0,node:0,intend:0,releas:0,stai:0,lang:0,requirej:0,jabber:0,directori:0,getjson:0,potenti:0,time:0},objtypes:{},titles:["Quickstart (to get a demo up and running)"],objnames:{},filenames:["index"]})
\ No newline at end of file

docs/source/index.rst

@@ -226,6 +226,60 @@ In the callback function, you call *converse.onConnected* together with the
 connection object.
 
 
+Facebook integration
+====================
+
+.. Note :: 
+    It should be possible to integrate Converse.js with Facebook chat, and
+    below I'll provide some tips and documentation on how to achieve this. That
+    said, I don't have a Facebook account and therefore haven't tried to do
+    this myself. Feedback and patches from people who have succesfully done this
+    will be appreciated.
+
+
+Converse.js uses `Strophe.js <http://strophe.im/strophejs>`_ to connect and
+communicate with the XMPP server. One nice thing about Strophe.js is that it 
+can be extended via `plugins <http://github.com/strophe/strophejs-plugins>`_.
+
+Here is a `plugin for authenticating with facebook 
+<https://github.com/kissrobber/turedsocial/blob/master/strophe-plugins/src/facebook.js>`_.
+
+You will need your own BOSH connection manager to act as a proxy between
+Converse.js/Strophe.js and Facebook's XMPP server. That is because Facebook's
+XMPP server doesn't support BOSH natively.
+
+The BOSH connection manager that I make available for
+testing purposes (at https://bind.opkode.im) uses `Punjab <https://github.com/twonds/punjab>`_,
+although there are quite a few other options available as well.
+
+When you configure Converse.js, via its ``initialize`` method, you must specify the 
+`bosh_service_url`_ value, which is to be your BOSH connection manager.
+
+Please note, to enable Facebook integration, you'll have to
+get your hands dirty and modify Converse.js's code, so that it calls the
+``facebookConnect`` method of the plugin above.
+
+The plugin above gives the following code example for you to meditate upon:
+
+::
+
+    connection = new Strophe.Connection("http://localhost:5280/bosh");
+    connection.facebookConnect(
+        "12345@chat.facebook.com",
+        onConnectFacebook,
+        300,
+        1,
+        '5e64a30272af065bd72258c565a03f2f',
+        '8147a27e4a7f9b55ffc85c2683f9529a',
+        FB.getSession().session_key
+    );
+
+The connection is already created inside Converse.js, so the
+``facebookConnect`` method needs to also be called from there.
+
+If someone submits a sane patch that does the above, I'll be happy to merge it.
+Until then, people will have to do this themselves.
+
 ===========
 Development
 ===========
@@ -316,7 +370,7 @@ Take a look at ``tests.html`` and ``spec/MainSpec.js`` to see how
 the tests are implemented.
 
 If you are unsure how to write tests, please 
-`contact me <http://conversejs.org>`_ and I'll be happy to help.
+`contact me <http://opkode.com/contact>`_ and I'll be happy to help.
 
 Check that the tests pass
 -------------------------

docs/source/theme/static/stylesheet.css_t

@@ -29,3 +29,7 @@ h1#project_title a {
 h1 a {
     color: #0069ba;
 }
+
+ul {
+    margin-bottom: 5px;
+}