collective.messagesviewlet

Add-on displaying manager defined messages in a viewlet

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, significant, warning (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 : user must have one of the required roles (optional)
• use local roles : message displayed for users having Reader local role on message (optional)
• location : full site or homepage only

Local messages can also be authorized (through control panel) to be added in any folderish content types and you can then choose if / on which levels they display.

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

A workflow is provided with the following states:

• inactive : not displayed
• activated : displayed

The hiding functionality uses a cookie. It is necessary to (re-)activate a message to "reset" the cookie. After new activation, the message will be displayed again even for users that hide it.

The optional 'messages' profile adds some usefull examples that can be activated when needed:

• message for scheduled maintenance (limited to Member)
• message for imminent or current maintenance : (given to anonymous)
• message for staging site

There is also a PseudoMessage class that can be instantiated and used in viewlet templates.

Limitations

This add-on has been developed on Plone 4.3, but works with Plone 5 and Plone 6 too.

Current branch is tested on:

• Python 2.7 / Plone 4.3.x & Plone 5.1.x
• Python 3.7 / Plone 5.2.x
• Python 3.8 / Plone 5.2.x & Plone 6.0.x

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.