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

Update docs.

Browse Source 
- Mention CSS file needed for embedded case.
- Update some outdated text
This commit is contained in:
JC Brand 2018-03-15 20:22:32 +00:00
parent 8ca9da2ec6
commit ae3942bc75
1 changed files with 28 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/source/configuration.rst
View File

@ -379,22 +379,30 @@ plugins from registering themselves under those names.
The core, and by default whitelisted, plugins are:: The core, and by default whitelisted, plugins are::
converse-bookmarks converse-bookmarks
converse-chatboxes
converse-chatview converse-chatview
converse-controlbox converse-controlbox
converse-core converse-core
converse-disco
converse-dragresize converse-dragresize
converse-fullscreen
converse-headline converse-headline
converse-mam converse-mam
converse-minimize converse-minimize
converse-muc converse-muc
converse-muc-embedded
converse-notification converse-notification
converse-otr converse-otr
converse-ping converse-ping
converse-profile
converse-register converse-register
converse-roomslist
converse-rosterview converse-rosterview
converse-vcard converse-singleton
converse-spoilers
converse-vcard'
An example from `the embedded room demo <https://conversejs.org/demo/embedded.html>`_ Example:
.. code-block:: javascript .. code-block:: javascript
@ -402,17 +410,13 @@ An example from `the embedded room demo <https://conversejs.org/demo/embedded.ht
converse.initialize({ converse.initialize({
// other settings removed for brevity // other settings removed for brevity
blacklisted_plugins: [ blacklisted_plugins: [
'converse-controlbox',
'converse-dragresize', 'converse-dragresize',
'converse-minimize', 'converse-minimize'
'converse-vcard'
], ],
}); });
}); });
.. _`bosh-service-url`: .. _`bosh-service-url`:
bosh_service_url bosh_service_url
@ -1466,9 +1470,10 @@ when switching view modes.
JavaScript builds, you'll still need to use different CSS files depending JavaScript builds, you'll still need to use different CSS files depending
on the view mode. on the view mode.
* For ``overlayed`` this is ``./css/converse.css`` * For ``embedded`` you need to use ``./css/converse-muc-embedded.css``
* For ``fullscreen`` you need ``./css/inverse.css`` * For ``fullscreen`` you need ``./css/inverse.css``
* For ``mobile`` you need to use both ``./css/converse.css`` and ``./css/mobile.css`` * For ``mobile`` you need to use both ``./css/converse.css`` and ``./css/mobile.css``
* For ``overlayed`` this is ``./css/converse.css``
Hopefully in a future release the CSS files will be combined and you'll Hopefully in a future release the CSS files will be combined and you'll
only need ``converse.css`` only need ``converse.css``
@ -1495,33 +1500,42 @@ By default all the core plugins are already whitelisted.
These are:: These are::
converse-bookmarks converse-bookmarks
converse-chatboxes
converse-chatview converse-chatview
converse-controlbox converse-controlbox
converse-core converse-core
converse-disco
converse-dragresize converse-dragresize
converse-fullscreen
converse-headline converse-headline
converse-mam converse-mam
converse-minimize converse-minimize
converse-muc converse-muc
converse-muc-embedded
converse-notification converse-notification
converse-otr converse-otr
converse-ping converse-ping
converse-profile
converse-register converse-register
converse-roomslist
converse-rosterview converse-rosterview
converse-vcard converse-singleton
converse-spoilers
converse-vcard'
.. note::
If you are using a custom build which excludes some core plugins, then you If you are using a custom build which excludes some core plugins, then you
should blacklist them so that malicious scripts can't register their own should blacklist them so that malicious scripts can't register their own
plugins under those names. See `blacklisted_plugins`_ for more info. plugins under those names. See `blacklisted_plugins`_ for more info.
An example from `the embedded room demo <https://conversejs.org/demo/embedded.html>`_ Example:
.. code-block:: javascript .. code-block:: javascript
require(['converse-core', 'converse-muc-embedded'], function (converse) { require(['converse-core', 'converse-muc-embedded'], function (converse) {
converse.initialize({ converse.initialize({
// other settings removed for brevity // other settings removed for brevity
whitelisted_plugins: ['converse-muc-embedded'] whitelisted_plugins: ['myplugin']
}); });
}); });