MlangoViewlets
Category: Layout and presentation
—
Other products by this author
Current release
No stable release available yet.
Experimental releases
Upcoming and alpha/beta/candidate releases
- Alpha releases should only be used for testing and development.
- Beta releases and Release Candidates are normally released for production testing, but should not be used on mission-critical sites.
- Always install on a separate test server first, and make sure you have proper backups before installing.
Project Description
- Project resources
Releases
Contact address
Issue tracker
Code repositoryThis product contains MlangoViewlets (viewlets for Mlango)
(see: http://www.goldmund-wyldebeast-wunderliebe.com/products)
--------
Contents
--------
1.0 Introduction
2.0 Installation
3.0 Viewlets
4.0 Modifying viewlets
5.0 Known bug
1.0 Introduction
----------------
MlangoViewlets is an add on product on top of the core Mlango dashboard product.
'Mlango' is Swahili for 'gate', 'door', etc. Mlango intends to provide a modern user experience for Plone users.
2.0 Installation
----------------
Dependencies:
- Archetypes
- InstallUtils
- Mlango
- MimetypesRegistry
- PortalTransforms
3.0 Viewlets
------------
Viewlets
are configured in the viewlet registry. Some examples are distributed
with the core Mlango products as well as with the MlangoViewlets
product. The registry is held by the Mlango tool. A viewlet
configuration consists of the following fields used by the rendering
framework
| Name | Required | Description |
| id | y | Unique id for this viewlet. The id should contain no spaces! |
| title | y | Title to show in top bar |
| icon | n | Icon to show in viewlet toolbox |
| macro | y | Macro needed to render the viewlet |
| help | n | Help text. If given, a help icon will be rendered in the viewlet's toolbar. |
| properties | n | A map of properties. If provided an edit icon will be rendered in the viewlet's toolbar. |
| properties_form | n | Required in combination with properties. Defines the form used for changing properties. |
| fixed | n | Defaults to -1. If set to a number larger than that, it will be placed in that column. No drag and no remove will be allowed. |
Apart from that, any other fields may be added, to be used by for instance the viewlet macro. So if you wish to use an RSS source form instance, add a field rss_url. Within the macro this field will now be available as info/rss_url (or python: info['rss_url'].
4.0 Modifying viewlets
----------------------
Adding viewlets:
-Create a page template in MlangoViewlets/skins/mlango_viewlets/
-Add the viewlet to VIEWLETS in MlangoViewlets/config.py
5.0 Known bug
--------------
When a Mlanglo viewlet is added/removed/changed follow the instructions below
to see the change in Manglo dashboard.
- Restart the Zope instance
- Delete the 'mlango_tool' from the ZMI
- Reinstall Mlango and Mlangoviewlet products