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

Update view_mode documentation

Browse Source 
Put the historical background info into a ``note`` and add short
explanations of the 4 different view modes
This commit is contained in:
JC Brand 2018-12-03 13:08:55 +01:00
parent 5e217aae9b
commit 9a551b3e89
1 changed files with 38 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/source/configuration.rst
View File

@ -726,7 +726,7 @@ If set to ``true``, then don't show offline users.
hide_open_bookmarks
-------------------
* Default: ``false`` (``true`` when the ``view_mode`` is set to ``fullscreen``).
* Default: ``false`` (``true`` when the :ref:`view_mode` is set to ``fullscreen``).
This setting applies to the ``converse-bookmarks`` plugin and specfically the
list of bookmarks shown in the ``Rooms`` tab of the control box.
@ -1512,6 +1512,13 @@ view_mode
The ``view_mode`` setting configures Converse's mode and resulting behavior.
* ``overlayed`` is the original mode, in which the chats appeared as small boxes overlaying a webpage which can contain arbitrary content.
* ``fullscreen`` is for a fullpage and single-page app.
* ``embedded`` is used to embed a single chat into a DOM element in the page. The DOM element must have the id ``#conversejs``.
* ``mobile`` is for smaller viewports. Converse is responsive, and the other views will also resize to fit a smaller viewport, but certain behavioural changes won't be made. For example, when using ``overlayed`` in a mobile view, Converse won't know which chat is currently visible and therefore won't be able to properly show notifications for chats that are obscured.
.. note::
Before the introduction of this setting (in version 3.3.0), there were there
different builds, each for the different modes.
@ -1547,8 +1554,8 @@ the appropriate ``view_mode`` value.
Since verseion 4.0.0, there is now also only one CSS file to be used for all
the different view modes, ``converse.css``.
The ``converse-muc-embedded.js`` build is still kept, because it's smaller than
``converse.js`` due to unused code being removed. It doesn't however contain
The ``converse-muc-embedded.js`` build can still be built, because it's smaller
than ``converse.js`` due to unused code being removed. It doesn't however contain
any new code, so the full ``converse.js`` build could be used instead, as long
as ``view_mode`` is set to ``embedded``.