[[PageOutline(2-5,Contents,pullout)]] = Notice Publisher Plugin = '''Note: Requires the [wiki:TestManagerForTracPluginGenericClass Trac Generic Class plugin] v. 1.1.1+, which is part of TestManagerForTracPlugin.''' Download it [https://sourceforge.net/projects/testman4trac/ here], then [build and] install the !TracGenericClass.egg file into Trac before installing the FAQ management plugin. [[BR]] [[BR]] == Description == [[BR]] A Trac plugin to display Notices to any User visiting any page in Trac. [[BR]] 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. [[BR]] Notices can contain Wiki-formatted syntax, thus allowing for rich content. [[BR]] Notices can have an expiration, expressed in hours, after which they automatically disappear. [[BR]] 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. [[BR]] A Notice Administration panel allows for showing which notices are active and their expiration time, and for deleting them. [[BR]] === Publishing a new Notice === [[BR]] 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. [[BR]] Notices have a severity, Informational, Success, Warning and Error, which determine the Notice icons. [[BR]] Notices have a title and a Text. [[BR]] You can use WikiFormatting in the Notice text. Note that you have a limited space for your contents, about 4 lines of text. [[BR]] 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. [[BR]] Note that you can always remove Notices from the '''Notices Admin''' panel. [[BR]] 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. [[BR]] Clicking '''Publish''' will publish the new Notice, as shown in the next figure. [[BR]] 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. [[BR]] [[BR]] [[Image(notice_01.png)]] [[BR]] '''Publishing a new Notice''' [[BR]] [[BR]] [[BR]] [[BR]] [[Image(notice_02.png)]] [[BR]] '''How the Notice appears''' [[BR]] [[BR]] [[BR]] == Notices Administration == To manage Notices, click on the '''Admin Notices''' tab in the upper-right Trac navigation bar. [[BR]] The Notice Administration panel, shown in the following figure, lists the active notices and displays the expiration time of each. [[BR]] To permanently remove a Notice for all Users, click the '''X''' icon. [[BR]] [[BR]] [[Image(notice_05.png)]] [[BR]] '''The Notices Administration panel''' [[BR]] [[BR]] [[BR]] == 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. [[BR]] [[BR]] [[BR]] == Bugs/Feature Requests == Existing bugs and feature requests for NoticePublisherPlugin are [report:9?COMPONENT=NoticePublisherPlugin here]. If you have any issues, create a [http://trac-hacks.org/newticket?component=NoticePublisherPlugin&owner=seccanj new ticket]. [[BR]] == Download == [[BR]] Download Egg files and the zipped source from [https://sourceforge.net/p/notices4trac/files/ the project on SourceForge]. [[BR]] == Source == [[BR]] You can check out NoticePublisherPlugin from [https://sourceforge.net/p/notices4trac/code/ the repository on SourceForge] using Git. [[BR]] == Recent Changes == [[BR]] [[ChangeLog(noticepublisherplugin, 3)]] == Author/Contributors == '''Author:''' [wiki:seccanj] [[BR]] '''Maintainer:''' [wiki:seccanj] [[BR]] '''Contributors:'''