Chapril/xmpp.chapril.org-conversejs
Chapril/xmpp.chapril.org-conversejs
24
0
Fork 0
Code Issues Pull Requests Projects Releases Activity

RestructuredText markup error fixed. updates #187

Browse Source
This commit is contained in:
JC Brand 2014-09-22 15:07:50 +02:00
parent 82617918b1
commit 6b4b94d45f
5 changed files with 39 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/doctrees/index.doctree
View File

Binary file not shown.

25
docs/html/_sources/index.txt
View File

@ -383,7 +383,7 @@ notice that there are references to a missing *components* folder. Please
follow the instructions below to create this folder and fetch Converse's follow the instructions below to create this folder and fetch Converse's
3rd-party dependencies. 3rd-party dependencies.
.. Note: .. note::
Users have reported that converse.js cannot be built on Windows. Patches to Users have reported that converse.js cannot be built on Windows. Patches to
fix this are welcome. fix this are welcome.
@ -429,7 +429,7 @@ If you are curious to know what the different dependencies are:
See *dependencies* in See *dependencies* in
`bower.json <https://github.com/jcbrand/converse.js/blob/master/bower.json>`_. `bower.json <https://github.com/jcbrand/converse.js/blob/master/bower.json>`_.
.. Note: .. note::
After running ```make dev```, you should now have a new directory *components*, After running ```make dev```, you should now have a new directory *components*,
which contains all the front-end dependencies of Converse.js. which contains all the front-end dependencies of Converse.js.
If this directory does NOT exist, something must have gone wrong. If this directory does NOT exist, something must have gone wrong.
@ -541,7 +541,7 @@ CSS is minified via `cssmin <https://github.com/gruntjs/grunt-contrib-cssmin>`_.
Translations Translations
============ ============
.. Note :: .. note::
Translations take up a lot of space and will bloat your minified file. 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 At the time of writing, all the translations add about 50KB of extra data to
the minified javascript file. Therefore, make sure to only the minified javascript file. Therefore, make sure to only
@ -634,7 +634,7 @@ create or update the file ./locale/LC_MESSAGES/de.js with the following code:
making sure to also paste the JSON data as value to the "locale_data" key. making sure to also paste the JSON data as value to the "locale_data" key.
.. Note :: .. note::
If you are adding translations for a new language that is not already supported, If you are adding translations for a new language that is not already supported,
you'll have to add the language path in main.js and make one more edit in ./locale/locales.js you'll have to add the language path in main.js and make one more edit in ./locale/locales.js
to make sure the language is loaded by require.js. to make sure the language is loaded by require.js.
@ -812,7 +812,7 @@ Here are the different events that are emitted:
Developer API Developer API
============= =============
.. Note :: See also the `Event API Methods`_, not listed here. .. note:: see also the `event api methods`_, not listed here.
initialize initialize
========== ==========
@ -1009,8 +1009,7 @@ 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``. This setting can only be used together with ``allow_otr = true``.
.. note::
.. Note ::
A browser window's session storage is accessible by all javascript that 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 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 the same server (or somehow injected via an attacker), then they will be able
@ -1152,7 +1151,7 @@ Default: ``false``
If set to ``true``, converse.js will show any roster groups you might have If set to ``true``, converse.js will show any roster groups you might have
configured. configured.
.. Note :: .. note::
It's currently not possible to use converse.js to assign contacts to groups. 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 Converse.js can only show users and groups that were previously configured
elsewhere. elsewhere.
@ -1198,7 +1197,7 @@ it's closed, the data is cleared.
Data in localStorage on the other hand is kept indefinitely. Data in localStorage on the other hand is kept indefinitely.
.. Note :: .. note::
Since version 0.8.0, the use of local storage is not recommended. The 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 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 the browser storage. If you use local storage, these values are stored for
@ -1262,7 +1261,7 @@ xhr_custom_status
Default: ``false`` Default: ``false``
.. Note :: .. note::
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML). 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 This option will let converse.js make an AJAX POST with your changed custom chat status to a
@ -1271,7 +1270,7 @@ remote server.
xhr_custom_status_url xhr_custom_status_url
--------------------- ---------------------
.. Note :: .. note::
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML). XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
Default: Empty string Default: Empty string
@ -1288,7 +1287,7 @@ xhr_user_search
Default: ``false`` Default: ``false``
.. Note :: .. note::
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML). XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
There are two ways to add users. There are two ways to add users.
@ -1306,7 +1305,7 @@ corresponds to a matched user and needs the keys ``id`` and ``fullname``.
xhr_user_search_url xhr_user_search_url
------------------- -------------------
.. Note :: .. note::
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML). XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
Default: Empty string Default: Empty string

