Chapril/xmpp.chapril.org-conversejs
Chapril/xmpp.chapril.org-conversejs
25
0
Fork 0
Code Issues Pull Requests Projects Releases Activity
5d4deffc48
xmpp.chapril.org-conversejs/docs/source/index.rst

1231 lines
50 KiB
ReStructuredText
Raw Normal View History

Add initial documentation
2013-04-26 21:01:39 +02:00
.. Converse.js documentation master file, created by
sphinx-quickstart on Fri Apr 26 20:48:03 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. toctree::
:maxdepth: 2
.. contents:: Table of Contents
Update the docs with info on connection managers etc.
2013-05-17 12:48:05 +02:00
:depth: 3
Add initial documentation
2013-04-26 21:01:39 +02:00
:local:
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
=========================================
Quickstart (to get a demo up and running)
=========================================
When you download a specific release of *Converse.js* there will be two minified files inside the zip file.
Update the docs and add section about sound notifications. updates #62
2014-08-23 10:56:38 +02:00
* builds/converse.min.js
* css/converse.min.css
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
You can include these two files inside the *<head>* element of your website via the *script* and *link*
tags:
::
Update the docs and add section about sound notifications. updates #62
2014-08-23 10:56:38 +02:00
<link rel="stylesheet" type="text/css" media="screen" href="css/converse.min.css">
<script src="builds/converse.min.js"></script>
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
Extend docs with info on the HTML snippet converse expects. updates #31
2013-08-12 10:37:13 +02:00
You need to initialize Converse.js with configuration settings particular to
your requirements.
Please refer to the `Configuration variables`_ section further below for info on
all the available configuration settings.
Update the docs and add section about sound notifications. updates #62
2014-08-23 10:56:38 +02:00
To configure Converse.js, put the following inline Javascript code at the
Extend docs with info on the HTML snippet converse expects. updates #31
2013-08-12 10:37:13 +02:00
bottom of your page (after the closing *</body>* element).
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
::
require(['converse'], function (converse) {
converse.initialize({
auto_list_rooms: false,
auto_subscribe: false,
New BOSH service address Conflicts: docs/doctrees/index.doctree docs/html/_sources/index.txt docs/html/index.html docs/html/searchindex.js
2014-04-09 17:03:04 +02:00
bosh_service_url: 'https://bind.conversejs.org', // Please use this connection manager only for testing purposes
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
hide_muc_server: false,
i18n: locales.en, // Refer to ./locale/locales.js to see which locales are supported
prebind: false,
show_controlbox_by_default: true,
Update the docs and add section about sound notifications. updates #62
2014-08-23 10:56:38 +02:00
roster_groups: true
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
});
});
Extend docs with info on the HTML snippet converse expects. updates #31
2013-08-12 10:37:13 +02:00
The `index.html <https://github.com/jcbrand/converse.js/blob/master/index.html>`_ file inside the
Update the docs and add section about sound notifications. updates #62
2014-08-23 10:56:38 +02:00
Converse.js repository may serve as a nice usable example.
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
These minified files provide the same demo-like functionality as is available
Update development section of the docs
2013-08-09 09:21:20 +02:00
on the `conversejs.org <http://conversejs.org>`_ website. Useful for testing or demoing, but not very
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
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.
Add MakeFile target for setting up dev env.
2014-03-14 19:27:44 +01:00
For more info on this, read: `Prebinding and Single Session Support`_.
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
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.
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
============
Introduction
============
Even though you can connect to public XMPP servers on the `conversejs.org`_
Add option to set the XHR user search URL. Fixes #51
2013-10-20 18:34:20 +02:00
website, *Converse.js* is not really meant to be a "Software-as-a-service" (SaaS)
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
webchat.
Instead, its goal is to provide the means for website owners to add a tightly
Update the docs and add section about sound notifications. updates #62
2014-08-23 10:56:38 +02:00
integrated instant messaging service to their own websites.
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
As a website owner, you are expected to host *Converse.js* yourself, and to do some legwork to
Small updates to the documentation.
2013-05-28 21:02:11 +02:00
properly configure and integrate it into your site.
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
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
Small updates to the documentation.
2013-05-28 21:02:11 +02:00
`Session Support`_ (i.e. 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
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
code.
The `What you will need`_ section has more information on all these
requirements.
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
==================
What you will need
==================
Add initial documentation
2013-04-26 21:01:39 +02:00
Update the docs with info on connection managers etc.
2013-05-17 12:48:05 +02:00
An XMPP/Jabber server
=====================
*Converse.js* implements `XMPP`_ as its messaging protocol, and therefore needs
to connect to an XMPP/Jabber server (Jabber is really just a synonym for XMPP).
Small updates to the documentation.
2013-05-28 21:02:11 +02:00
You can connect to public XMPP servers like ``jabber.org`` but if you want to
have `Session Support`_ you'll have to set up your own XMPP server.
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`_.
Update the docs with info on connection managers etc.
2013-05-17 12:48:05 +02:00
Update the docs and add section about sound notifications. updates #62
2014-08-23 10:56:38 +02:00
A BOSH Connection Manager
=========================
Update the docs with info on connection managers etc.
2013-05-17 12:48:05 +02:00
Your website and *Converse.js* use `HTTP`_ as protocol to communicate with
the webserver. HTTP connections are stateless and usually shortlived.
`XMPP`_ on the other hand, is the protocol that enables instant messaging, and
its connections are stateful and usually longer.
To enable a web application like *Converse.js* to communicate with an XMPP
server, we need a proxy in the middle that can act as a bridge between the two
protocols.
Update the docs and add section about sound notifications. updates #62
2014-08-23 10:56:38 +02:00
The `index.html <https://github.com/jcbrand/converse.js/blob/master/index.html>`_ file inside the
Update the docs with info on connection managers etc.
2013-05-17 12:48:05 +02:00
This is the job of a connection manager. A connection manager can be either a
Update the docs and add section about sound notifications. updates #62
2014-08-23 10:56:38 +02:00
standalone application or part of an XMPP server. Popular XMPP servers such as
`ejabberd <http://www.ejabberd.im>`_, `prosody <http://prosody.im/doc/setting_up_bosh>`_ and
`openfire <http://www.igniterealtime.org/projects/openfire/>`_ all include their own connection managers
(but you usually have to enable them in the configuration).
Standalone connection managers also exist, see for example `Punjab <https://github.com/twonds/punjab>`_.
Update the docs with info on connection managers etc.
2013-05-17 12:48:05 +02:00
Update the docs and add section about sound notifications. updates #62
2014-08-23 10:56:38 +02:00
The demo on the `Converse.js homepage`_ uses a connection manager located at https://bind.conversejs.org.
This connection manager is available for testing purposes only, please don't use it in production.
Update the docs with info on connection managers etc.
2013-05-17 12:48:05 +02:00
Overcoming cross-domain request restrictions
--------------------------------------------
Update the docs and add section about sound notifications. updates #62
2014-08-23 10:56:38 +02:00
Lets say your domain is *example.org*, but the domain of your connection
manager is *example.com*.
Add option to set the XHR user search URL. Fixes #51
2013-10-20 18:34:20 +02:00
HTTP requests are made by *Converse.js* to the connection manager via XmlHttpRequests (XHR).
Update the docs with info on connection managers etc.
2013-05-17 12:48:05 +02:00
Until recently, it was not possible to make such requests to a different domain
than the one currently being served (to prevent XSS attacks).
Luckily there is now a standard called `CORS`_ (Cross-origin resource sharing), which enables exactly that.
Modern browsers support CORS, but there are problems with Internet Explorer <
10.
IE 8 and 9 partially support CORS via a proprietary implementation called
XDomainRequest. There is a `Strophe.js plugin`_ which you can use to enable
support for XDomainRequest when it is present.
In IE < 8, there is no support for CORS.
Update doc details on reverse-proxying the connection manager
2013-09-13 12:44:16 +02:00
Instead of using CORS, you can add a reverse proxy in
Update the docs with info on connection managers etc.
2013-05-17 12:48:05 +02:00
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.
Update doc details on reverse-proxying the connection manager
2013-09-13 12:44:16 +02:00
For example:
~~~~~~~~~~~~
Assuming your site is accessible on port ``80`` for the domain ``mysite.com``
and your connection manager manager is running at ``someothersite.com/http-bind``.
The *bosh_service_url* value you want to give Converse.js to overcome
the cross-domain restriction is ``mysite.com/http-bind`` and not
``someothersite.com/http-bind``.
Your ``nginx`` or ``apache`` configuration will look as follows:
Nginx
~~~~~
::
http {
server {
listen 80
server_name mysite.com;
location ~ ^/http-bind/ {
proxy_pass http://someothersite.com;
}
}
}
Apache
~~~~~~
::
<VirtualHost *:80>
Add option to set the XHR user search URL. Fixes #51
2013-10-20 18:34:20 +02:00
ServerName mysite.com
Update doc details on reverse-proxying the connection manager
2013-09-13 12:44:16 +02:00
RewriteEngine On
RewriteRule ^/http-bind(.*) http://someothersite.com/http-bind$1 [P,L]
</VirtualHost>
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
Server-side authentication
==========================
Update documentation
2013-07-25 00:09:09 +02:00
.. _`Session Support`:
Update text on prebinding.
2013-12-14 10:58:47 +01:00
Prebinding and Single Session Support
-------------------------------------
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
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,
Update text on prebinding.
2013-12-14 10:58:47 +01:00
This session should also persist across page loads. In other words, we don't
want the user to have to give their chat credentials every time they reload the
page.
Update docs. - Add link to Movim's page on BOSH servers - Update the text around prebinding a bit.
2013-11-19 21:56:48 +01:00
To do this you will require a `BOSH server <http://xmpp.org/about-xmpp/technology-overview/bosh/>`_
for converse.js to connect to (see the `bosh_service_url`_ under `Configuration variables`_)
Update text on prebinding.
2013-12-14 10:58:47 +01:00
as well as a BOSH client on your own server (written for example in Python, Ruby or PHP) that will
do the pre-authentication before the web page loads.
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
Update docs. - Add link to Movim's page on BOSH servers - Update the text around prebinding a bit.
2013-11-19 21:56:48 +01:00
.. note::
A BOSH server acts as a bridge between HTTP, the protocol of the web, and
XMPP, the instant messaging protocol.
Converse.js can only communicate via HTTP, but we need to communicate with
an XMPP server in order to chat. So the BOSH server acts as a middle man,
translating our HTTP requests into XMPP stanzas and vice versa.
Add note to prebind section
2013-06-03 22:48:34 +02:00
Update docs. - Add link to Movim's page on BOSH servers - Update the text around prebinding a bit.
2013-11-19 21:56:48 +01:00
Jack Moffitt has a great `blogpost`_ about this and even provides an `example Django application`_ to demonstrate it.
When you authenticate to the XMPP server on your backend application (for
Update text on prebinding.
2013-12-14 10:58:47 +01:00
example via a BOSH client in Django), you'll receive two tokens, RID (request ID) and SID (session ID).
The **Session ID (SID)** is a unique identifier for the current *session*. This
number stays constant for the entire session.
The **Request ID (RID)** is a unique identifier for the current *request* (i.e.
page load). Each page load is a new request which requires a new unique RID.
The best way to achieve this is to simply increment the RID with each page
load.
Add more info on prebinding/session support
2013-06-03 22:42:34 +02:00
Update text on prebinding.
2013-12-14 10:58:47 +01:00
When you initialize converse.js in your browser, you need to pass it these two
tokens. Converse.js will then use them to attach to the session you just
created.
Add more info on prebinding/session support
2013-06-03 22:42:34 +02:00
You can embed the RID and SID tokens in your HTML markup or you can do an
When prebinding, attach automatically. Fixes #41 This requires that valid jid, rid, sid and bosh_service_url values be given (or a valid connection object that was already attached). Updated the docs to reflect these changes.
2013-08-23 00:48:53 +02:00
XMLHttpRequest call to your server and ask it to return them for you.
Add more info on prebinding/session support
2013-06-03 22:42:34 +02:00
Below is one example of how this could work. An Ajax call is made to the
relative URL **/prebind** and it expects to receive JSON data back.
Add option to set the XHR user search URL. Fixes #51
2013-10-20 18:34:20 +02:00
::
Add more info on prebinding/session support
2013-06-03 22:42:34 +02:00
$.getJSON('/prebind', function (data) {
When prebinding, attach automatically. Fixes #41 This requires that valid jid, rid, sid and bosh_service_url values be given (or a valid connection object that was already attached). Updated the docs to reflect these changes.
2013-08-23 00:48:53 +02:00
converse.initialize({
prebind: true,
bosh_service_url: data.bosh_service_url,
jid: data.jid,
sid: data.sid,
rid: data.rid
});
Add more info on prebinding/session support
2013-06-03 22:42:34 +02:00
);
**Here's what's happening:**
Update docs. - Add link to Movim's page on BOSH servers - Update the text around prebinding a bit.
2013-11-19 21:56:48 +01:00
The JSON data returned from the Ajax call to example.com/prebind contains the user's JID (jabber ID), RID, SID and the URL to the
BOSH server (also called a *connection manager*).
These values are then passed to converse.js's ``initialize`` method.
.. note::
If you want to enable single session support, you need to set **prebind: true**
when calling **converse.initialize** (see ./index.html).
Additionally you need to pass in valid **jid**, **sid**, **rid** and
**bosh_service_url** values.
Update docs to provide examples of server-side prebind code. Updates #116
2014-01-30 04:01:10 +01:00
Example code for server-side prebinding
---------------------------------------
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
* PHP:
Update docs to provide examples of server-side prebind code. Updates #116
2014-01-30 04:01:10 +01:00
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.
Added a section to the documentation concerning OTR
2014-02-12 18:32:25 +01:00
========
Features
========
Off-the-record encryption
=========================
Converse.js supports `Off-the-record (OTR) <https://otr.cypherpunks.ca/>`_
encrypted messaging.
The OTR protocol not only **encrypts your messages**, it provides ways to
**verify the identity** of the person you are talking to,
**plausible deniability** and **perfect forward secrecy** by generating
new encryption keys for each conversation.
In its current state, Javascript cryptography is fraught with dangers and
challenges that make it impossible to reach the same standard of security that
is available with native "desktop" software.
This is due to its runtime malleability, the way it is "installed" (e.g.
served) and the browser's lack of cryptographic primitives needed to implement
secure crypto.
For harsh but fairly valid criticism of Javascript cryptography, read:
`Javascript Cryptography Considered Harmful <http://www.matasano.com/articles/javascript-cryptography/>`_.
To get an idea on how this applies to OTR support in Converse.js, please read
`my thoughts on it <https://opkode.com/media/blog/2013/11/11/conversejs-otr-support>`_.
For now, suffice to say that although its useful to have OTR support in
Converse.js in order to avoid most eavesdroppers, if you need serious
communications privacy, then you're much better off using native software.
Update the docs and add section about sound notifications. updates #62
2014-08-23 10:56:38 +02:00
Sound Notifications
===================
From version 0.8.1 Converse.js can play a sound notification when you receive a
message.
For more info, please see the `play_sounds`_ configuration setting.
Multilingual Support
====================
Converse.js is translated into multiple languages. The default build,
``converse.min.js``, includes all languages.
Languages increase the size of the Converse.js significantly.
If you only need one, or a subset of the available languages, it's better to
make a custom build which includes only those languages that you need.
Add extra chat room commands: /nick, /mute and /voice. Also document the available chat room commands.
2014-09-05 18:27:32 +02:00
Chat Rooms
==========
Commands
--------
Here are the different commands that may be used in a chat room:
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| Event Type | When is it triggered? | Example (substitue $nickname with an actual user's nickname) |
+============+==============================================================================================+===============================================================+
| **ban** | Ban a user from the chat room. They will not be able to join again. | /ban $nickname |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| **clear** | Clear the messages shown in the chat room. | /clear |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
Provide feedback if a chat room command didn't work.
2014-09-05 19:36:31 +02:00
| **deop** | Make a moderator a normal participant. | /deop $nickname [$reason] |
Add extra chat room commands: /nick, /mute and /voice. Also document the available chat room commands.
2014-09-05 18:27:32 +02:00
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| **help** | Show the list of available commands. | /help |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
Provide feedback if a chat room command didn't work.
2014-09-05 19:36:31 +02:00
| **kick** | Kick a user out of a room. They will be able to join again. | /kick $nickname [$reason] |
Add extra chat room commands: /nick, /mute and /voice. Also document the available chat room commands.
2014-09-05 18:27:32 +02:00
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| **me** | Speak in the 3rd person. | /me $message |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
Provide feedback if a chat room command didn't work.
2014-09-05 19:36:31 +02:00
| **mute** | Remove a user's ability to post messages to the room. They will still be able to observe. | /mute $nickname [$reason] |
Add extra chat room commands: /nick, /mute and /voice. Also document the available chat room commands.
2014-09-05 18:27:32 +02:00
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| **nick** | Change your nickname. | /nick $nickname |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
Provide feedback if a chat room command didn't work.
2014-09-05 19:36:31 +02:00
| **op** | Make a normal participant a moderator. | /op $nickname [$reason] |
Add extra chat room commands: /nick, /mute and /voice. Also document the available chat room commands.
2014-09-05 18:27:32 +02:00
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| **topic** | Set the topic of the chat room. | /topic ${topic text} |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
Provide feedback if a chat room command didn't work.
2014-09-05 19:36:31 +02:00
| **voice** | Allow a muted user to post messages to the room. | /voice $nickname [$reason] |
Add extra chat room commands: /nick, /mute and /voice. Also document the available chat room commands.
2014-09-05 18:27:32 +02:00
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
===========
Development
===========
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
Update development section of the docs
2013-08-09 09:21:20 +02:00
If you want to work with the non-minified Javascript and CSS files you'll soon
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.
Mention windows. updates #187
2014-07-17 17:52:08 +02:00
.. Note:
Users have reported that converse.js cannot be built on Windows. Patches to
fix this are welcome.
Update development section of the docs
2013-08-09 09:21:20 +02:00
Add MakeFile target for setting up dev env.
2014-03-14 19:27:44 +01:00
Install the development and front-end dependencies
==================================================
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
We use development tools (`Grunt <http://gruntjs.com>`_ and `Bower <http://bower.io>`_)
which depend on Node.js and npm (the Node package manager).
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
If you don't have Node.js installed, you can download and install the latest
version `here <https://nodejs.org/download>`_.
Update documentation
2013-07-25 00:09:09 +02:00
Mention that git is needed Conflicts: docs/source/index.rst
2014-04-04 09:01:40 +02:00
Also make sure you have ``git`` installed. `Details <http://git-scm.com/book/en/Getting-Started-Installing-Git>`_.
Once you have *Node.js* and *git* installed, run the following command inside the Converse.js
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
directory:
Update documentation
2013-07-25 00:09:09 +02:00
::
Add MakeFile target for setting up dev env.
2014-03-14 19:27:44 +01:00
make dev
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
In docs: Mention alternative to using make
2014-07-23 13:18:09 +02:00
Or alternatively, if you don't have GNU Make:
::
npm install
bower update
Add MakeFile target for setting up dev env.
2014-03-14 19:27:44 +01:00
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.
Update development section of the docs
2013-08-09 09:21:20 +02:00
Add MakeFile target for setting up dev env.
2014-03-14 19:27:44 +01:00
The front-end dependencies are those javascript files on which
In docs: Mention alternative to using make
2014-07-23 13:18:09 +02:00
Converse.js directly depends and which will be loaded in the browser.
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
Mention that git is needed Conflicts: docs/source/index.rst
2014-04-04 09:01:40 +02:00
If you are curious to know what the different dependencies are:
Update development section of the docs
2013-08-09 09:21:20 +02:00
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
* Development dependencies:
Add MakeFile target for setting up dev env.
2014-03-14 19:27:44 +01:00
Take a look at whats under the *devDependencies* key in
`package.json <https://github.com/jcbrand/converse.js/blob/master/package.json>`_.
Update development section of the docs
2013-08-09 09:21:20 +02:00
Add MakeFile target for setting up dev env.
2014-03-14 19:27:44 +01:00
* Front-end dependencies:
See *dependencies* in
`bower.json <https://github.com/jcbrand/converse.js/blob/master/bower.json>`_.
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
Add MakeFile target for setting up dev env.
2014-03-14 19:27:44 +01:00
.. Note:
After running ```make dev```, you should now have a new directory *components*,
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
In docs: Mention alternative to using make
2014-07-23 13:18:09 +02:00
listed. For support, you can write to the mailing list: conversejs@librelist.com
Mention case where grunt is not installed globally
2013-09-17 12:07:42 +02:00
Update development section of the docs
2013-08-09 09:21:20 +02:00
docs w.r.t using development files with(out) require.js. Updates #9
2013-07-27 01:48:10 +02:00
With AMD and require.js (recommended)
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
=====================================
docs w.r.t using development files with(out) require.js. Updates #9
2013-07-27 01:48:10 +02:00
Update development section of the docs
2013-08-09 09:21:20 +02:00
Converse.js uses `require.js <http://requirejs.org>`_ to asynchronously load dependencies.
docs w.r.t using development files with(out) require.js. Updates #9
2013-07-27 01:48:10 +02:00
If you want to develop or customize converse.js, you'll want to load the
non-minified javascript files.
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
Add the following two lines to the *<head>* section of your webpage:
docs w.r.t using development files with(out) require.js. Updates #9
2013-07-27 01:48:10 +02:00
::
<link rel="stylesheet" type="text/css" media="screen" href="converse.css">
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
<script data-main="main" src="components/requirejs/require.js"></script>
docs w.r.t using development files with(out) require.js. Updates #9
2013-07-27 01:48:10 +02:00
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
require.js will then let the main.js file be parsed (because of the *data-main*
attribute on the *script* tag), which will in turn cause converse.js to be
parsed.
docs w.r.t using development files with(out) require.js. Updates #9
2013-07-27 01:48:10 +02:00
Without AMD and require.js
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
==========================
docs w.r.t using development files with(out) require.js. Updates #9
2013-07-27 01:48:10 +02:00
Converse.js can also be used without require.js. If you for some reason prefer
Add option to set the XHR user search URL. Fixes #51
2013-10-20 18:34:20 +02:00
to use it this way, please refer to
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
`non_amd.html <https://github.com/jcbrand/converse.js/blob/master/non_amd.html>`_
for an example of how and in what order all the Javascript files that converse.js
depends on need to be loaded.
docs w.r.t using development files with(out) require.js. Updates #9
2013-07-27 01:48:10 +02:00
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
Update docs with info on tests
2013-07-29 23:22:41 +02:00
Before submitting a pull request
================================
Add tests for your bugfix or feature
------------------------------------
Add a test for any bug fixed or feature added. We use Jasmine
Add option to set the XHR user search URL. Fixes #51
2013-10-20 18:34:20 +02:00
for testing.
Update docs with info on tests
2013-07-29 23:22:41 +02:00
Take a look at ``tests.html`` and ``spec/MainSpec.js`` to see how
the tests are implemented.
Add option to set the XHR user search URL. Fixes #51
2013-10-20 18:34:20 +02:00
If you are unsure how to write tests, please
Add info on facebook integration
2013-08-13 11:19:40 +02:00
`contact me <http://opkode.com/contact>`_ and I'll be happy to help.
Update docs with info on tests
2013-07-29 23:22:41 +02:00
Check that the tests pass
-------------------------
Add option to set the XHR user search URL. Fixes #51
2013-10-20 18:34:20 +02:00
Check that the Jasmine tests complete sucessfully. Open
Update docs with info on tests
2013-07-29 23:22:41 +02:00
`tests.html <https://github.com/jcbrand/converse.js/blob/master/tests.html>`_
in your browser, and the tests will run automatically.
On the command line you can run:
::
grunt test
Check your code for errors or bad habits by running JSHint
----------------------------------------------------------
`JSHint <http://jshint.com>`_ will do a static analysis of your code and hightlight potential errors
and/or bad habits.
::
grunt jshint
You can run both the tests and jshint in one go by calling:
::
grunt check
Added a section to the documentation concerning OTR
2014-02-12 18:32:25 +01:00
Minification
============
Minifying Javascript and CSS
----------------------------
Please make sure to read the section `Development`_ and that you have installed
all development dependencies (long story short, you can run ``npm install``
and then ``grunt fetch``).
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 minify the Javascript and CSS, run the following command:
::
grunt minify
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`_.
CSS is minified via `cssmin <https://github.com/gruntjs/grunt-contrib-cssmin>`_.
Translations
============
.. Note ::
Translations take up a lot of space and will bloat your minified file.
At the time of writing, all the translations add about 50KB of extra data to
the minified javascript file. Therefore, make sure to only
include those languages that you intend to support and remove from
./locale/locales.js those which you don't need. Remember to rebuild the
minified file afterwards.
The gettext POT file located in ./locale/converse.pot is the template
containing all translations and from which for each language an individual PO
file is generated.
The POT file contains all translateable strings extracted from converse.js.
To make a user facing string translateable, wrap it in the double underscore helper
function like so:
::
__('This string will be translated at runtime');
After adding the string, you'll need to regenerate the POT file, like so:
::
make pot
You can then create or update the PO file for a specific language by doing the following:
::
msgmerge ./locale/de/LC_MESSAGES/converse.po ./locale/converse.pot -U
To do this for ALL languages, run:
::
Add MakeFile target for setting up dev env.
2014-03-14 19:27:44 +01:00
make po
Added a section to the documentation concerning OTR
2014-02-12 18:32:25 +01:00
The resulting PO file is then what gets translated.
If you've created a new PO file, please make sure to add the following
attributes at the top of the file (under *Content-Transfer-Encoding*). They are
required as configuration settings for Jed, the Javascript translations library
that we're using.
::
"domain: converse\n"
"lang: de\n"
"plural_forms: nplurals=2; plural=(n != 1);\n"
Unfortunately `Jed <http://slexaxton.github.io/Jed>`_ cannot use the PO files directly. We have to generate from it
a file in JSON format and then put that in a .js file for the specific
language.
To generate JSON from a PO file, you'll need po2json for node.js. Run the
following command to install it (npm being the node.js package manager):
::
npm install po2json
You can then convert the translations into JSON format:
::
po2json locale/de/LC_MESSAGES/converse.po locale/de/LC_MESSAGES/converse.json
Now from converse.json paste the data as a value for the "locale_data" key in the
object in the language's .js file.
So, if you are for example translating into German (language code 'de'), you'll
create or update the file ./locale/LC_MESSAGES/de.js with the following code:
::
(function (root, factory) {
define("de", ['jed'], function () {
return factory(new Jed({
"domain": "converse",
"locale_data": {
// Paste the JSON data from converse.json here
}
})
}
}(this, function (i18n) {
return i18n;
}));
making sure to also paste the JSON data as value to the "locale_data" key.
.. Note ::
If you are adding translations for a new language that is not already supported,
you'll have to make one more edit in ./locale/locales.js to make sure the
language is loaded by require.js.
Congratulations, you've now succesfully added your translations. Sorry for all
those hoops you had to jump through.
Update docs with info on tests
2013-07-29 23:22:41 +02:00
Add Troubleshooting section to docs and regenerate HTML. Updates #86
2013-11-24 15:17:48 +01:00
===============
Troubleshooting
===============
Conflicts with other Javascript libraries
=========================================
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
Problem:
Add Troubleshooting section to docs and regenerate HTML. Updates #86
2013-11-24 15:17:48 +01:00
---------
You are using other Javascript libraries (like JQuery plugins), and
get errors like these in your browser console::
Uncaught TypeError: Object [object Object] has no method 'xxx' from example.js
Solution:
---------
First, find out which object is referred to by ``Object [object Object]``.
It will probably be the jQuery object ``$`` or perhaps the underscore.js object ``_``.
For the purpose of demonstration, I'm going to assume its ``$``, but the same
rules apply if its something else.
The bundled and minified default build of converse.js, ``converse.min.js``
includes within it all of converse.js's dependencies, which include for example *jQuery*.
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
If you are having conflicts where attributes or methods aren't available
Add Troubleshooting section to docs and regenerate HTML. Updates #86
2013-11-24 15:17:48 +01:00
on the jQuery object, you are probably loading ``converse.min.js`` (which
includes jQuery) as well as your own jQuery version separately.
What then happens is that there are two ``$`` objects (one from
converse.js and one from the jQuery version you included manually)
and only one of them has been extended to have the methods or attributes you require.
Which jQuery object you get depends on the order in which you load the libraries.
There are multiple ways to solve this issue.
Firstly, make sure whether you really need to include a separate version of
jQuery. Chances are that you don't. If you can remove the separate
version, your problem should be solved, as long as your libraries are loaded in
the right order.
Either case, whether you need to keep two versions or not, the solution depends
on whether you'll use require.js to manage your libraries or whether you'll
load them manually.
With require.js
~~~~~~~~~~~~~~~
Instead of using ``converse.min.js``, manage all the libraries in your project
(i.e. converse.js and its dependencies plus all other libraries you use) as one
require.js project, making sure everything is loaded in the correct order.
Then, before deployment, you make your own custom minified build that bundles everything
you need.
With <script> tags
~~~~~~~~~~~~~~~~~~
Take a look at `non_amd.html <https://github.com/jcbrand/converse.js/blob/master/non_amd.html>`_
in the converse.js repo.
It shows in which order the libraries must be loaded via ``<script>`` tags. Add
your own libraries, making sure that they are loaded in the correct order (e.g.
jQuery plugins must load after jQuery).
Add documentation for events emitted. Updates #48
2013-12-15 16:06:27 +01:00
======
Events
======
Converse.js emits events to which you can subscribe from your own Javascript.
Concerning events, the following methods are available:
Event Methods
=============
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
* **on(eventName, callback)**:
Add documentation for events emitted. Updates #48
2013-12-15 16:06:27 +01:00
Calling the ``on`` method allows you to subscribe to an event.
Every time the event fires, the callback method specified by ``callback`` will be
called.
Parameters:
* ``eventName`` is the event name as a string.
* ``callback`` is the callback method to be called when the event is emitted.
For example::
Rename events. Remove the "on" prefix. Events are listened to via "on" method, so it's redundant.
2014-07-06 18:31:17 +02:00
converse.on('message', function (messageXML) { ... });
Add documentation for events emitted. Updates #48
2013-12-15 16:06:27 +01:00
* **once(eventName, callback)**:
Calling the ``once`` method allows you to listen to an event
exactly once.
Parameters:
* ``eventName`` is the event name as a string.
* ``callback`` is the callback method to be called when the event is emitted.
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
Add documentation for events emitted. Updates #48
2013-12-15 16:06:27 +01:00
For example::
Rename events. Remove the "on" prefix. Events are listened to via "on" method, so it's redundant.
2014-07-06 18:31:17 +02:00
converse.once('message', function (messageXML) { ... });
Add documentation for events emitted. Updates #48
2013-12-15 16:06:27 +01:00
* **off(eventName, callback)**
To stop listening to an event, you can use the ``off`` method.
Parameters:
* ``eventName`` is the event name as a string.
* ``callback`` refers to the function that is to be no longer executed.
Event Types
===========
Here are the different events that are emitted:
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| Event Type | When is it triggered? | Example |
+==================================+===================================================================================================+=========================================================================================+
Rename events. Remove the "on" prefix. Events are listened to via "on" method, so it's redundant.
2014-07-06 18:31:17 +02:00
| **initialized** | Once converse.js has been initialized. | ``converse.on('initialized', function () { ... });`` |
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
Rename events. Remove the "on" prefix. Events are listened to via "on" method, so it's redundant.
2014-07-06 18:31:17 +02:00
| **ready** | After connection has been established and converse.js has got all its ducks in a row. | ``converse.on('ready', function () { ... });`` |
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
Rename events. Remove the "on" prefix. Events are listened to via "on" method, so it's redundant.
2014-07-06 18:31:17 +02:00
| **reconnect** | After the connection has dropped. Converse.js will attempt to reconnect when not in prebind mode. | ``converse.on('reconnect', function () { ... });`` |
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
Rename events. Remove the "on" prefix. Events are listened to via "on" method, so it's redundant.
2014-07-06 18:31:17 +02:00
| **message** | When a message is received. | ``converse.on('message', function (messageXML) { ... });`` |
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
Rename events. Remove the "on" prefix. Events are listened to via "on" method, so it's redundant.
2014-07-06 18:31:17 +02:00
| **messageSend** | When a message will be sent out. | ``converse.on('messageSend', function (messageText) { ... });`` |
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
Rename events. Remove the "on" prefix. Events are listened to via "on" method, so it's redundant.
2014-07-06 18:31:17 +02:00
| **roster** | When the roster is updated. | ``converse.on('roster', function (items) { ... });`` |
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
Rename events. Remove the "on" prefix. Events are listened to via "on" method, so it's redundant.
2014-07-06 18:31:17 +02:00
| **callButtonClicked** | When a call button (i.e. with class .toggle-call) on a chat box has been clicked. | ``converse.on('callButtonClicked', function (connection, model) { ... });`` |
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
Rename events. Remove the "on" prefix. Events are listened to via "on" method, so it's redundant.
2014-07-06 18:31:17 +02:00
| **chatBoxOpened** | When a chat box has been opened. | ``converse.on('chatBoxOpened', function (chatbox) { ... });`` |
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
Two changes, see below: * Call refreshWebkit hack when opening a chat room * New event emitted when a chat room is opened.
2014-07-17 19:18:13 +02:00
| **chatRoomOpened** | When a chat room has been opened. | ``converse.on('chatRoomOpened', function (chatbox) { ... });`` |
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
Rename events. Remove the "on" prefix. Events are listened to via "on" method, so it's redundant.
2014-07-06 18:31:17 +02:00
| **chatBoxClosed** | When a chat box has been closed. | ``converse.on('chatBoxClosed', function (chatbox) { ... });`` |
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
Rename events. Remove the "on" prefix. Events are listened to via "on" method, so it's redundant.
2014-07-06 18:31:17 +02:00
| **chatBoxFocused** | When the focus has been moved to a chat box. | ``converse.on('chatBoxFocused', function (chatbox) { ... });`` |
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
Rename events. Remove the "on" prefix. Events are listened to via "on" method, so it's redundant.
2014-07-06 18:31:17 +02:00
| **chatBoxToggled** | When a chat box has been minimized or maximized. | ``converse.on('chatBoxToggled', function (chatbox) { ... });`` |
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
Emit an event after the user has sent out a chat room invitation. refs #215
2014-08-31 21:54:17 +02:00
| **roomInviteSent** | After the user has sent out a direct invitation, to a roster contact, asking them to join a room. | ``converse.on('roomInvite', function (roomview, invitee_jid, reason) { ... });`` |
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| **roomInviteReceived** | After the user has sent out a direct invitation, to a roster contact, asking them to join a room. | ``converse.on('roomInvite', function (roomview, invitee_jid, reason) { ... });`` |
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
Rename events. Remove the "on" prefix. Events are listened to via "on" method, so it's redundant.
2014-07-06 18:31:17 +02:00
| **statusChanged** | When own chat status has changed. | ``converse.on('statusChanged', function (status) { ... });`` |
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
Rename events. Remove the "on" prefix. Events are listened to via "on" method, so it's redundant.
2014-07-06 18:31:17 +02:00
| **statusMessageChanged** | When own custom status message has changed. | ``converse.on('statusMessageChanged', function (message) { ... });`` |
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
Rename events. Remove the "on" prefix. Events are listened to via "on" method, so it's redundant.
2014-07-06 18:31:17 +02:00
| **buddyStatusChanged** | When a chat buddy's chat status has changed. | ``converse.on('buddyStatusChanged', function (buddy, status) { ... });`` |
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| **buddyStatusMessageChanged** | When a chat buddy's custom status message has changed. | ``converse.on('buddyStatusMessageChanged', function (buddy, messageText) { ... });`` |
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
Add documentation for events emitted. Updates #48
2013-12-15 16:06:27 +01:00
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
=============
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.
Update documentation
2013-07-25 00:09:09 +02:00
You'll most likely want to call the *initialize* method in your HTML page. For
an example of how this is done, please see the bottom of the *./index.html* page.
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
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
=======================
Add docs directory And a file with some preliminary notes
2013-04-20 11:30:18 +02:00
Add config option ``allow_contact_requests`` to toggle user adding
2013-10-03 14:22:33 +02:00
allow_contact_requests
----------------------
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Default: ``true``
Add config option ``allow_contact_requests`` to toggle user adding
2013-10-03 14:22:33 +02:00
Add option to set the XHR user search URL. Fixes #51
2013-10-20 18:34:20 +02:00
Allow users to add one another as contacts. If this is set to false, the
Add config option ``allow_contact_requests`` to toggle user adding
2013-10-03 14:22:33 +02:00
**Add a contact** widget, **Contact Requests** and **Pending Contacts** roster
sections will all not appear. Additionally, all incoming contact requests will be
ignored.
Add setting to enable/disable MUC
2013-10-03 13:16:26 +02:00
allow_muc
---------
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Default: ``true``
Add setting to enable/disable MUC
2013-10-03 13:16:26 +02:00
Allow multi-user chat (muc) in chatrooms. Setting this to ``false`` will remove
the ``Chatrooms`` tab from the control box.
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
allow_muc
---------
Default: ``true``
Allow Off-the-record encryption of single-user chat messages.
Make config options alphabetical. Add hide_muc_server
2013-05-21 16:48:19 +02:00
animate
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
-------
Make config options alphabetical. Add hide_muc_server
2013-05-21 16:48:19 +02:00
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Default: ``true``
Make config options alphabetical. Add hide_muc_server
2013-05-21 16:48:19 +02:00
Show animations, for example when opening and closing chat boxes.
auto_list_rooms
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
---------------
Make config options alphabetical. Add hide_muc_server
2013-05-21 16:48:19 +02:00
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Default: ``false``
Make config options alphabetical. Add hide_muc_server
2013-05-21 16:48:19 +02:00
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.
Add option to set the XHR user search URL. Fixes #51
2013-10-20 18:34:20 +02:00
features, number of occupants etc.), so on servers with many rooms this
Make config options alphabetical. Add hide_muc_server
2013-05-21 16:48:19 +02:00
option will create lots of extra connection traffic.
Refactor and improve the reconnecting code and make it configurable There is still the apparent problem that after reconnecting, event listeners hvae to bre reregistered (which doesn't happen currently). So messages can be sent but not received...
2014-02-11 12:14:36 +01:00
auto_reconnect
--------------
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Default: ``true``
Refactor and improve the reconnecting code and make it configurable There is still the apparent problem that after reconnecting, event listeners hvae to bre reregistered (which doesn't happen currently). So messages can be sent but not received...
2014-02-11 12:14:36 +01:00
Automatically reconnect to the XMPP server if the connection drops
unexpectedly.
Make config options alphabetical. Add hide_muc_server
2013-05-21 16:48:19 +02:00
auto_subscribe
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
--------------
Make config options alphabetical. Add hide_muc_server
2013-05-21 16:48:19 +02:00
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Default: ``false``
Make config options alphabetical. Add hide_muc_server
2013-05-21 16:48:19 +02:00
If true, the user will automatically subscribe back to any contact requests.
bosh_service_url
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
----------------
Make config options alphabetical. Add hide_muc_server
2013-05-21 16:48:19 +02:00
Connections to an XMPP server depend on a BOSH connection manager which acts as
a middle man between HTTP and XMPP.
Update docs with info on how to set up the dev env
2013-07-29 23:13:55 +02:00
See `here <http://metajack.im/2008/09/08/which-bosh-server-do-you-need>`_ for more information.
Make config options alphabetical. Add hide_muc_server
2013-05-21 16:48:19 +02:00
Allow the OTR private key to be cached. Updates #111
2014-01-31 17:07:44 +01:00
cache_otr_key
-------------
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Default: ``false``
Allow the OTR private key to be cached. Updates #111
2014-01-31 17:07:44 +01:00
Let the `OTR (Off-the-record encryption) <https://otr.cypherpunks.ca>`_ private
key be cached in your browser's session storage.
The browser's session storage persists across page loads but is deleted once
the tab or window is closed.
Add API method to retrieve the SID. Fixes #93
2014-02-12 11:37:39 +01:00
If this option is set to ``false``, a new OTR private key will be generated
Allow the OTR private key to be cached. Updates #111
2014-01-31 17:07:44 +01:00
for each page load. While more inconvenient, this is a much more secure option.
This setting can only be used together with ``allow_otr = true``.
Add API method to retrieve the SID. Fixes #93
2014-02-12 11:37:39 +01:00
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
.. Note ::
Add API method to retrieve the SID. Fixes #93
2014-02-12 11:37:39 +01:00
A browser window's session storage is accessible by all javascript that
is served from the same domain. So if there is malicious javascript served by
the same server (or somehow injected via an attacker), then they will be able
to retrieve your private key and read your all the chat messages in your
current session. Previous sessions however cannot be decrypted.
Mention debug option in docs
2013-08-16 11:25:58 +02:00
debug
-----
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Default: ``false``
Add setting to enable/disable MUC
2013-10-03 13:16:26 +02:00
Mention debug option in docs
2013-08-16 11:25:58 +02:00
If set to true, debugging output will be logged to the browser console.
Rename 'enable_message_carbons' to 'message_carbons'
2014-07-19 16:36:43 +02:00
message_carbons
See below... * Update docs on message carbons and stanza forwarding. * Mention latest bug fix.
2014-09-02 16:53:44 +02:00
---------------
Add support for XEP-0280 Message Carbons. updates #132
2014-04-19 06:58:26 +02:00
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Default: ``false``
Add support for XEP-0280 Message Carbons. updates #132
2014-04-19 06:58:26 +02:00
Support for `XEP-0280: Message Carbons <https://xmpp.org/extensions/xep-0280.html>`_
See below... * Update docs on message carbons and stanza forwarding. * Mention latest bug fix.
2014-09-02 16:53:44 +02:00
In order to keep all IM clients for a user engaged in a conversation,
outbound messages are carbon-copied to all interested resources.
This is especially important in webchat, like converse.js, where each browser
tab serves as a separate IM client.
Both message_carbons and `forward_messages`_ try to solve the same problem
(showing sent messages in all connected chat clients aka resources), but go about it
in two different ways.
Message carbons is the XEP (Jabber protocol extension) specifically drafted to
Add extra chat room commands: /nick, /mute and /voice. Also document the available chat room commands.
2014-09-05 18:27:32 +02:00
solve this problem, while `forwarded_messages`_ uses
See below... * Update docs on message carbons and stanza forwarding. * Mention latest bug fix.
2014-09-02 16:53:44 +02:00
`stanza forwarding <http://www.xmpp.org/extensions/xep-0297.html>`_
Add API method to retrieve the SID. Fixes #93
2014-02-12 11:37:39 +01:00
expose_rid_and_sid
------------------
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Default: ``false``
Add new configuration setting "forward_messages". What was before default behavior is now optional and disabled by default.
2014-04-19 06:18:17 +02:00
Add API method to retrieve the SID. Fixes #93
2014-02-12 11:37:39 +01:00
Allow the prebind tokens, RID (request ID) and SID (session ID), to be exposed
globally via the API. This allows other scripts served on the same page to use
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
these values.
Add API method to retrieve the SID. Fixes #93
2014-02-12 11:37:39 +01:00
*Beware*: a malicious script could use these tokens to assume your identity
and inject fake chat messages.
Add new configuration setting "forward_messages". What was before default behavior is now optional and disabled by default.
2014-04-19 06:18:17 +02:00
forward_messages
----------------
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Default: ``false``
Add new configuration setting "forward_messages". What was before default behavior is now optional and disabled by default.
2014-04-19 06:18:17 +02:00
See below... * Update docs on message carbons and stanza forwarding. * Mention latest bug fix.
2014-09-02 16:53:44 +02:00
If set to ``true``, sent messages will also be forwarded to the sending user's
bare JID (their Jabber ID independent of any chat clients aka resources).
This means that sent messages are visible from all the user's chat clients,
and not just the one from which it was actually sent.
This is especially important for web chat, such as converse.js, where each
browser tab functions as a separate chat client, with its own resource.
Add new configuration setting "forward_messages". What was before default behavior is now optional and disabled by default.
2014-04-19 06:18:17 +02:00
See below... * Update docs on message carbons and stanza forwarding. * Mention latest bug fix.
2014-09-02 16:53:44 +02:00
This feature uses Stanza forwarding, see also `XEP 0297: Stanza Forwarding <http://www.xmpp.org/extensions/xep-0297.html>`_
Add new configuration setting "forward_messages". What was before default behavior is now optional and disabled by default.
2014-04-19 06:18:17 +02:00
See below... * Update docs on message carbons and stanza forwarding. * Mention latest bug fix.
2014-09-02 16:53:44 +02:00
For an alternative approach, see also `message carbons`_.
Add new configuration setting "forward_messages". What was before default behavior is now optional and disabled by default.
2014-04-19 06:18:17 +02:00
Make config options alphabetical. Add hide_muc_server
2013-05-21 16:48:19 +02:00
fullname
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
--------
Make config options alphabetical. Add hide_muc_server
2013-05-21 16:48:19 +02:00
Mention i18n/locales setting
2013-08-24 03:09:57 +02:00
If you are using prebinding, can specify the fullname of the currently
logged in user, otherwise the user's vCard will be fetched.
Make config options alphabetical. Add hide_muc_server
2013-05-21 16:48:19 +02:00
hide_muc_server
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
---------------
Make config options alphabetical. Add hide_muc_server
2013-05-21 16:48:19 +02:00
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Default: ``false``
Make config options alphabetical. Add hide_muc_server
2013-05-21 16:48:19 +02:00
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.
Mention i18n/locales setting
2013-08-24 03:09:57 +02:00
i18n
----
Specify the locale/language. The language must be in the ``locales`` object. Refer to
``./locale/locales.js`` to see which locales are supported.
Update the docs and add section about sound notifications. updates #62
2014-08-23 10:56:38 +02:00
play_sounds
-----------
Default: ``false``
Notification sound now also plays when nickname is mentioned in chat room. updates #62
2014-09-03 18:47:24 +02:00
Plays a notification sound when you receive a personal message or when your
nickname is mentioned in a chat room.
Update the docs and add section about sound notifications. updates #62
2014-08-23 10:56:38 +02:00
Inside the ``./sounds`` directory of the Converse.js repo, you'll see MP3 and Ogg
formatted sound files. We need both, because neither format is supported by all browsers.
For now, sound files are looked up by convention, not configuration. So to have
a sound play when a message is received, make sure that your webserver serves
it in both formats as ``http://yoursite.com/sounds/msg_received.mp3`` and
``http://yoursite.com/sounds/msg_received.ogg``.
``http://yoursite.com`` should of course be your site's URL.
typo and comment
2013-04-26 21:50:57 +02:00
prebind
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
--------
Add docs directory And a file with some preliminary notes
2013-04-20 11:30:18 +02:00
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Default: ``false``
Make config options alphabetical. Add hide_muc_server
2013-05-21 16:48:19 +02:00
Update docs regarding bosh_service_url setting
2013-04-25 00:16:16 +02:00
Use this option when you want to attach to an existing XMPP connection that was
already authenticated (usually on the backend before page load).
Add docs directory And a file with some preliminary notes
2013-04-20 11:30:18 +02:00
Update docs regarding bosh_service_url setting
2013-04-25 00:16:16 +02:00
This is useful when you don't want to render the login form on the chat control
box with each page load.
Add docs directory And a file with some preliminary notes
2013-04-20 11:30:18 +02:00
Add option to set the XHR user search URL. Fixes #51
2013-10-20 18:34:20 +02:00
For prebinding to work, your backend server must authenticate for you, and
When prebinding, attach automatically. Fixes #41 This requires that valid jid, rid, sid and bosh_service_url values be given (or a valid connection object that was already attached). Updated the docs to reflect these changes.
2013-08-23 00:48:53 +02:00
then return a JID (jabber ID), SID (session ID) and RID (Request ID).
Add docs directory And a file with some preliminary notes
2013-04-20 11:30:18 +02:00
When prebinding, attach automatically. Fixes #41 This requires that valid jid, rid, sid and bosh_service_url values be given (or a valid connection object that was already attached). Updated the docs to reflect these changes.
2013-08-23 00:48:53 +02:00
If you set ``prebind`` to ``true``, you have to make sure to also pass in these
values as ``jid``, ``sid``, ``rid``.
Add docs directory And a file with some preliminary notes
2013-04-20 11:30:18 +02:00
When prebinding, attach automatically. Fixes #41 This requires that valid jid, rid, sid and bosh_service_url values be given (or a valid connection object that was already attached). Updated the docs to reflect these changes.
2013-08-23 00:48:53 +02:00
Additionally, you have to specify ``bosh_service_url``.
Add docs directory And a file with some preliminary notes
2013-04-20 11:30:18 +02:00
Mention new feature, roster groups. updates #83
2014-08-04 19:49:29 +02:00
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.
Update docs regarding bosh_service_url setting
2013-04-25 00:16:16 +02:00
Add a config option to by default show the controlbox
2013-06-02 21:40:05 +02:00
show_controlbox_by_default
--------------------------
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Default: ``false``
Add a config option to by default show the controlbox
2013-06-02 21:40:05 +02:00
The "controlbox" refers to the special chatbox containing your contacts roster,
status widget, chatrooms and other controls.
By default this box is hidden and can be toggled by clicking on any element in
Control box toggle's class has been changed.
2014-06-21 11:32:05 +02:00
the page with class *toggle-controlbox*.
Add a config option to by default show the controlbox
2013-06-02 21:40:05 +02:00
If this options is set to true, the controlbox will by default be shown upon
page load.
New config option ``show_only_online_users`` If true, only users with a status of 'online' will be shown in the contacts roster.
2013-10-05 23:07:42 +02:00
show_only_online_users
----------------------
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Default: ``false``
New config option ``show_only_online_users`` If true, only users with a status of 'online' will be shown in the contacts roster.
2013-10-05 23:07:42 +02:00
If set to ``true``, only online users will be shown in the contacts roster.
Users with any other status (e.g. away, busy etc.) will not be shown.
Update docs regarding bosh_service_url setting
2013-04-25 00:16:16 +02:00
Integrate backbone.browserStorage. Fixes #176 Data is now by default cached in sessionStorage and not localStorage. Can be configured via the "storage" option.
2014-06-30 18:53:58 +02:00
storage
-------
Default: ``session``
Valid options: ``session``, ``local``.
Add extra chat room commands: /nick, /mute and /voice. Also document the available chat room commands.
2014-09-05 18:27:32 +02:00
This option determines the type of `storage <https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Storage>`_
Integrate backbone.browserStorage. Fixes #176 Data is now by default cached in sessionStorage and not localStorage. Can be configured via the "storage" option.
2014-06-30 18:53:58 +02:00
(``localStorage`` or ``sessionStorage``) used by converse.js to cache user data.
Originally converse.js used only localStorage, however sessionStorage is from a
privacy perspective a better choice.
The main difference between the two is that sessionStorage only persists while
the current tab or window containing a converse.js instance is open. As soon as
it's closed, the data is cleared.
Data in localStorage on the other hand is kept indefinitely.
Add cuationary note against using localStorage (instead of sessionStorage)
2014-09-04 10:27:24 +02:00
.. Note ::
Since version 0.8.0, the use of local storage is not recommended. The
statuses (online, away, busy etc.) of your roster contacts are cached in
the browser storage. If you use local storage, these values are stored for
multiple sessions, and they will likely become out of sync with your contacts'
actual statuses. The session storage doesn't have this problem, because
roster contact statuses will not become out of sync in a single session,
only across more than one session.
Merge branch 'otr-by-default' of git://github.com/Aupajo/converse.js into Apajo-otr-by-default Conflicts: converse.js Fixes #102
2014-02-12 11:49:36 +01:00
use_otr_by_default
------------------
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Default: ``false``
Merge branch 'otr-by-default' of git://github.com/Aupajo/converse.js into Apajo-otr-by-default Conflicts: converse.js Fixes #102
2014-02-12 11:49:36 +01:00
If set to ``true``, Converse.js will automatically try to initiate an OTR (off-the-record)
encrypted chat session every time you open a chat box.
Make the fetching of VCards optional. Updates #100
2013-12-17 18:24:36 +01:00
use_vcards
----------
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Default: ``true``
Make the fetching of VCards optional. Updates #100
2013-12-17 18:24:36 +01:00
Determines whether the XMPP server will be queried for roster contacts' VCards
or not. VCards contain extra personal information such as your fullname and
avatar image.
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
visible_toolbar_buttons
-----------------------
Default:
::
{
Update docs and rename option to use underscore instead of dash.
2014-09-03 20:15:46 +02:00
call: false,
clear: true,
emoticons: true,
toggle_participants: true
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
}
Allows you to show or hide buttons on the chat boxes' toolbars.
Add extra chat room commands: /nick, /mute and /voice. Also document the available chat room commands.
2014-09-05 18:27:32 +02:00
* *call*:
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Provides a button with a picture of a telephone on it.
Update docs and rename option to use underscore instead of dash.
2014-09-03 20:15:46 +02:00
When the call button is pressed, it will emit an event that can be used by a third-party library to initiate a call.::
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Rename events. Remove the "on" prefix. Events are listened to via "on" method, so it's redundant.
2014-07-06 18:31:17 +02:00
converse.on('callButtonClicked', function(event, data) {
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
console.log('Strophe connection is', data.connection);
console.log('Bare buddy JID is', data.model.get('jid'));
// ... Third-party library code ...
});
Add extra chat room commands: /nick, /mute and /voice. Also document the available chat room commands.
2014-09-05 18:27:32 +02:00
* *clear*:
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Provides a button for clearing messages from a chat box.
Add extra chat room commands: /nick, /mute and /voice. Also document the available chat room commands.
2014-09-05 18:27:32 +02:00
* *emoticons*:
Update docs and rename option to use underscore instead of dash.
2014-09-03 20:15:46 +02:00
Enables rendering of emoticons and provides a toolbar button for choosing them.
* toggle_participants:
Shows a button for toggling (i.e. showing/hiding) the list of participants in a chat room.
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Add option to set the XHR user search URL. Fixes #51
2013-10-20 18:34:20 +02:00
xhr_custom_status
-----------------
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Default: ``false``
Add option to set the XHR user search URL. Fixes #51
2013-10-20 18:34:20 +02:00
Simplify the boilerplate HTML require even more. Use id 'conversejs' instead of 'chatpanel'. The controlbox toggle is now generated via a backbone view, you don't need to manually include it in your markup.
2013-10-20 22:20:45 +02:00
.. Note ::
Add option to set the XHR user search URL. Fixes #51
2013-10-20 18:34:20 +02:00
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
This option will let converse.js make an AJAX POST with your changed custom chat status to a
remote server.
xhr_custom_status_url
---------------------
Simplify the boilerplate HTML require even more. Use id 'conversejs' instead of 'chatpanel'. The controlbox toggle is now generated via a backbone view, you don't need to manually include it in your markup.
2013-10-20 22:20:45 +02:00
.. Note ::
Add option to set the XHR user search URL. Fixes #51
2013-10-20 18:34:20 +02:00
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Default: Empty string
Add option to set the XHR user search URL. Fixes #51
2013-10-20 18:34:20 +02:00
Used only in conjunction with ``xhr_custom_status``.
This is the URL to which the AJAX POST request to set the user's custom status
message will be made.
The message itself is sent in the request under the key ``msg``.
Add docs directory And a file with some preliminary notes
2013-04-20 11:30:18 +02:00
xhr_user_search
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
---------------
Add docs directory And a file with some preliminary notes
2013-04-20 11:30:18 +02:00
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Default: ``false``
Make config options alphabetical. Add hide_muc_server
2013-05-21 16:48:19 +02:00
Simplify the boilerplate HTML require even more. Use id 'conversejs' instead of 'chatpanel'. The controlbox toggle is now generated via a backbone view, you don't need to manually include it in your markup.
2013-10-20 22:20:45 +02:00
.. Note ::
Add option to set the XHR user search URL. Fixes #51
2013-10-20 18:34:20 +02:00
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
There are two ways to add users.
Add docs directory And a file with some preliminary notes
2013-04-20 11:30:18 +02:00
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
* The user inputs a valid JID (Jabber ID), and the user is added as a pending contact.
Add option to set the XHR user search URL. Fixes #51
2013-10-20 18:34:20 +02:00
* The user inputs some text (for example part of a firstname or lastname), an XHR (Ajax Request) will be made to a remote server, 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.
*What is expected from the remote server?*
A default JSON encoded list of objects must be returned. Each object
corresponds to a matched user and needs the keys ``id`` and ``fullname``.
xhr_user_search_url
-------------------
Add docs directory And a file with some preliminary notes
2013-04-20 11:30:18 +02:00
Simplify the boilerplate HTML require even more. Use id 'conversejs' instead of 'chatpanel'. The controlbox toggle is now generated via a backbone view, you don't need to manually include it in your markup.
2013-10-20 22:20:45 +02:00
.. Note ::
Add option to set the XHR user search URL. Fixes #51
2013-10-20 18:34:20 +02:00
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
Expand documentation on the new visible_toolbar_buttons config option
2014-04-24 18:10:47 +02:00
Default: Empty string
Add option to set the XHR user search URL. Fixes #51
2013-10-20 18:34:20 +02:00
Used only in conjunction with ``xhr_user_search``.
This is the URL to which an AJAX GET request will be made to fetch user data from your remote server.
The query string will be included in the request with ``q`` as its key.
Add docs directory And a file with some preliminary notes
2013-04-20 11:30:18 +02:00
Use strict mode. Emit an event when the connection drops.
2014-04-24 09:51:21 +02:00
The calendar can be configured through a `data-pat-calendar` attribute.
The available options are:
Expand the docs Try to add more information on the goals around Converse.js and on how to get started.
2013-05-22 19:29:46 +02:00
.. _`read more about require.js's optimizer here`: http://requirejs.org/docs/optimization.html
Update the docs with info on connection managers etc.
2013-05-17 12:48:05 +02:00
.. _`HTTP`: https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol
.. _`XMPP`: https://en.wikipedia.org/wiki/Xmpp
.. _`Converse.js homepage`: http://conversejs.org
.. _`CORS`: https://en.wikipedia.org/wiki/Cross-origin_resource_sharing
.. _`Strophe.js plugin`: https://gist.github.com/1095825/6b4517276f26b66b01fa97b0a78c01275fdc6ff2
.. _`xmpp.net`: http://xmpp.net
.. _`xmpp.org`: http://xmpp.org/xmpp-software/servers/
.. _`ejabberd`: http://www.ejabberd.im
.. _`blogpost`: http://metajack.im/2008/10/03/getting-attached-to-strophe
.. _`example Django application`: https://github.com/metajack/strophejs/tree/master/examples/attach
Reference in New Issue Copy Permalink