wiki:NoticePublisherPlugin

Version 4 (modified by seccanj, 2 years ago) (diff)

--

Notice Publisher Plugin

Note: Requires the Trac Generic Class plugin v. 1.1.1+, which is part of TestManagerForTracPlugin. Download it here, then [build and] install the TracGenericClass.egg file into Trac before installing the Notice Publisher plugin.

Description


A Trac plugin to display Notices to any User visiting any page in Trac.
This is useful to bring everyone attention on news that affect all users, like the system going down, a solution to a common problem, and so on.
Notices can contain Wiki-formatted syntax, thus allowing for rich content.
Notices can have an expiration, expressed in hours, after which they automatically disappear.
In addition to the automatic expiration, each notice has a Close icon, allowing each User to close it. The plugin remembers each User closing a Notice and will not show it again to that User.
A Notice Administration panel allows for showing which notices are active and their expiration time, and for deleting them.


Publishing a new Notice


To publish a new Notice, click the Publish Notice tab in the upper-right Trac navigation bar, then fill the required information, as shown in the following figure.
Notices have a severity, Informational, Success, Warning and Error, which determine the Notice icons.
Notices have a title and a Text.
You can use WikiFormatting in the Notice text. Note that you have a limited space for your contents, about 4 lines of text.
You can also specify an expiration, expressed in hours, after which the Notice will automatically disappear for every User. Do not specify an expiration for a permanent Notice.
Note that you can always remove Notices from the Notices Admin panel.
In addition to the automatic expiration, each notice has a Close icon, allowing each User to close it. The plugin remembers each User closing a Notice and will not show it again to that User.
Clicking Publish will publish the new Notice, as shown in the next figure.
The new Notice will be shown on every Trac page of every User, as soon as they refresh or navigate to a different Trac page.



Publishing a new Notice
Publishing a new Notice



How the Notice appears
How the Notice appears


Notices Administration

To manage Notices, click on the Admin Notices tab in the upper-right Trac navigation bar.
The Notice Administration panel, shown in the following figure, lists the active notices and displays the expiration time of each.
To permanently remove a Notice for all Users, click the X icon.



The Notice Administration panel
The Notices Administration panel


Security

The Notice management capabilities are protected by a set of new Trac permissions:

  • NOTICE_PUBLISH : Allows for creating Notices
  • NOTICE_VIEW : Allows for viewing Notices
  • NOTICE_ADMIN : Allows access to the Notices administration panel, to list Notices and delete them.




Bugs/Feature Requests

Existing bugs and feature requests for NoticePublisherPlugin are here.

If you have any issues, create a new ticket.


Download


Download Egg files and the zipped source from the project on SourceForge.


Source


You can check out NoticePublisherPlugin from the repository on SourceForge using Git.


Recent Changes


[11129] by seccanj on 2012-01-08 17:14:38
New hack NoticePublisherPlugin, created by seccanj

Author/Contributors

Author: seccanj
Maintainer: seccanj
Contributors:

Attachments (3)

Download all attachments as: .zip