Skip to content

Commit

Permalink
Document usage of the new icons.
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Howitz committed Feb 6, 2018
1 parent 0c3406d commit 56c2b77
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/WHATSNEW.rst
Original file line number Diff line number Diff line change
Expand Up @@ -143,3 +143,11 @@ Zope 4 depends on a new DateTime release. The new release has been optimized
for better memory use. Applications using a lot of DateTime values like the
Plone CMS have seen total memory usage to decrease by 10% to 20% for medium
to large deployments.


ZMI overhaul
------------

The ZMI (Zope Management Interface) is now styled with Twitter Bootstrap.
See :ref:`ZMI-label` for details how to adapt Zope add-on packages to the new
styling.
30 changes: 30 additions & 0 deletions docs/ZMI.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
.. _ZMI-label:

ZMI
===

ZMI is an abbreviation for `Zope Management Interface`. This is the user
interface rendered when accessing Zope`s management screens using a web
browser.

Bootstrap ZMI
-------------

Since Zope 4.0b4 the ZMI is styled using Twitter bootstrap. The previously used
GIF icons were replaced by font glyphs which are stored in the package
`zmi.icons`_

Inside that package is a table of the `available icons`_ including the names
which are required to use them.

Update packages
+++++++++++++++

If you have a Product or package which contains types, which can be added via
the ZMI, the default icon will be shown.

To use one of the new icons add an attribute named `zmi_icon` to the class. The
value should be one of the names listed on `available icons`_.

.. _`zmi.icons` : https://github.com/zopefoundation/zmi.icons
.. _`available icons` : http://htmlpreview.github.io/?https://github.com/zopefoundation/zmi.icons/blob/master/zmi/icons/resources/demo.html
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Contents:
INSTALL-virtualenv
operation
USERS
ZMI
SECURITY
maintenance
changes
Expand Down

0 comments on commit 56c2b77

Please sign in to comment.