Add MakeFile target for setting up dev env.
This commit is contained in:
parent
ad4d959df5
commit
b552b885f0
47
Makefile
47
Makefile
|
@ -11,35 +11,43 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ./d
|
|||
# the i18n builder cannot share the environment and doctrees with the others
|
||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ./docs/source
|
||||
|
||||
.PHONY: help clean html dirhtml singlehtml json htmlhelp devhelp epub latex latexpdf text changes linkcheck doctest gettext
|
||||
.PHONY: all help clean html dirhtml singlehtml json htmlhelp devhelp epub latex latexpdf text changes linkcheck doctest gettext po pot po2json merge release
|
||||
|
||||
all: dev
|
||||
|
||||
help:
|
||||
@echo "Please use \`make <target>' where <target> is one of"
|
||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||
@echo " devhelp to make HTML files and a Devhelp project"
|
||||
@echo " dirhtml to make HTML files named index.html in directories"
|
||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
@echo " epub to export the documentation to epub"
|
||||
@echo " dev to set up the development environment"
|
||||
@echo " gettext to make PO message catalogs of the documentation"
|
||||
@echo " html to make standalone HTML files of the documentation"
|
||||
@echo " htmlhelp to make HTML files and a HTML help project from the documentation"
|
||||
@echo " info to make Texinfo files and run them through makeinfo"
|
||||
@echo " json to make JSON files"
|
||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||
@echo " linkcheck to check all external links for integrity"
|
||||
@echo " pot generates a gettext POT file to be used for translations"
|
||||
@echo " pot to generate a gettext POT file to be used for translations"
|
||||
@echo " po to generate gettext PO files for each i18n language"
|
||||
@echo " po2json to generate JSON files from the language PO files"
|
||||
@echo " release to make a new minified release"
|
||||
@echo " singlehtml to make a single large HTML file"
|
||||
@echo " texinfo to make Texinfo files"
|
||||
@echo " text to make text files"
|
||||
|
||||
# @echo " changes to make an overview of all changed/added/deprecated items"
|
||||
# @echo " devhelp to make HTML files and a Devhelp project"
|
||||
# @echo " dirhtml to make HTML files named index.html in directories"
|
||||
# @echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
# @echo " epub to export the documentation to epub"
|
||||
# @echo " htmlhelp to make HTML files and a HTML help project from the documentation"
|
||||
# @echo " info to make Texinfo files and run them through makeinfo"
|
||||
# @echo " json to make JSON files"
|
||||
# @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||
# @echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||
# @echo " linkcheck to check all external links for integrity"
|
||||
# @echo " singlehtml to make a single large HTML file"
|
||||
# @echo " texinfo to make Texinfo files"
|
||||
# @echo " text to make text files"
|
||||
|
||||
pot:
|
||||
xgettext --keyword=__ --keyword=___ --from-code=UTF-8 --output=locale/converse.pot converse.js --package-name=Converse.js --copyright-holder="Jan-Carel Brand" --package-version=0.7.0 -c --language="python";
|
||||
|
||||
merge:
|
||||
po:
|
||||
find ./locale -maxdepth 1 -mindepth 1 -type d -exec msgmerge {}/LC_MESSAGES/converse.po ./locale/converse.pot -U \;
|
||||
|
||||
merge: po
|
||||
|
||||
po2json:
|
||||
find ./locale -maxdepth 1 -mindepth 1 -type d -exec po2json {}/LC_MESSAGES/converse.po {}/LC_MESSAGES/converse.json \;
|
||||
|
||||
|
@ -53,6 +61,11 @@ release:
|
|||
sed -i "s/(Unreleased)/(`date +%Y-%m-%d`)/" docs/CHANGES.rst
|
||||
grunt minify
|
||||
|
||||
dev:
|
||||
npm install
|
||||
./node_modules/.bin/bower update;
|
||||
cd ./components/strophe && make normal;
|
||||
|
||||
clean:
|
||||
-rm -rf $(BUILDDIR)/*
|
||||
|
||||
|
|
Binary file not shown.
|
@ -70,7 +70,7 @@ You'll most likely want to implement some kind of single-signon solution for
|
|||
your website, where users authenticate once in your website and then stay
|
||||
logged into their XMPP session upon page reload.
|
||||
|
||||
For more info on this, read: `Pre-binding and Single Session Support`_.
|
||||
For more info on this, read: `Prebinding and Single Session Support`_.
|
||||
|
||||
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
|
||||
|
@ -392,8 +392,8 @@ follow the instructions below to create this folder and fetch Converse's
|
|||
3rd-party dependencies.
|
||||
|
||||
|
||||
Install Node.js and development dependencies
|
||||
============================================
|
||||
Install the development and front-end dependencies
|
||||
==================================================
|
||||
|
||||
We use development tools (`Grunt <http://gruntjs.com>`_ and `Bower <http://bower.io>`_)
|
||||
which depend on Node.js and npm (the Node package manager).
|
||||
|
@ -406,36 +406,32 @@ directory:
|
|||
|
||||
::
|
||||
|
||||
npm install
|
||||
make dev
|
||||
|
||||
This will install all the development dependencies for Converse.js. If you are
|
||||
curious to know what these are, take a look at whats under the *devDependencies* key in
|
||||
`package.json <https://github.com/jcbrand/converse.js/blob/master/package.json>`.
|
||||
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.
|
||||
|
||||
Install 3rd party dependencies
|
||||
==============================
|
||||
The front-end dependencies are those javascript files on which
|
||||
Converse.js directly depends and which will therefore be loaded in the browser.
|
||||
|
||||
After running ``npm install``, you will now have Grunt and Bower installed.
|
||||
If you are curious to know what these different dependencies are:
|
||||
|
||||
We use Bower to manage Converse's front-end dependencies (e.g. Javascript that
|
||||
should get loaded in the browser).
|
||||
* Development dependencies:
|
||||
Take a look at whats under the *devDependencies* key in
|
||||
`package.json <https://github.com/jcbrand/converse.js/blob/master/package.json>`_.
|
||||
|
||||
To fetch these dependencies, run:
|
||||
* Front-end dependencies:
|
||||
See *dependencies* in
|
||||
`bower.json <https://github.com/jcbrand/converse.js/blob/master/bower.json>`_.
|
||||
|
||||
::
|
||||
|
||||
grunt fetch
|
||||
.. 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
|
||||
listed.
|
||||
|
||||
If you don't have grunt installed globally, you need to specify the relative
|
||||
path:
|
||||
|
||||
::
|
||||
|
||||
./node_modules/.bin/grunt fetch
|
||||
|
||||
This will call Bower in the background to fetch all the front-end
|
||||
dependencies (like backbone.js, strophe.js etc.) and then put them in the
|
||||
*components* folder.
|
||||
|
||||
With AMD and require.js (recommended)
|
||||
=====================================
|
||||
|
@ -578,7 +574,7 @@ To do this for ALL languages, run:
|
|||
|
||||
::
|
||||
|
||||
make merge
|
||||
make po
|
||||
|
||||
The resulting PO file is then what gets translated.
|
||||
|
||||
|
@ -805,6 +801,12 @@ Here are the different events that are emitted:
|
|||
|
||||
Triggered whenever the roster view (i.e. the rendered HTML) has changed.
|
||||
|
||||
* **onChatBoxClosed**
|
||||
|
||||
``converse.on('onChatBoxClosed', function (chatbox) { ... });``
|
||||
|
||||
Triggered when a chat box has been closed.
|
||||
|
||||
* **onChatBoxFocused**
|
||||
|
||||
``converse.on('onChatBoxFocused', function (chatbox) { ... });``
|
||||
|
@ -817,11 +819,11 @@ Here are the different events that are emitted:
|
|||
|
||||
Triggered when a chat box has been opened.
|
||||
|
||||
* **onChatBoxClosed**
|
||||
* **onChatBoxToggled**
|
||||
|
||||
``converse.on('onChatBoxClosed', function (chatbox) { ... });``
|
||||
``converse.on('onChatBoxToggled', function (chatbox) { ... });``
|
||||
|
||||
Triggered when a chat box has been closed.
|
||||
Triggered when a chat box has been minimized or maximized.
|
||||
|
||||
* **onStatusChanged**
|
||||
|
||||
|
|
|
@ -87,61 +87,60 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#development" id="id16">Development</a><ul>
|
||||
<li><a class="reference internal" href="#install-node-js-and-development-dependencies" id="id17">Install Node.js and development dependencies</a></li>
|
||||
<li><a class="reference internal" href="#install-3rd-party-dependencies" id="id18">Install 3rd party dependencies</a></li>
|
||||
<li><a class="reference internal" href="#with-amd-and-require-js-recommended" id="id19">With AMD and require.js (recommended)</a></li>
|
||||
<li><a class="reference internal" href="#without-amd-and-require-js" id="id20">Without AMD and require.js</a></li>
|
||||
<li><a class="reference internal" href="#before-submitting-a-pull-request" id="id21">Before submitting a pull request</a><ul>
|
||||
<li><a class="reference internal" href="#add-tests-for-your-bugfix-or-feature" id="id22">Add tests for your bugfix or feature</a></li>
|
||||
<li><a class="reference internal" href="#check-that-the-tests-pass" id="id23">Check that the tests pass</a></li>
|
||||
<li><a class="reference internal" href="#check-your-code-for-errors-or-bad-habits-by-running-jshint" id="id24">Check your code for errors or bad habits by running JSHint</a></li>
|
||||
<li><a class="reference internal" href="#install-the-development-and-front-end-dependencies" id="id17">Install the development and front-end dependencies</a></li>
|
||||
<li><a class="reference internal" href="#with-amd-and-require-js-recommended" id="id18">With AMD and require.js (recommended)</a></li>
|
||||
<li><a class="reference internal" href="#without-amd-and-require-js" id="id19">Without AMD and require.js</a></li>
|
||||
<li><a class="reference internal" href="#before-submitting-a-pull-request" id="id20">Before submitting a pull request</a><ul>
|
||||
<li><a class="reference internal" href="#add-tests-for-your-bugfix-or-feature" id="id21">Add tests for your bugfix or feature</a></li>
|
||||
<li><a class="reference internal" href="#check-that-the-tests-pass" id="id22">Check that the tests pass</a></li>
|
||||
<li><a class="reference internal" href="#check-your-code-for-errors-or-bad-habits-by-running-jshint" id="id23">Check your code for errors or bad habits by running JSHint</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#minification" id="id25">Minification</a><ul>
|
||||
<li><a class="reference internal" href="#minifying-javascript-and-css" id="id26">Minifying Javascript and CSS</a></li>
|
||||
<li><a class="reference internal" href="#minification" id="id24">Minification</a><ul>
|
||||
<li><a class="reference internal" href="#minifying-javascript-and-css" id="id25">Minifying Javascript and CSS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#translations" id="id27">Translations</a></li>
|
||||
<li><a class="reference internal" href="#translations" id="id26">Translations</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#troubleshooting" id="id28">Troubleshooting</a><ul>
|
||||
<li><a class="reference internal" href="#conflicts-with-other-javascript-libraries" id="id29">Conflicts with other Javascript libraries</a><ul>
|
||||
<li><a class="reference internal" href="#problem" id="id30">Problem:</a></li>
|
||||
<li><a class="reference internal" href="#solution" id="id31">Solution:</a></li>
|
||||
<li><a class="reference internal" href="#troubleshooting" id="id27">Troubleshooting</a><ul>
|
||||
<li><a class="reference internal" href="#conflicts-with-other-javascript-libraries" id="id28">Conflicts with other Javascript libraries</a><ul>
|
||||
<li><a class="reference internal" href="#problem" id="id29">Problem:</a></li>
|
||||
<li><a class="reference internal" href="#solution" id="id30">Solution:</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#events" id="id32">Events</a><ul>
|
||||
<li><a class="reference internal" href="#event-methods" id="id33">Event Methods</a></li>
|
||||
<li><a class="reference internal" href="#event-types" id="id34">Event Types</a></li>
|
||||
<li><a class="reference internal" href="#events" id="id31">Events</a><ul>
|
||||
<li><a class="reference internal" href="#event-methods" id="id32">Event Methods</a></li>
|
||||
<li><a class="reference internal" href="#event-types" id="id33">Event Types</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#configuration" id="id35">Configuration</a><ul>
|
||||
<li><a class="reference internal" href="#configuration-variables" id="id36">Configuration variables</a><ul>
|
||||
<li><a class="reference internal" href="#allow-contact-requests" id="id37">allow_contact_requests</a></li>
|
||||
<li><a class="reference internal" href="#allow-muc" id="id38">allow_muc</a></li>
|
||||
<li><a class="reference internal" href="#animate" id="id39">animate</a></li>
|
||||
<li><a class="reference internal" href="#auto-list-rooms" id="id40">auto_list_rooms</a></li>
|
||||
<li><a class="reference internal" href="#auto-reconnect" id="id41">auto_reconnect</a></li>
|
||||
<li><a class="reference internal" href="#auto-subscribe" id="id42">auto_subscribe</a></li>
|
||||
<li><a class="reference internal" href="#bosh-service-url" id="id43">bosh_service_url</a></li>
|
||||
<li><a class="reference internal" href="#cache-otr-key" id="id44">cache_otr_key</a></li>
|
||||
<li><a class="reference internal" href="#debug" id="id45">debug</a></li>
|
||||
<li><a class="reference internal" href="#expose-rid-and-sid" id="id46">expose_rid_and_sid</a></li>
|
||||
<li><a class="reference internal" href="#fullname" id="id47">fullname</a></li>
|
||||
<li><a class="reference internal" href="#hide-muc-server" id="id48">hide_muc_server</a></li>
|
||||
<li><a class="reference internal" href="#i18n" id="id49">i18n</a></li>
|
||||
<li><a class="reference internal" href="#prebind" id="id50">prebind</a></li>
|
||||
<li><a class="reference internal" href="#show-controlbox-by-default" id="id51">show_controlbox_by_default</a></li>
|
||||
<li><a class="reference internal" href="#show-call-button" id="id52">show_call_button</a></li>
|
||||
<li><a class="reference internal" href="#show-only-online-users" id="id53">show_only_online_users</a></li>
|
||||
<li><a class="reference internal" href="#use-otr-by-default" id="id54">use_otr_by_default</a></li>
|
||||
<li><a class="reference internal" href="#use-vcards" id="id55">use_vcards</a></li>
|
||||
<li><a class="reference internal" href="#xhr-custom-status" id="id56">xhr_custom_status</a></li>
|
||||
<li><a class="reference internal" href="#xhr-custom-status-url" id="id57">xhr_custom_status_url</a></li>
|
||||
<li><a class="reference internal" href="#xhr-user-search" id="id58">xhr_user_search</a></li>
|
||||
<li><a class="reference internal" href="#xhr-user-search-url" id="id59">xhr_user_search_url</a></li>
|
||||
<li><a class="reference internal" href="#configuration" id="id34">Configuration</a><ul>
|
||||
<li><a class="reference internal" href="#configuration-variables" id="id35">Configuration variables</a><ul>
|
||||
<li><a class="reference internal" href="#allow-contact-requests" id="id36">allow_contact_requests</a></li>
|
||||
<li><a class="reference internal" href="#allow-muc" id="id37">allow_muc</a></li>
|
||||
<li><a class="reference internal" href="#animate" id="id38">animate</a></li>
|
||||
<li><a class="reference internal" href="#auto-list-rooms" id="id39">auto_list_rooms</a></li>
|
||||
<li><a class="reference internal" href="#auto-reconnect" id="id40">auto_reconnect</a></li>
|
||||
<li><a class="reference internal" href="#auto-subscribe" id="id41">auto_subscribe</a></li>
|
||||
<li><a class="reference internal" href="#bosh-service-url" id="id42">bosh_service_url</a></li>
|
||||
<li><a class="reference internal" href="#cache-otr-key" id="id43">cache_otr_key</a></li>
|
||||
<li><a class="reference internal" href="#debug" id="id44">debug</a></li>
|
||||
<li><a class="reference internal" href="#expose-rid-and-sid" id="id45">expose_rid_and_sid</a></li>
|
||||
<li><a class="reference internal" href="#fullname" id="id46">fullname</a></li>
|
||||
<li><a class="reference internal" href="#hide-muc-server" id="id47">hide_muc_server</a></li>
|
||||
<li><a class="reference internal" href="#i18n" id="id48">i18n</a></li>
|
||||
<li><a class="reference internal" href="#prebind" id="id49">prebind</a></li>
|
||||
<li><a class="reference internal" href="#show-controlbox-by-default" id="id50">show_controlbox_by_default</a></li>
|
||||
<li><a class="reference internal" href="#show-call-button" id="id51">show_call_button</a></li>
|
||||
<li><a class="reference internal" href="#show-only-online-users" id="id52">show_only_online_users</a></li>
|
||||
<li><a class="reference internal" href="#use-otr-by-default" id="id53">use_otr_by_default</a></li>
|
||||
<li><a class="reference internal" href="#use-vcards" id="id54">use_vcards</a></li>
|
||||
<li><a class="reference internal" href="#xhr-custom-status" id="id55">xhr_custom_status</a></li>
|
||||
<li><a class="reference internal" href="#xhr-custom-status-url" id="id56">xhr_custom_status_url</a></li>
|
||||
<li><a class="reference internal" href="#xhr-user-search" id="id57">xhr_user_search</a></li>
|
||||
<li><a class="reference internal" href="#xhr-user-search-url" id="id58">xhr_user_search_url</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
@ -190,7 +189,7 @@ practical.</p>
|
|||
<p>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.</p>
|
||||
<p>For more info on this, read: <a href="#id60"><span class="problematic" id="id61">`Pre-binding and Single Session Support`_</span></a>.</p>
|
||||
<p>For more info on this, read: <a class="reference internal" href="#prebinding-and-single-session-support">Prebinding and Single Session Support</a>.</p>
|
||||
<p>You might also want to have more fine-grained control of what gets included in
|
||||
the minified Javascript file. Read <a class="reference internal" href="#configuration">Configuration</a> and <a class="reference internal" href="#minification">Minification</a> for more info on how to do
|
||||
that.</p>
|
||||
|
@ -447,38 +446,40 @@ communications privacy, then you’re much better off using native software.
|
|||
notice that there are references to a missing <em>components</em> folder. Please
|
||||
follow the instructions below to create this folder and fetch Converse’s
|
||||
3rd-party dependencies.</p>
|
||||
<div class="section" id="install-node-js-and-development-dependencies">
|
||||
<h2><a class="toc-backref" href="#id17">Install Node.js and development dependencies</a><a class="headerlink" href="#install-node-js-and-development-dependencies" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="install-the-development-and-front-end-dependencies">
|
||||
<h2><a class="toc-backref" href="#id17">Install the development and front-end dependencies</a><a class="headerlink" href="#install-the-development-and-front-end-dependencies" title="Permalink to this headline">¶</a></h2>
|
||||
<p>We use development tools (<a class="reference external" href="http://gruntjs.com">Grunt</a> and <a class="reference external" href="http://bower.io">Bower</a>)
|
||||
which depend on Node.js and npm (the Node package manager).</p>
|
||||
<p>If you don’t have Node.js installed, you can download and install the latest
|
||||
version <a class="reference external" href="https://nodejs.org/download">here</a>.</p>
|
||||
<p>Once you have Node.js installed, run the following command inside the Converse.js
|
||||
directory:</p>
|
||||
<div class="highlight-python"><pre>npm install</pre>
|
||||
<div class="highlight-python"><pre>make dev</pre>
|
||||
</div>
|
||||
<p>This will install all the development dependencies for Converse.js. If you are
|
||||
curious to know what these are, take a look at whats under the <em>devDependencies</em> key in
|
||||
<cite>package.json <https://github.com/jcbrand/converse.js/blob/master/package.json></cite>.</p>
|
||||
</div>
|
||||
<div class="section" id="install-3rd-party-dependencies">
|
||||
<h2><a class="toc-backref" href="#id18">Install 3rd party dependencies</a><a class="headerlink" href="#install-3rd-party-dependencies" title="Permalink to this headline">¶</a></h2>
|
||||
<p>After running <tt class="docutils literal"><span class="pre">npm</span> <span class="pre">install</span></tt>, you will now have Grunt and Bower installed.</p>
|
||||
<p>We use Bower to manage Converse’s front-end dependencies (e.g. Javascript that
|
||||
should get loaded in the browser).</p>
|
||||
<p>To fetch these dependencies, run:</p>
|
||||
<div class="highlight-python"><pre>grunt fetch</pre>
|
||||
</div>
|
||||
<p>If you don’t have grunt installed globally, you need to specify the relative
|
||||
path:</p>
|
||||
<div class="highlight-python"><pre>./node_modules/.bin/grunt fetch</pre>
|
||||
</div>
|
||||
<p>This will call Bower in the background to fetch all the front-end
|
||||
dependencies (like backbone.js, strophe.js etc.) and then put them in the
|
||||
<em>components</em> folder.</p>
|
||||
<p>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.</p>
|
||||
<p>The front-end dependencies are those javascript files on which
|
||||
Converse.js directly depends and which will therefore be loaded in the browser.</p>
|
||||
<p>If you are curious to know what these different dependencies are:</p>
|
||||
<ul>
|
||||
<li><dl class="first docutils">
|
||||
<dt>Development dependencies:</dt>
|
||||
<dd><p class="first last">Take a look at whats under the <em>devDependencies</em> key in
|
||||
<a class="reference external" href="https://github.com/jcbrand/converse.js/blob/master/package.json">package.json</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</li>
|
||||
<li><dl class="first docutils">
|
||||
<dt>Front-end dependencies:</dt>
|
||||
<dd><p class="first last">See <em>dependencies</em> in
|
||||
<a class="reference external" href="https://github.com/jcbrand/converse.js/blob/master/bower.json">bower.json</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="with-amd-and-require-js-recommended">
|
||||
<h2><a class="toc-backref" href="#id19">With AMD and require.js (recommended)</a><a class="headerlink" href="#with-amd-and-require-js-recommended" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><a class="toc-backref" href="#id18">With AMD and require.js (recommended)</a><a class="headerlink" href="#with-amd-and-require-js-recommended" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Converse.js uses <a class="reference external" href="http://requirejs.org">require.js</a> to asynchronously load dependencies.</p>
|
||||
<p>If you want to develop or customize converse.js, you’ll want to load the
|
||||
non-minified javascript files.</p>
|
||||
|
@ -491,7 +492,7 @@ attribute on the <em>script</em> tag), which will in turn cause converse.js to b
|
|||
parsed.</p>
|
||||
</div>
|
||||
<div class="section" id="without-amd-and-require-js">
|
||||
<h2><a class="toc-backref" href="#id20">Without AMD and require.js</a><a class="headerlink" href="#without-amd-and-require-js" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><a class="toc-backref" href="#id19">Without AMD and require.js</a><a class="headerlink" href="#without-amd-and-require-js" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Converse.js can also be used without require.js. If you for some reason prefer
|
||||
to use it this way, please refer to
|
||||
<a class="reference external" href="https://github.com/jcbrand/converse.js/blob/master/non_amd.html">non_amd.html</a>
|
||||
|
@ -499,9 +500,9 @@ for an example of how and in what order all the Javascript files that converse.j
|
|||
depends on need to be loaded.</p>
|
||||
</div>
|
||||
<div class="section" id="before-submitting-a-pull-request">
|
||||
<h2><a class="toc-backref" href="#id21">Before submitting a pull request</a><a class="headerlink" href="#before-submitting-a-pull-request" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><a class="toc-backref" href="#id20">Before submitting a pull request</a><a class="headerlink" href="#before-submitting-a-pull-request" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="add-tests-for-your-bugfix-or-feature">
|
||||
<h3><a class="toc-backref" href="#id22">Add tests for your bugfix or feature</a><a class="headerlink" href="#add-tests-for-your-bugfix-or-feature" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id21">Add tests for your bugfix or feature</a><a class="headerlink" href="#add-tests-for-your-bugfix-or-feature" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Add a test for any bug fixed or feature added. We use Jasmine
|
||||
for testing.</p>
|
||||
<p>Take a look at <tt class="docutils literal"><span class="pre">tests.html</span></tt> and <tt class="docutils literal"><span class="pre">spec/MainSpec.js</span></tt> to see how
|
||||
|
@ -510,7 +511,7 @@ the tests are implemented.</p>
|
|||
<a class="reference external" href="http://opkode.com/contact">contact me</a> and I’ll be happy to help.</p>
|
||||
</div>
|
||||
<div class="section" id="check-that-the-tests-pass">
|
||||
<h3><a class="toc-backref" href="#id23">Check that the tests pass</a><a class="headerlink" href="#check-that-the-tests-pass" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id22">Check that the tests pass</a><a class="headerlink" href="#check-that-the-tests-pass" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Check that the Jasmine tests complete sucessfully. Open
|
||||
<a class="reference external" href="https://github.com/jcbrand/converse.js/blob/master/tests.html">tests.html</a>
|
||||
in your browser, and the tests will run automatically.</p>
|
||||
|
@ -519,7 +520,7 @@ in your browser, and the tests will run automatically.</p>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="check-your-code-for-errors-or-bad-habits-by-running-jshint">
|
||||
<h3><a class="toc-backref" href="#id24">Check your code for errors or bad habits by running JSHint</a><a class="headerlink" href="#check-your-code-for-errors-or-bad-habits-by-running-jshint" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id23">Check your code for errors or bad habits by running JSHint</a><a class="headerlink" href="#check-your-code-for-errors-or-bad-habits-by-running-jshint" title="Permalink to this headline">¶</a></h3>
|
||||
<p><a class="reference external" href="http://jshint.com">JSHint</a> will do a static analysis of your code and hightlight potential errors
|
||||
and/or bad habits.</p>
|
||||
<div class="highlight-python"><pre>grunt jshint</pre>
|
||||
|
@ -530,9 +531,9 @@ and/or bad habits.</p>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="minification">
|
||||
<h2><a class="toc-backref" href="#id25">Minification</a><a class="headerlink" href="#minification" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><a class="toc-backref" href="#id24">Minification</a><a class="headerlink" href="#minification" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="minifying-javascript-and-css">
|
||||
<h3><a class="toc-backref" href="#id26">Minifying Javascript and CSS</a><a class="headerlink" href="#minifying-javascript-and-css" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id25">Minifying Javascript and CSS</a><a class="headerlink" href="#minifying-javascript-and-css" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Please make sure to read the section <a class="reference internal" href="#development">Development</a> and that you have installed
|
||||
all development dependencies (long story short, you can run <tt class="docutils literal"><span class="pre">npm</span> <span class="pre">install</span></tt>
|
||||
and then <tt class="docutils literal"><span class="pre">grunt</span> <span class="pre">fetch</span></tt>).</p>
|
||||
|
@ -549,7 +550,7 @@ using <a class="reference external" href="https://github.com/jrburke/almond">alm
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="translations">
|
||||
<h2><a class="toc-backref" href="#id27">Translations</a><a class="headerlink" href="#translations" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><a class="toc-backref" href="#id26">Translations</a><a class="headerlink" href="#translations" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="admonition note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p class="last">Translations take up a lot of space and will bloat your minified file.
|
||||
|
@ -575,7 +576,7 @@ function like so:</p>
|
|||
<div class="highlight-python"><pre>msgmerge ./locale/de/LC_MESSAGES/converse.po ./locale/converse.pot -U</pre>
|
||||
</div>
|
||||
<p>To do this for ALL languages, run:</p>
|
||||
<div class="highlight-python"><pre>make merge</pre>
|
||||
<div class="highlight-python"><pre>make po</pre>
|
||||
</div>
|
||||
<p>The resulting PO file is then what gets translated.</p>
|
||||
<p>If you’ve created a new PO file, please make sure to add the following
|
||||
|
@ -626,18 +627,18 @@ those hoops you had to jump through.</p>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="troubleshooting">
|
||||
<h1><a class="toc-backref" href="#id28">Troubleshooting</a><a class="headerlink" href="#troubleshooting" title="Permalink to this headline">¶</a></h1>
|
||||
<h1><a class="toc-backref" href="#id27">Troubleshooting</a><a class="headerlink" href="#troubleshooting" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="conflicts-with-other-javascript-libraries">
|
||||
<h2><a class="toc-backref" href="#id29">Conflicts with other Javascript libraries</a><a class="headerlink" href="#conflicts-with-other-javascript-libraries" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><a class="toc-backref" href="#id28">Conflicts with other Javascript libraries</a><a class="headerlink" href="#conflicts-with-other-javascript-libraries" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="problem">
|
||||
<h3><a class="toc-backref" href="#id30">Problem:</a><a class="headerlink" href="#problem" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id29">Problem:</a><a class="headerlink" href="#problem" title="Permalink to this headline">¶</a></h3>
|
||||
<p>You are using other Javascript libraries (like JQuery plugins), and
|
||||
get errors like these in your browser console:</p>
|
||||
<div class="highlight-python"><pre>Uncaught TypeError: Object [object Object] has no method 'xxx' from example.js</pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="solution">
|
||||
<h3><a class="toc-backref" href="#id31">Solution:</a><a class="headerlink" href="#solution" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id30">Solution:</a><a class="headerlink" href="#solution" title="Permalink to this headline">¶</a></h3>
|
||||
<p>First, find out which object is referred to by <tt class="docutils literal"><span class="pre">Object</span> <span class="pre">[object</span> <span class="pre">Object]</span></tt>.</p>
|
||||
<p>It will probably be the jQuery object <tt class="docutils literal"><span class="pre">$</span></tt> or perhaps the underscore.js object <tt class="docutils literal"><span class="pre">_</span></tt>.</p>
|
||||
<p>For the purpose of demonstration, I’m going to assume its <tt class="docutils literal"><span class="pre">$</span></tt>, but the same
|
||||
|
@ -679,11 +680,11 @@ jQuery plugins must load after jQuery).</p>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="events">
|
||||
<h1><a class="toc-backref" href="#id32">Events</a><a class="headerlink" href="#events" title="Permalink to this headline">¶</a></h1>
|
||||
<h1><a class="toc-backref" href="#id31">Events</a><a class="headerlink" href="#events" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Converse.js emits events to which you can subscribe from your own Javascript.</p>
|
||||
<p>Concerning events, the following methods are available:</p>
|
||||
<div class="section" id="event-methods">
|
||||
<h2><a class="toc-backref" href="#id33">Event Methods</a><a class="headerlink" href="#event-methods" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><a class="toc-backref" href="#id32">Event Methods</a><a class="headerlink" href="#event-methods" title="Permalink to this headline">¶</a></h2>
|
||||
<ul>
|
||||
<li><p class="first"><strong>on(eventName, callback)</strong>:</p>
|
||||
<blockquote>
|
||||
|
@ -727,7 +728,7 @@ exactly once.</p>
|
|||
</ul>
|
||||
</div>
|
||||
<div class="section" id="event-types">
|
||||
<h2><a class="toc-backref" href="#id34">Event Types</a><a class="headerlink" href="#event-types" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><a class="toc-backref" href="#id33">Event Types</a><a class="headerlink" href="#event-types" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Here are the different events that are emitted:</p>
|
||||
<ul>
|
||||
<li><p class="first"><strong>onInitialized</strong></p>
|
||||
|
@ -767,6 +768,12 @@ got all its ducks in a row.</p>
|
|||
<p>Triggered whenever the roster view (i.e. the rendered HTML) has changed.</p>
|
||||
</div></blockquote>
|
||||
</li>
|
||||
<li><p class="first"><strong>onChatBoxClosed</strong></p>
|
||||
<blockquote>
|
||||
<div><p><tt class="docutils literal"><span class="pre">converse.on('onChatBoxClosed',</span> <span class="pre">function</span> <span class="pre">(chatbox)</span> <span class="pre">{</span> <span class="pre">...</span> <span class="pre">});</span></tt></p>
|
||||
<p>Triggered when a chat box has been closed.</p>
|
||||
</div></blockquote>
|
||||
</li>
|
||||
<li><p class="first"><strong>onChatBoxFocused</strong></p>
|
||||
<blockquote>
|
||||
<div><p><tt class="docutils literal"><span class="pre">converse.on('onChatBoxFocused',</span> <span class="pre">function</span> <span class="pre">(chatbox)</span> <span class="pre">{</span> <span class="pre">...</span> <span class="pre">});</span></tt></p>
|
||||
|
@ -779,10 +786,10 @@ got all its ducks in a row.</p>
|
|||
<p>Triggered when a chat box has been opened.</p>
|
||||
</div></blockquote>
|
||||
</li>
|
||||
<li><p class="first"><strong>onChatBoxClosed</strong></p>
|
||||
<li><p class="first"><strong>onChatBoxToggled</strong></p>
|
||||
<blockquote>
|
||||
<div><p><tt class="docutils literal"><span class="pre">converse.on('onChatBoxClosed',</span> <span class="pre">function</span> <span class="pre">(chatbox)</span> <span class="pre">{</span> <span class="pre">...</span> <span class="pre">});</span></tt></p>
|
||||
<p>Triggered when a chat box has been closed.</p>
|
||||
<div><p><tt class="docutils literal"><span class="pre">converse.on('onChatBoxToggled',</span> <span class="pre">function</span> <span class="pre">(chatbox)</span> <span class="pre">{</span> <span class="pre">...</span> <span class="pre">});</span></tt></p>
|
||||
<p>Triggered when a chat box has been minimized or maximized.</p>
|
||||
</div></blockquote>
|
||||
</li>
|
||||
<li><p class="first"><strong>onStatusChanged</strong></p>
|
||||
|
@ -813,7 +820,7 @@ got all its ducks in a row.</p>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="configuration">
|
||||
<h1><a class="toc-backref" href="#id35">Configuration</a><a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h1>
|
||||
<h1><a class="toc-backref" href="#id34">Configuration</a><a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h1>
|
||||
<p>The included minified JS and CSS files can be used for demoing or testing, but
|
||||
you’ll want to configure <em>Converse.js</em> to suit your needs before you deploy it
|
||||
on your website.</p>
|
||||
|
@ -827,9 +834,9 @@ all the available configuration settings.</p>
|
|||
JS file so that it will include the new settings. Please refer to the
|
||||
<a class="reference internal" href="#minification">Minification</a> section for more info on how to do this.</p>
|
||||
<div class="section" id="configuration-variables">
|
||||
<h2><a class="toc-backref" href="#id36">Configuration variables</a><a class="headerlink" href="#configuration-variables" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><a class="toc-backref" href="#id35">Configuration variables</a><a class="headerlink" href="#configuration-variables" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="allow-contact-requests">
|
||||
<h3><a class="toc-backref" href="#id37">allow_contact_requests</a><a class="headerlink" href="#allow-contact-requests" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id36">allow_contact_requests</a><a class="headerlink" href="#allow-contact-requests" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Default = <tt class="docutils literal"><span class="pre">true</span></tt></p>
|
||||
<p>Allow users to add one another as contacts. If this is set to false, the
|
||||
<strong>Add a contact</strong> widget, <strong>Contact Requests</strong> and <strong>Pending Contacts</strong> roster
|
||||
|
@ -837,18 +844,18 @@ sections will all not appear. Additionally, all incoming contact requests will b
|
|||
ignored.</p>
|
||||
</div>
|
||||
<div class="section" id="allow-muc">
|
||||
<h3><a class="toc-backref" href="#id38">allow_muc</a><a class="headerlink" href="#allow-muc" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id37">allow_muc</a><a class="headerlink" href="#allow-muc" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Default = <tt class="docutils literal"><span class="pre">true</span></tt></p>
|
||||
<p>Allow multi-user chat (muc) in chatrooms. Setting this to <tt class="docutils literal"><span class="pre">false</span></tt> will remove
|
||||
the <tt class="docutils literal"><span class="pre">Chatrooms</span></tt> tab from the control box.</p>
|
||||
</div>
|
||||
<div class="section" id="animate">
|
||||
<h3><a class="toc-backref" href="#id39">animate</a><a class="headerlink" href="#animate" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id38">animate</a><a class="headerlink" href="#animate" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Default = <tt class="docutils literal"><span class="pre">true</span></tt></p>
|
||||
<p>Show animations, for example when opening and closing chat boxes.</p>
|
||||
</div>
|
||||
<div class="section" id="auto-list-rooms">
|
||||
<h3><a class="toc-backref" href="#id40">auto_list_rooms</a><a class="headerlink" href="#auto-list-rooms" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id39">auto_list_rooms</a><a class="headerlink" href="#auto-list-rooms" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
|
||||
<p>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.</p>
|
||||
|
@ -858,24 +865,24 @@ features, number of occupants etc.), so on servers with many rooms this
|
|||
option will create lots of extra connection traffic.</p>
|
||||
</div>
|
||||
<div class="section" id="auto-reconnect">
|
||||
<h3><a class="toc-backref" href="#id41">auto_reconnect</a><a class="headerlink" href="#auto-reconnect" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id40">auto_reconnect</a><a class="headerlink" href="#auto-reconnect" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Default = <tt class="docutils literal"><span class="pre">true</span></tt></p>
|
||||
<p>Automatically reconnect to the XMPP server if the connection drops
|
||||
unexpectedly.</p>
|
||||
</div>
|
||||
<div class="section" id="auto-subscribe">
|
||||
<h3><a class="toc-backref" href="#id42">auto_subscribe</a><a class="headerlink" href="#auto-subscribe" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id41">auto_subscribe</a><a class="headerlink" href="#auto-subscribe" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
|
||||
<p>If true, the user will automatically subscribe back to any contact requests.</p>
|
||||
</div>
|
||||
<div class="section" id="bosh-service-url">
|
||||
<h3><a class="toc-backref" href="#id43">bosh_service_url</a><a class="headerlink" href="#bosh-service-url" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id42">bosh_service_url</a><a class="headerlink" href="#bosh-service-url" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Connections to an XMPP server depend on a BOSH connection manager which acts as
|
||||
a middle man between HTTP and XMPP.</p>
|
||||
<p>See <a class="reference external" href="http://metajack.im/2008/09/08/which-bosh-server-do-you-need">here</a> for more information.</p>
|
||||
</div>
|
||||
<div class="section" id="cache-otr-key">
|
||||
<h3><a class="toc-backref" href="#id44">cache_otr_key</a><a class="headerlink" href="#cache-otr-key" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id43">cache_otr_key</a><a class="headerlink" href="#cache-otr-key" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
|
||||
<p>Let the <a class="reference external" href="https://otr.cypherpunks.ca">OTR (Off-the-record encryption)</a> private
|
||||
key be cached in your browser’s session storage.</p>
|
||||
|
@ -894,12 +901,12 @@ current session. Previous sessions however cannot be decrypted.</p>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="debug">
|
||||
<h3><a class="toc-backref" href="#id45">debug</a><a class="headerlink" href="#debug" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id44">debug</a><a class="headerlink" href="#debug" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
|
||||
<p>If set to true, debugging output will be logged to the browser console.</p>
|
||||
</div>
|
||||
<div class="section" id="expose-rid-and-sid">
|
||||
<h3><a class="toc-backref" href="#id46">expose_rid_and_sid</a><a class="headerlink" href="#expose-rid-and-sid" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id45">expose_rid_and_sid</a><a class="headerlink" href="#expose-rid-and-sid" title="Permalink to this headline">¶</a></h3>
|
||||
<p>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
|
||||
these values.</p>
|
||||
|
@ -907,24 +914,24 @@ these values.</p>
|
|||
and inject fake chat messages.</p>
|
||||
</div>
|
||||
<div class="section" id="fullname">
|
||||
<h3><a class="toc-backref" href="#id47">fullname</a><a class="headerlink" href="#fullname" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id46">fullname</a><a class="headerlink" href="#fullname" title="Permalink to this headline">¶</a></h3>
|
||||
<p>If you are using prebinding, can specify the fullname of the currently
|
||||
logged in user, otherwise the user’s vCard will be fetched.</p>
|
||||
</div>
|
||||
<div class="section" id="hide-muc-server">
|
||||
<h3><a class="toc-backref" href="#id48">hide_muc_server</a><a class="headerlink" href="#hide-muc-server" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id47">hide_muc_server</a><a class="headerlink" href="#hide-muc-server" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
|
||||
<p>Hide the <tt class="docutils literal"><span class="pre">server</span></tt> input field of the form inside the <tt class="docutils literal"><span class="pre">Room</span></tt> panel of the
|
||||
controlbox. Useful if you want to restrict users to a specific XMPP server of
|
||||
your choosing.</p>
|
||||
</div>
|
||||
<div class="section" id="i18n">
|
||||
<h3><a class="toc-backref" href="#id49">i18n</a><a class="headerlink" href="#i18n" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id48">i18n</a><a class="headerlink" href="#i18n" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Specify the locale/language. The language must be in the <tt class="docutils literal"><span class="pre">locales</span></tt> object. Refer to
|
||||
<tt class="docutils literal"><span class="pre">./locale/locales.js</span></tt> to see which locales are supported.</p>
|
||||
</div>
|
||||
<div class="section" id="prebind">
|
||||
<h3><a class="toc-backref" href="#id50">prebind</a><a class="headerlink" href="#prebind" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id49">prebind</a><a class="headerlink" href="#prebind" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
|
||||
<p>Use this option when you want to attach to an existing XMPP connection that was
|
||||
already authenticated (usually on the backend before page load).</p>
|
||||
|
@ -937,7 +944,7 @@ values as <tt class="docutils literal"><span class="pre">jid</span></tt>, <tt cl
|
|||
<p>Additionally, you have to specify <tt class="docutils literal"><span class="pre">bosh_service_url</span></tt>.</p>
|
||||
</div>
|
||||
<div class="section" id="show-controlbox-by-default">
|
||||
<h3><a class="toc-backref" href="#id51">show_controlbox_by_default</a><a class="headerlink" href="#show-controlbox-by-default" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id50">show_controlbox_by_default</a><a class="headerlink" href="#show-controlbox-by-default" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
|
||||
<p>The “controlbox” refers to the special chatbox containing your contacts roster,
|
||||
status widget, chatrooms and other controls.</p>
|
||||
|
@ -947,7 +954,7 @@ the page with class <em>toggle-online-users</em>.</p>
|
|||
page load.</p>
|
||||
</div>
|
||||
<div class="section" id="show-call-button">
|
||||
<h3><a class="toc-backref" href="#id52">show_call_button</a><a class="headerlink" href="#show-call-button" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id51">show_call_button</a><a class="headerlink" href="#show-call-button" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
|
||||
<p>Enable to display a call button on the chatbox toolbar.</p>
|
||||
<p>When the call button is pressed, it will emit an event that can be used by a third-party library to initiate a call.</p>
|
||||
|
@ -961,26 +968,26 @@ page load.</p>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="show-only-online-users">
|
||||
<h3><a class="toc-backref" href="#id53">show_only_online_users</a><a class="headerlink" href="#show-only-online-users" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id52">show_only_online_users</a><a class="headerlink" href="#show-only-online-users" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
|
||||
<p>If set to <tt class="docutils literal"><span class="pre">true</span></tt>, only online users will be shown in the contacts roster.
|
||||
Users with any other status (e.g. away, busy etc.) will not be shown.</p>
|
||||
</div>
|
||||
<div class="section" id="use-otr-by-default">
|
||||
<h3><a class="toc-backref" href="#id54">use_otr_by_default</a><a class="headerlink" href="#use-otr-by-default" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id53">use_otr_by_default</a><a class="headerlink" href="#use-otr-by-default" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
|
||||
<p>If set to <tt class="docutils literal"><span class="pre">true</span></tt>, Converse.js will automatically try to initiate an OTR (off-the-record)
|
||||
encrypted chat session every time you open a chat box.</p>
|
||||
</div>
|
||||
<div class="section" id="use-vcards">
|
||||
<h3><a class="toc-backref" href="#id55">use_vcards</a><a class="headerlink" href="#use-vcards" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id54">use_vcards</a><a class="headerlink" href="#use-vcards" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Default = <tt class="docutils literal"><span class="pre">true</span></tt></p>
|
||||
<p>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.</p>
|
||||
</div>
|
||||
<div class="section" id="xhr-custom-status">
|
||||
<h3><a class="toc-backref" href="#id56">xhr_custom_status</a><a class="headerlink" href="#xhr-custom-status" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id55">xhr_custom_status</a><a class="headerlink" href="#xhr-custom-status" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
|
||||
<div class="admonition note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
|
@ -990,7 +997,7 @@ avatar image.</p>
|
|||
remote server.</p>
|
||||
</div>
|
||||
<div class="section" id="xhr-custom-status-url">
|
||||
<h3><a class="toc-backref" href="#id57">xhr_custom_status_url</a><a class="headerlink" href="#xhr-custom-status-url" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id56">xhr_custom_status_url</a><a class="headerlink" href="#xhr-custom-status-url" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="admonition note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p class="last">XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).</p>
|
||||
|
@ -1002,7 +1009,7 @@ message will be made.</p>
|
|||
<p>The message itself is sent in the request under the key <tt class="docutils literal"><span class="pre">msg</span></tt>.</p>
|
||||
</div>
|
||||
<div class="section" id="xhr-user-search">
|
||||
<h3><a class="toc-backref" href="#id58">xhr_user_search</a><a class="headerlink" href="#xhr-user-search" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id57">xhr_user_search</a><a class="headerlink" href="#xhr-user-search" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
|
||||
<div class="admonition note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
|
@ -1019,7 +1026,7 @@ message will be made.</p>
|
|||
corresponds to a matched user and needs the keys <tt class="docutils literal"><span class="pre">id</span></tt> and <tt class="docutils literal"><span class="pre">fullname</span></tt>.</p>
|
||||
</div>
|
||||
<div class="section" id="xhr-user-search-url">
|
||||
<h3><a class="toc-backref" href="#id59">xhr_user_search_url</a><a class="headerlink" href="#xhr-user-search-url" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><a class="toc-backref" href="#id58">xhr_user_search_url</a><a class="headerlink" href="#xhr-user-search-url" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="admonition note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p class="last">XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).</p>
|
||||
|
|
File diff suppressed because one or more lines are too long
|
@ -70,7 +70,7 @@ You'll most likely want to implement some kind of single-signon solution for
|
|||
your website, where users authenticate once in your website and then stay
|
||||
logged into their XMPP session upon page reload.
|
||||
|
||||
For more info on this, read: `Pre-binding and Single Session Support`_.
|
||||
For more info on this, read: `Prebinding and Single Session Support`_.
|
||||
|
||||
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
|
||||
|
@ -392,8 +392,8 @@ follow the instructions below to create this folder and fetch Converse's
|
|||
3rd-party dependencies.
|
||||
|
||||
|
||||
Install Node.js and development dependencies
|
||||
============================================
|
||||
Install the development and front-end dependencies
|
||||
==================================================
|
||||
|
||||
We use development tools (`Grunt <http://gruntjs.com>`_ and `Bower <http://bower.io>`_)
|
||||
which depend on Node.js and npm (the Node package manager).
|
||||
|
@ -406,36 +406,32 @@ directory:
|
|||
|
||||
::
|
||||
|
||||
npm install
|
||||
make dev
|
||||
|
||||
This will install all the development dependencies for Converse.js. If you are
|
||||
curious to know what these are, take a look at whats under the *devDependencies* key in
|
||||
`package.json <https://github.com/jcbrand/converse.js/blob/master/package.json>`.
|
||||
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.
|
||||
|
||||
Install 3rd party dependencies
|
||||
==============================
|
||||
The front-end dependencies are those javascript files on which
|
||||
Converse.js directly depends and which will therefore be loaded in the browser.
|
||||
|
||||
After running ``npm install``, you will now have Grunt and Bower installed.
|
||||
If you are curious to know what these different dependencies are:
|
||||
|
||||
We use Bower to manage Converse's front-end dependencies (e.g. Javascript that
|
||||
should get loaded in the browser).
|
||||
* Development dependencies:
|
||||
Take a look at whats under the *devDependencies* key in
|
||||
`package.json <https://github.com/jcbrand/converse.js/blob/master/package.json>`_.
|
||||
|
||||
To fetch these dependencies, run:
|
||||
* Front-end dependencies:
|
||||
See *dependencies* in
|
||||
`bower.json <https://github.com/jcbrand/converse.js/blob/master/bower.json>`_.
|
||||
|
||||
::
|
||||
|
||||
grunt fetch
|
||||
.. 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
|
||||
listed.
|
||||
|
||||
If you don't have grunt installed globally, you need to specify the relative
|
||||
path:
|
||||
|
||||
::
|
||||
|
||||
./node_modules/.bin/grunt fetch
|
||||
|
||||
This will call Bower in the background to fetch all the front-end
|
||||
dependencies (like backbone.js, strophe.js etc.) and then put them in the
|
||||
*components* folder.
|
||||
|
||||
With AMD and require.js (recommended)
|
||||
=====================================
|
||||
|
@ -578,7 +574,7 @@ To do this for ALL languages, run:
|
|||
|
||||
::
|
||||
|
||||
make merge
|
||||
make po
|
||||
|
||||
The resulting PO file is then what gets translated.
|
||||
|
||||
|
|
Loading…
Reference in New Issue
Block a user