15
docs/html/index.html
View File

@ -494,6 +494,11 @@ make a custom build which includes only those languages that you need.</p>
notice that there are references to a missing <em>components</em> folder. Please notice that there are references to a missing <em>components</em> folder. Please
follow the instructions below to create this folder and fetch Converse&#8217;s follow the instructions below to create this folder and fetch Converse&#8217;s
3rd-party dependencies.</p> 3rd-party dependencies.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Users have reported that converse.js cannot be built on Windows. Patches to
fix this are welcome.</p>
</div>
<div class="section" id="install-the-development-and-front-end-dependencies"> <div class="section" id="install-the-development-and-front-end-dependencies">
<h2><a class="toc-backref" href="#id23">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> <h2><a class="toc-backref" href="#id23">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>) <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>)
@ -532,6 +537,14 @@ Converse.js directly depends and which will be loaded in the browser.</p>
</dl> </dl>
</li> </li>
</ul> </ul>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">After running <tt class="docutils literal"><span class="pre">`make</span> <span class="pre">dev`</span></tt>, you should now have a new directory <em>components</em>,
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 <tt class="docutils literal"><span class="pre">`make</span> <span class="pre">dev`</span></tt> to see if there are any errors
listed. For support, you can write to the mailing list: <a class="reference external" href="mailto:conversejs&#37;&#52;&#48;librelist&#46;com">conversejs<span>&#64;</span>librelist<span>&#46;</span>com</a></p>
</div>
</div> </div>
<div class="section" id="with-amd-and-require-js-recommended"> <div class="section" id="with-amd-and-require-js-recommended">
<h2><a class="toc-backref" href="#id24">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="#id24">With AMD and require.js (recommended)</a><a class="headerlink" href="#with-amd-and-require-js-recommended" title="Permalink to this headline"></a></h2>
@ -892,7 +905,7 @@ exactly once.</p>
<h1><a class="toc-backref" href="#id40">Developer API</a><a class="headerlink" href="#developer-api" title="Permalink to this headline"></a></h1> <h1><a class="toc-backref" href="#id40">Developer API</a><a class="headerlink" href="#developer-api" title="Permalink to this headline"></a></h1>
<div class="admonition note"> <div class="admonition note">
<p class="first admonition-title">Note</p> <p class="first admonition-title">Note</p>
<p class="last">See also the <a class="reference internal" href="#event-api-methods">Event API Methods</a>, not listed here.</p> <p class="last">see also the <a class="reference internal" href="#event-api-methods">event api methods</a>, not listed here.</p>
</div> </div>
<div class="section" id="initialize"> <div class="section" id="initialize">
<h2><a class="toc-backref" href="#id41">initialize</a><a class="headerlink" href="#initialize" title="Permalink to this headline"></a></h2> <h2><a class="toc-backref" href="#id41">initialize</a><a class="headerlink" href="#initialize" title="Permalink to this headline"></a></h2>

2
docs/html/searchindex.js
View File

File diff suppressed because one or more lines are too long

25
docs/source/index.rst
View File

