******************************************************************************
*
* Mlango Viewlets: Drag & Drop on your Desktop
* Author: Goldmund, Wyldebeast & Wunderliebe
*
******************************************************************************

Contents
--------
1.0 Introduction
2.0 Installation
3.0 Viewlets
4.0 Modifying viewlets
5.0 Known bugs


1.0 Introduction
----------------

Mlango is a desktop implementation where users can manage 'viewlets'
on their own desktop, dragging those to different places, setting
properties, removing, etc. Desktop settings are saved when leaving the
desktop.  'Mlango' is Swahili for 'gate', 'door', etc. Mlango intends
to provide a modern user experience for Plone users.

2.0 Installation
----------------
Dependencies:
    -Archetypes
    -InstallUtils
    -MimetypesRegistry
    -PortalTransforms
    -Mlango
    -PloneWeatherForecast

The MlangloViewlets product contains a few viewlet examples.

3.0 Viewlets
------------

Viewlets are simply configuration items to a viewlet registry. 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 bugs
--------------
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