Skip to content

Commit

Permalink
Added overlay/sideframe notes and made minor corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
evildmp committed Nov 16, 2015
1 parent 8d833fa commit 0c8b349
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 10 deletions.
7 changes: 7 additions & 0 deletions docs/how_to/toolbar.rst
Expand Up @@ -9,6 +9,13 @@ mode into your application, and provide your users with a streamlined editing ex

For the toolbar API reference, please refer to :ref:`toolbar-api-reference`.

.. important:: **Overlay** and **sideframe**

Then django CMS *sideframe* has been replaced with an *overlay* mechanism. The API still refers
to the ``sideframe``, because it is invoked in the same way, and what has changed is merely the
behaviour in the user's browser.

In other words, *sideframe* and the *overlay* refer to different versions of the same thing.

***********
Registering
Expand Down
16 changes: 12 additions & 4 deletions docs/reference/api_references.rst
Expand Up @@ -418,6 +418,14 @@ cms.toolbar.toolbar
cms.toolbar.items
=================

.. important:: **Overlay** and **sideframe**

Then django CMS *sideframe* has been replaced with an *overlay* mechanism. The API still refers
to the ``sideframe``, because it is invoked in the same way, and what has changed is merely the
behaviour in the user's browser.

In other words, *sideframe* and the *overlay* refer to different versions of the same thing.

.. module:: cms.toolbar.items


Expand Down Expand Up @@ -489,16 +497,16 @@ cms.toolbar.items

.. method:: add_sideframe_item(name, url, active=False, disabled=False, extra_classes=None, on_close=None, side=LEFT, position=None)

Adds an item which opens ``url`` in the side frame and returns it.
Adds an item which opens ``url`` in the sideframe and returns it.

``on_close`` can be set to ``None`` to do nothing when the side frame
``on_close`` can be set to ``None`` to do nothing when the sideframe
closes, :attr:`REFRESH_PAGE` to refresh the page when it
closes or a URL to open once it closes.

.. method:: add_modal_item(name, url, active=False, disabled=False, extra_classes=None, on_close=REFRESH_PAGE, side=LEFT, position=None)

The same as :meth:`add_sideframe_item`, but opens the ``url`` in a
modal dialog instead of the side frame.
modal dialog instead of the sideframe.

``on_close`` can be set to ``None`` to do nothing when the side modal
closes, :attr:`REFRESH_PAGE` to refresh the page when it
Expand Down Expand Up @@ -575,7 +583,7 @@ cms.toolbar.items

.. class:: SideframeItem(name, url, active=False, disabled=False, extra_classes=None, on_close=None, side=LEFT)

Item that opens ``url`` in side frame.
Item that opens ``url`` in sideframe.


.. class:: AjaxItem(name, action, csrf_token, data=None, active=False, disabled=False, extra_classes=None, question=None, side=LEFT)
Expand Down
4 changes: 2 additions & 2 deletions docs/topics/touch.rst
Expand Up @@ -46,14 +46,14 @@ Device support
Smaller devices such as most phones are too small to be adequately usable. For example, your Apple
Watch is sadly unlikely to provide a very good django CMS editing experience.

Older devices will often lack the performance to support support a usefully responsive frontend
Older devices will often lack the performance to support a usefully responsive frontend
editing/administration interface.

The following devices are known to work well, so newer devices and more powerful models should also
be suitable:

* iOS: Apple iPad Air 1, Mini 4
* Android: Asus Nexus 7, Sony Xperia Z2 Tablet, Samsung Galaxy Tab 4
* Android: Sony Xperia Z2 Tablet, Samsung Galaxy Tab 4
* Windows 10: Microsoft Surface

We welcome feedback about specific devices.
Expand Down
14 changes: 10 additions & 4 deletions docs/upgrade/3.2.rst
Expand Up @@ -24,7 +24,8 @@ What's new in 3.2
devices
* enhanced and polished user interface
* much-needed improvements to the structure-board
* enhancements to components such as the pop-up plugin editor, sideframe and the toolbar
* enhancements to components such as the pop-up plugin editor, sideframe (now called the *overlay*)
and the toolbar
* significant speed improvements on loading, HTTP requests and file sizes
* restarts are no longer required when changing apphook configurations
* a new content wizard system, adaptable to arbitrary content types
Expand All @@ -47,7 +48,7 @@ For general information about touch interface support, see the :ref:`touch scree
responsibility of the site developer.

Numerous aspects of the CMS and its interface have been updated to work well with touch-screen
devices. There are are some restrictions and warnings that need to be borne in mind.
devices. There are some restrictions and warnings that need to be borne in mind.


Device support
Expand All @@ -56,7 +57,7 @@ Device support
Smaller devices such as most phones are too small to be adequately usable. For example, your Apple
Watch is sadly unlikely to provide a very good django CMS editing experience.

Older devices will often lack the performance to support support a usefully responsive frontend
Older devices will often lack the performance to support a usefully responsive frontend
editing/administration interface.

See :ref:`device-support` for information about devices that have been tested and confirmed to
Expand Down Expand Up @@ -233,7 +234,12 @@ Replaced the sideframe with an overlay
======================================

The sideframe that could be expanded and collapsed to reveal a view of the admin and other controls
has been replaced by a simpler and more elegant overlay mechanism.
has been replaced by a simpler and more elegant *overlay* mechanism.

The API documentation still refers to the ``sideframe``, because it is invoked in the same way, and
what has changed is merely the behaviour in the user's browser.

In other words, *sideframe* and the *overlay* refer to different versions of the same thing.


New startup screen
Expand Down

0 comments on commit 0c8b349

Please sign in to comment.