redturtle.custommenu.factories 0.3.1

Installation

Simply add the egg to your buildout, and re-run it.

[instance]
...
eggs =
    ...
    redturtle.custommenu.factories
...

Remember to add also the ZCML slug and overrides if you are testing this on Plone 3.2 or lesser.

After this, install the new product in Plone.

Customize the menu

In your “Add new…” menu you’ll find a new “Customize menu…” entry. This will lead you to a form where you must enable customization feature on the current context. After this you can use the a customization form where you can manage local menu changes.

For every new entry you can/must fill this informations:

id

Enter here a string to be used to add an HTML id attribute to the new element. You can not provide it, but if you use an already existing ids, the new one will override the old. In this way you can replace one of the native (or inherited) menu entry with a new ones.

name

Required. Provide the string to be used for displaying the new element.

description

The description is used to provide a tooltips hovering the element.

icon

A TALES expression that can be used to give an icon to the new element (very common).

condition

A TALES condition expression. If not provided, the new element is added to the menu. In provided it is evaluated as True or False, so the element is displayed or not.

URL

Required. A TALES expression used to render the HREF attribute on the link in the element. You have total freedom here: you can also render a string as “javascript:…” to provide some Javascript features.

Also you can inherit the customization done in the site root everywhere in the site, adding this to all other customizations. You can also locally block the inherit of root customization but you can also make new menu elements defined in the root available only in the root itself.

Also, you can give a right id to new entries not only to override menu element from Plone normal behaviour, but also for change a customization done in the site root.

TALES expressions

In the TALES expression above, you can use those variables:

context

The current context, as Plone normal meaning

container

The container of the current context, or the context itself if the context is a container. This is useful when writing expression that keep in mind the default document in a folder.

portal_url

The portal_url tool, taken from the Plone site.

Generic setup support

Juan. [nueces] provided Generic Setup support for this package:

<?xml version="1.0"?>
<object>
  <property name="inherit">True</property>
  <custommenu>
    <property name="element-id">pdf-file</property>
    <property name="element-name">PDF Document</property>
    <property name="element-descr">A file content to be filled with a PDF document</property>
    <property name="icon-tales">string:$portal_url/pdf_icon.gif</property>
    <property name="condition-tales"></property>
    <property name="element-tales">string:${container/absolute_url}/createObject?type_name=File</property>
  </custommenu>
  <custommenu>
      ...
  </custommenu>
  <object name="documents">
    <property name="inherit">True</property>
    <custommenu>
        ...
    </custommenu>
    <object name="ebooks">
       <property name="inherit">True</property>
       <custommenu>
            ...
       </custommenu>
       ...
    </object>
    ...
  </object>
  ...
<object>

For a complete code check collective.examples.custommenufactories.

0.3.1 (2015-02-24)

• Fixed issue when on folders that are not annotable (uncommon, but may happen on old stuff like PloneGazette). [keul]

• Plone 3/ Plone 4 compatibility on default menu title and description [keul]

• Fixed tests [keul]

• Pyflakes cleanup and related errors fixed [keul]

0.3.0 (2013-07-10)

• provided Generic Setup support [nueces]

• now can’t no-more manage menu without installing the product [keul]

• disabled useless JavaScript [keul]

• now works also with single entry menu (close #1) [keul]

• now supporting Plone 4 style icons [keul]

0.2.0b - (2010-02-17)

• now local customizations must be enabled and disabled per-context [keul]

• fixes to XHTML structure and validation [keul]

• fixed CSS class names to be camelCase as Plone does [keul]

• added tests [keul]

• fixed templates to be test compatible [keul]

• fixed a bug on entry deletion [keul]

• added missing check on required element for entries (in facts were optional) [keul]

• added egg support for z3c.autoinclude [keul]

• now False condition for an element with id hide inherited element with same id [keul]

• added Plone 4 compatibility [keul]

0.1.0a - (2010-01-04)

• initial release