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

Last change on this file since 3518 was 3518, checked in by kroman0, 8 years ago

Updated README, up package version

  • Property svn:eol-style set to native
File size: 2.5 KB
Line 
1Introduction
2------------
3
4The product allows you to build a responsive multilevel drop-down menu that will
5provide your visitors with organized and intuitive navigation. On mobile devices
6your top menu bar transforms into one drop-down. By clicking on the title or
7a small arrow next to it all-level menu items appear below the title.
8
9This package allows to build dropdown menu through the web with portal_actions.
10Submenus are built from a tree of nested Category Actions and Actions.
11
12The other strategy used to populate submenus is Plone default NavigationStrategy,
13the one used in navigation portlet. 
14
15This project is successor of qPloneDropDownMenu.
16
17Building you dropdown menu with portal_actions
18==============================================
19
20Starting from Plone 3 portal actions introduced CMF Action Category
21containers, it opened opportunity to build nested actions trees. Though CMF Action
22Category does not behave as a regular action, it has different set of properties.
23We introduced convention in quintagroup.dropdownmenu that requires to have
24a specially named Action for each Actions Category. The id of each such action
25must be build using the rule::
26 
27  action_id = prefix + category_id + suffix
28   
29where:
30 
31:category_id: is id of correspondent CMF Action Category   
32:prefix: defined in DropDownMenu configlet, default value ''
33:suffix: defined in DropDownMenu configlet, default value '_sub'
34
35So, the actions structure can look like::
36
37  + portal_tabs
38  |- home
39  |- blog_sub
40  |-+ blog
41  | |-- 2009
42  | |-- 2010
43     
44By default the root of dropdown menu is 'portal_tabs' category.
45
46Menu caching
47============
48
49If the menu built with Navigation strategy is entirely public it can be cached for
50all users. If Authenticaded users should see some non public items the menu can be
51cached for anonymous only.
52
53Caching in case of involving the portal_actions strategy is effective only in case
54if all the action are public and have no extra conditions. In case some conditions
55are applied per action switch off caching.
56
57 
58Compatibility
59=============
60
61* **Plone 4** sample CSS file based on Sunburst theme provided
62* **Plone 3.0-3.3** the default CSS file has to be overridden
63
64Installation
65============
66
67* add http://good-py.appspot.com/release/plone.app.registry/1.0b2 to versions in your buildout
68* add quintagroup.dropdownmenu to eggs in your buildout
69* install Plone DropDown Menu in Plone via Site Setup -> Add-ons
70
71Find more details on the topic inside docs/INSTALL.txt
72
Note: See TracBrowser for help on using the repository browser.