@ -383,7 +383,7 @@ notice that there are references to a missing *components* folder. Please
follow the instructions below to create this folder and fetch Converse's follow the instructions below to create this folder and fetch Converse's
3rd-party dependencies. 3rd-party dependencies.
.. Note: .. note::
Users have reported that converse.js cannot be built on Windows. Patches to Users have reported that converse.js cannot be built on Windows. Patches to
fix this are welcome. fix this are welcome.
@ -429,7 +429,7 @@ If you are curious to know what the different dependencies are:
See *dependencies* in See *dependencies* in
`bower.json <https://github.com/jcbrand/converse.js/blob/master/bower.json>`_. `bower.json <https://github.com/jcbrand/converse.js/blob/master/bower.json>`_.
.. Note: .. note::
After running ```make dev```, you should now have a new directory *components*, After running ```make dev```, you should now have a new directory *components*,
which contains all the front-end dependencies of Converse.js. which contains all the front-end dependencies of Converse.js.
If this directory does NOT exist, something must have gone wrong. If this directory does NOT exist, something must have gone wrong.
@ -541,7 +541,7 @@ CSS is minified via `cssmin <https://github.com/gruntjs/grunt-contrib-cssmin>`_.
Translations Translations
============ ============
.. Note :: .. note::
Translations take up a lot of space and will bloat your minified file. 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 At the time of writing, all the translations add about 50KB of extra data to
the minified javascript file. Therefore, make sure to only the minified javascript file. Therefore, make sure to only
@ -634,7 +634,7 @@ create or update the file ./locale/LC_MESSAGES/de.js with the following code:
making sure to also paste the JSON data as value to the "locale_data" key. making sure to also paste the JSON data as value to the "locale_data" key.
.. Note :: .. note::
If you are adding translations for a new language that is not already supported, If you are adding translations for a new language that is not already supported,
you'll have to add the language path in main.js and make one more edit in ./locale/locales.js you'll have to add the language path in main.js and make one more edit in ./locale/locales.js
to make sure the language is loaded by require.js. to make sure the language is loaded by require.js.
@ -812,7 +812,7 @@ Here are the different events that are emitted:
Developer API Developer API
============= =============
.. Note :: See also the `Event API Methods`_, not listed here. .. note:: see also the `event api methods`_, not listed here.
initialize initialize
========== ==========
@ -1009,8 +1009,7 @@ 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``. This setting can only be used together with ``allow_otr = true``.
.. note::
.. Note ::
A browser window's session storage is accessible by all javascript that 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 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 the same server (or somehow injected via an attacker), then they will be able
@ -1152,7 +1151,7 @@ Default: ``false``
If set to ``true``, converse.js will show any roster groups you might have If set to ``true``, converse.js will show any roster groups you might have
configured. configured.
.. Note :: .. note::
It's currently not possible to use converse.js to assign contacts to groups. 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 Converse.js can only show users and groups that were previously configured
elsewhere. elsewhere.
@ -1198,7 +1197,7 @@ it's closed, the data is cleared.
Data in localStorage on the other hand is kept indefinitely. Data in localStorage on the other hand is kept indefinitely.
.. Note :: .. note::
Since version 0.8.0, the use of local storage is not recommended. The 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 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 the browser storage. If you use local storage, these values are stored for
@ -1262,7 +1261,7 @@ xhr_custom_status
Default: ``false`` Default: ``false``
.. Note :: .. note::
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML). 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 This option will let converse.js make an AJAX POST with your changed custom chat status to a
@ -1271,7 +1270,7 @@ remote server.
xhr_custom_status_url xhr_custom_status_url
--------------------- ---------------------
.. Note :: .. note::
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML). XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
Default: Empty string Default: Empty string
@ -1288,7 +1287,7 @@ xhr_user_search
Default: ``false`` Default: ``false``
.. Note :: .. note::
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML). XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
There are two ways to add users. There are two ways to add users.
@ -1306,7 +1305,7 @@ corresponds to a matched user and needs the keys ``id`` and ``fullname``.
xhr_user_search_url xhr_user_search_url
------------------- -------------------
.. Note :: .. note::
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML). XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
Default: Empty string Default: Empty string