Metadata-Version: 1.1
Name: collective.messagesviewlet
Version: 0.2
Summary: Add-on displaying manager defined messages in a viewlet
Home-page: http://pypi.python.org/pypi/collective.messagesviewlet
Author: IMIO Team
Author-email: support@imio.be
License: GPL version 2
Description: .. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.
           If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide_addons.html
           This text does not appear on pypi or github. It is a comment.
        
        ==============================================================================
        collective.messagesviewlet
        ==============================================================================
        
        Add-on displaying manager defined messages in a viewlet
        
        .. image:: docs/messageviewletinaction.png 
            :alt: The three message types.
            :width: 1300
            :height: 495
            :align: center
        
        Features
        --------
        
        Messages are defined in control panel.
        
        Multiple messages can be displayed together in the viewlet. 
        
        A message contains the following configuration attributes:
        
        * text : displayed text in the viewlet
        * message type : info, warning, important (different layout in the viewlet)
        * can hide : if checked, the user can hide the message (mark as read)
        * start date : displaying start date (optional)
        * end date : displaying end date (optional)
        * required roles : use must have one of the required roles (optional)
        * location : full site or homepage only
        
        The collective.behavior.talcondition is enabled, providing 2 attributes. 
        * tal condition : optional tal expression evaluated on viewlet context
        * bypassing roles : optional roles bypassing the tal condition
        
        .. image:: docs/messageviewletinconfiguration.png 
            :alt: The management interface.
            :width: 1252
            :height: 1362
            :align: center
        
        
        A workflow is provided with the following states:
        
        * inactive : not displayed
        * activated for anonymous : displayed for anonymous users
        * activated for members : displayed only for authenticated users
        * activated for localroles : displayed only for authenticated users having local reader role
        
        The hiding functionality uses a cookie. It is necessary to deactivate a message to "reset" the cookie.
        When activating again, the message will be displayed. 
        
        Improvements
        ------------
        
        * Modify hidden_uid when some fields are changed: end when gone, can_hide (to unchecked), start when end is gone
        * Message definition from file system
        * Message definition from rss feed
        
        Translations
        ------------
        
        This product has been translated into
        
        - English
        - French
        
        
        Installation
        ------------
        
        Install collective.messagesviewlet by adding it to your buildout::
        
           [buildout]
        
            ...
        
            eggs =
                collective.messagesviewlet
        
        
        and then running "bin/buildout"
        
        
        Contribute
        ----------
        
        - Issue Tracker: https://github.com/collective/collective.messagesviewlet/issues
        - Source Code: https://github.com/collective/collective.messagesviewlet
        
        
        Support
        -------
        
        If you are having issues, please let us know.
        
        
        License
        -------
        
        The project is licensed under the GPLv2.
        
        Contributors
        ============
        
        - IMIO Team, support@imio.be
        
        Changelog
        =========
        
        
        0.2 (2015-09-09)
        ----------------
        
        - Added utils method to create message. Added example profile to add some messages.
          [sgeulette]
        
        
        0.1 (2015-09-08)
        ----------------
        
        - Initial release.
          [sgeulette, anuyens, DieKatze, boulch]
        
        
Keywords: Python Plone
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Plone
Classifier: Framework :: Plone :: 4.3
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
