Changes between Version 4 and Version 5 of NoticePublisherPlugin
- Timestamp:
- May 2, 2015, 12:08:07 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
NoticePublisherPlugin
v4 v5 1 1 [[PageOutline(2-5,Contents,pullout)]] 2 2 3 = Notice Publisher Plugin =3 = Notice Publisher Plugin 4 4 5 '''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 Notice Publisher plugin. 6 [[BR]] 7 [[BR]] 5 '''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 Notice Publisher plugin. 8 6 9 == Description == 10 [[BR]] 11 A Trac plugin to display Notices to any User visiting any page in Trac. 12 [[BR]] 13 This is useful to bring everyone attention on news that affect all users, 14 like the system going down, a solution to a common problem, and so on. 15 [[BR]] 7 == Description 8 9 This is a Trac plugin to display notices to any user visiting any page in Trac. 10 This is useful to bring all users' attention on news that may affect all users, like the system going down, a solution to a common problem, and so on. 16 11 Notices can contain Wiki-formatted syntax, thus allowing for rich content. 17 [[BR]] 18 Notices can have an expiration, expressed in hours, after which they 19 automatically disappear. 20 [[BR]] 12 13 Notices can have an expiration, expressed in hours, after which they automatically disappear. 14 21 15 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. 22 [[BR]] 16 23 17 A Notice Administration panel allows for showing which notices are active and their expiration time, and for deleting them. 24 18 25 [[BR]] 26 === Publishing a new Notice === 27 [[BR]] 19 === Publishing a new Notice 20 28 21 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. 29 [[BR]] 22 30 23 Notices have a severity, Informational, Success, Warning and Error, which determine the Notice icons. 31 [[BR]] 24 32 25 Notices have a title and a Text. 33 [[BR]] 26 34 27 You can use WikiFormatting in the Notice text. Note that you have a limited space for your contents, about 4 lines of text. 35 [[BR]] 28 36 29 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. 37 [[BR]] 30 38 31 Note that you can always remove Notices from the '''Notices Admin''' panel. 39 [[BR]] 32 40 33 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. 41 [[BR]] 34 42 35 Clicking '''Publish''' will publish the new Notice, as shown in the next figure. 43 [[BR]] 36 44 37 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. 45 38 46 [[BR]]47 39 [[BR]] 48 40 [[Image(notice_01.png)]] … … 50 42 '''Publishing a new Notice''' 51 43 [[BR]] 52 [[BR]]53 44 54 [[BR]]55 45 [[BR]] 56 46 [[Image(notice_02.png)]] … … 58 48 '''How the Notice appears''' 59 49 [[BR]] 60 [[BR]]61 50 62 [[BR]] 63 == Notices Administration == 51 === Notices Administration 64 52 65 53 To manage Notices, click on the '''Admin Notices''' tab in the upper-right Trac navigation bar. 66 [[BR]] 54 67 55 The Notice Administration panel, shown in the following figure, lists the active notices and displays the expiration time of each. 68 [[BR]] 56 69 57 To permanently remove a Notice for all Users, click the '''X''' icon. 70 58 71 [[BR]]72 59 [[BR]] 73 60 [[Image(notice_05.png)]] … … 75 62 '''The Notices Administration panel''' 76 63 [[BR]] 77 [[BR]]78 64 79 [[BR]] 80 == Security == 65 === Security 81 66 82 67 The Notice management capabilities are protected by a set of new Trac permissions: 83 * NOTICE_PUBLISH : Allows for creating Notices84 * NOTICE_VIEW : Allows for viewing Notices85 * NOTICE_ADMIN: Allows access to the Notices administration panel, to list Notices and delete them.68 * `NOTICE_PUBLISH`: Allows for creating Notices. 69 * `NOTICE_VIEW`: Allows for viewing Notices. 70 * `NOTICE_ADMIN`: Allows access to the Notices administration panel, to list Notices and delete them. 86 71 87 [[BR]] 88 [[BR]] 89 [[BR]] 90 == Bugs/Feature Requests == 72 == Bugs/Feature Requests 91 73 92 74 Existing bugs and feature requests for NoticePublisherPlugin are … … 96 78 [http://trac-hacks.org/newticket?component=NoticePublisherPlugin&owner=seccanj new ticket]. 97 79 98 [[BR]] 99 == Download == 100 [[BR]] 80 == Download 101 81 102 82 Download Egg files and the zipped source from [https://sourceforge.net/p/notices4trac/files/ the project on SourceForge]. 103 83 104 [[BR]] 105 == Source == 106 [[BR]] 84 == Source 107 85 108 86 You can check out NoticePublisherPlugin from [https://sourceforge.net/p/notices4trac/code/ the repository on SourceForge] using Git. 109 87 110 [[BR]] 111 == Recent Changes == 112 [[BR]] 88 == Recent Changes 113 89 114 90 [[ChangeLog(noticepublisherplugin, 3)]] 115 91 116 == Author/Contributors ==92 == Author/Contributors 117 93 118 94 '''Author:''' [wiki:seccanj] [[BR]] 119 '''Maintainer:''' [ wiki:seccanj] [[BR]]95 '''Maintainer:''' [[Maintainer]] [[BR]] 120 96 '''Contributors:'''
