Changeset 2782 in products


Ignore:
Timestamp:
Sep 3, 2010 3:49:10 PM (14 years ago)
Author:
chervol
Message:

documentation update

Location:
quintagroup.dropdownmenu/trunk
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • quintagroup.dropdownmenu/trunk/README.txt

    r1340 r2782  
    22============ 
    33 
    4 This package allows Plone websites display multilevel portal dropdown menu based 
    5 on portal actions settings and site structure. 
     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.   
    68 
    7 You may ask why we may need one more dropdown menu product for Plone, having 
    8 already qPloneDropDownMenu, webcouturier.dropdownmenu and other products 
    9 providing similar functionality. While qPloneDropDownMenu product just displays 
    10 manually edited html code with nested unordered list, webcouturier.dropdownmenu 
    11 went further and is trying to display submenus for each standard portal tab be 
    12 it action from portal_actions tool or be it auto generated tab based on content 
    13 structure. 
     9This project is successor of qPloneDropDownMenu.  
    1410 
    15 But neither of those products use newly introduced portal_actions tool's 
    16 feature: nested categories. That's why quintagroup.dropdownmenu package was 
    17 introduced. It allows to build multilevel portal dropdown menu based on nested 
    18 portal_actions categories inside portal_tab category as well as based on portal 
    19 content structure. 
     11Building you dropdown menu with portal_actions 
     12---------------------------------------------- 
    2013 
    21 It also allows you to define whether to put content tabs before or after action 
    22 tabs, and a bit more... For details see below. 
     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' 
    2328 
     29So the actions structure can look like: 
    2430 
    25 Notes 
    26 ----- 
     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. 
    2739 
    28   * you may have actions/content-based tabs as deep as you wish, but then you'll 
    29     need to tweek default dropdown menu css rules a bit, default css rules show 
    30     only the first 4 levels of tabs 
    31  
    32 Requirement 
     40  
     41Compatibility 
    3342----------- 
    3443 
    35   Plone 3.0+ 
     44  Plone 3.0 - 3.3 
     45  Plone 4 
    3646 
    3747 
    … …  
    3949------------ 
    4050 
    41   * first follow instructions inside docs/INSTALL.txt document 
     51  * add quintagroup.dropdownmenu to your buildout 
     52  * install in Plone with Quick Installer 
     53  * find more details inside docs/INSTALL.txt  
    4254 
    43   * then install product with Quick Installer in Plone 
    44  
    45  
    46 Migration from qPloneDropDownMenu 
    47 --------------------------------- 
    48  
    49 In case qPloneDropDownMenu product was previously installed, it will 
    50 automatically detect legacy settings, migrate it to a newly created settings 
    51 registry and update portal_actions tool if required along with removing old 
    52 portal_dropdownmenu one. 
    53  
    54 Also installation procedure will uninstall qPloneDropDownMenu product itself 
    55 (in case it's still installed) and clean up everything after it. 
    56  
    57 Note: to successfully migrate old tabs it's required to have a valid html 
    58 markup, otherwise migration procedure won't be able to move tabs correctly. 

  • quintagroup.dropdownmenu/trunk/docs/INSTALL.txt

    r1174 r2782  
    11quintagroup.dropdownmenu installation 
    22------------------------------------- 
    3  
    4 To install quintagroup.dropdownmenu into the global Python environment  
    5 (or a workingenv), using a traditional Zope 2 instance, you can do this: 
    6  
    7 * Copy ``quintagroup`` folder to the ``/path/to/instance/lib/python`` directory. 
    8  
    9 * Create a file called ``quintagroup.dropdownmenu-configure.zcml`` in the 
    10   ``/path/to/instance/etc/package-includes`` directory.  The file 
    11   should only contain this:: 
    12  
    13     <include package="quintagroup.dropdownmenu" /> 
    14  
    15 Alternatively, if you are using zc.buildout and the plone.recipe.zope2instance 
    16 recipe to manage your project, you can do this: 
    173 
    184* Add ``quintagroup.dropdownmenu`` to the list of eggs to install, e.g.:: 
    … …  
    2410        quintagroup.dropdownmenu 
    2511        
    26 * Tell the plone.recipe.zope2instance recipe to install a ZCML slug:: 
    27  
    28     [instance] 
    29     recipe = plone.recipe.zope2instance 
    30     ... 
    31     zcml = 
    32         quintagroup.dropdownmenu 
    33        
    3412After that:      
    3513 
Note: See TracChangeset for help on using the changeset viewer.