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

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

fixed documentation markup

  • Property svn:eol-style set to native
File size: 1.7 KB
RevLine 
[1154]1Introduction
2============
3
[2782]4This package allows to build dropdown menu through the web with portal_actions.
[2786]5Submenus are built from a tree of nested Category Actions and Actions.
[2782]6The other strategy used to populate submenus is Plone default NavigationStrategy,
7the one used in navigation portlet. 
[1154]8
[2782]9This project is successor of qPloneDropDownMenu.
[1157]10
[2782]11Building you dropdown menu with portal_actions
12----------------------------------------------
[1158]13
[2782]14Starting from Plone 3 portal actions introduced CMF Action Category
[2786]15containers, it opened opportunity to build nested actions trees. Though CMF Action
[2782]16Category does not behave as a regular action, it has different set of properties.
[2786]17We introduced convention in quintagroup.dropdownmenu that requires to have
[2782]18a specially named Action for each Actions Category. The id of each such action
[2849]19must be build using the rule::
[2782]20 
[2849]21  action_id = prefix + category_id + suffix
[2782]22   
23where:
24 
[2849]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'
[1158]28
[2849]29So, the actions structure can look like::
[1158]30
[2849]31  + portal_tabs
32  |- home
33  |- blog_sub
34  |-+ blog
35  | |-- 2009
36  | |-- 2010
[2782]37     
38By default the root of dropdown menu is 'portal_tabs' category.
39 
40Compatibility
[2849]41-------------
[1157]42
[2849]43* **Plone 4** sample CSS file based on Sunburst theme provided
44* **Plone 3.0-3.3** the default CSS file has to be overridden
[1157]45
[1173]46Installation
47------------
[1157]48
[2849]49* add http://good-py.appspot.com/release/plone.app.registry/1.0b2 to your versions
50* add quintagroup.dropdownmenu to your buildout
51* install in Plone with Quick Installer
52* find more details inside docs/INSTALL.txt
Note: See TracBrowser for help on using the repository browser.