source: products/quintagroup.dropdownmenu/trunk/README.txt @ 2782

Last change on this file since 2782 was 2782, checked in by chervol, 14 years ago

documentation update

  • Property svn:eol-style set to native
File size: 1.5 KB
Line 
1Introduction
2============
3
4This package allows to build dropdown menu through the web with portal_actions.
5Submenus are built of the tree of nested Category Actions and Actions.
6The other strategy used to populate submenus is Plone default NavigationStrategy,
7the one used in navigation portlet. 
8
9This project is successor of qPloneDropDownMenu.
10
11Building you dropdown menu with portal_actions
12----------------------------------------------
13
14Starting from Plone 3 portal actions introduced CMF Action Category
15containers it opened opportunity to build nested actions trees. Though CMF Action
16Category does not behave as a regular action, it has different set of properties.
17We introduced convention in the quintagroup.dropdownmenu that requires to have
18a specially named Action for each Actions Category. The id of each such action
19must be build using the rule:
20 
21    action_id = prefix + category_id + suffix
22   
23where:
24 
25    'category_id' is id of correspondent CMF Action Category
26    'prefix' defined in DropDownMenu configlet, default value ''
27    'suffix' defined in DropDownMenu configlet, default value '_sub'
28
29So the actions structure can look like:
30
31    / portal_tabs
32    |- home
33    |- blog_sub
34    |-/ blog
35    | |-- 2009
36    | |-- 2010
37     
38By default the root of dropdown menu is 'portal_tabs' category.
39
40 
41Compatibility
42-----------
43
44  Plone 3.0 - 3.3
45  Plone 4
46
47
48Installation
49------------
50
51  * add quintagroup.dropdownmenu to your buildout
52  * install in Plone with Quick Installer
53  * find more details inside docs/INSTALL.txt
54
Note: See TracBrowser for help on using the repository browser.