Changes between Version 1 and Version 2 of NoticePublisherPlugin


Ignore:
Timestamp:
Jan 8, 2012 6:02:32 PM (3 years ago)
Author:
seccanj
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • NoticePublisherPlugin

    v1 v2  
    33= Notice Publisher Plugin = 
    44 
     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 FAQ management plugin. 
     6[[BR]] 
     7[[BR]] 
     8 
    59== Description == 
    6  
     10[[BR]] 
    711A Trac plugin to display Notices to any User visiting any page in Trac. 
    8  
     12[[BR]] 
    913This is useful to bring everyone attention on news that affect all users, 
    1014like the system going down, a solution to a common problem, and so on. 
    11  
     15[[BR]] 
    1216Notices can contain Wiki-formatted syntax, thus allowing for rich content. 
    13  
     17[[BR]] 
    1418Notices can have an expiration, expressed in hours, after which they  
    1519automatically disappear. 
     20[[BR]] 
     21In 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]] 
     23A Notice Administration panel allows for showing which notices are active and their expiration time, and for deleting them. 
    1624 
    17 In addition to the automatic expiration, each notice has a "close" icon, 
    18 allowing each User to close it. The plugin remembers each User closing a 
     25[[BR]] 
     26=== Publishing a new Notice === 
     27[[BR]] 
     28To 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]] 
     30Notices have a severity, Informational, Success, Warning and Error, which determine the Notice icons. 
     31[[BR]] 
     32Notices have a title and a Text. 
     33[[BR]] 
     34You can use WikiFormatting in the Notice text. Note that you have a limited space for your contents, about 4 lines of text. 
     35[[BR]] 
     36You 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]] 
     38Note that you can always remove Notices from the '''Notices Admin''' panel. 
     39[[BR]] 
     40In 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]] 
     42Clicking '''Publish''' will publish the new Notice, as shown in the next figure. 
     43[[BR]] 
     44The new Notice will be shown on every Trac page of every User, as soon as they refresh or navigate to a different Trac page. 
    1945 
    20 Notice and will not show it again to that User. 
     46[[BR]] 
     47[[BR]] 
     48[[Image(notice_01.png)]] 
     49[[BR]] 
     50'''Publishing a new Notice''' 
     51[[BR]] 
     52[[BR]] 
    2153 
    22 A Notice Administration panel allows for showing which notices are active, 
    23 the time of expiration and for deleting them. 
     54[[BR]] 
     55[[BR]] 
     56[[Image(notice_02.png)]] 
     57[[BR]] 
     58'''How the Notice appears''' 
     59[[BR]] 
     60[[BR]] 
    2461 
    25 Requires TracGenericClass v. 1.1.1+. 
     62[[BR]] 
     63== Notices Administration == 
    2664 
     65To manage Notices, click on the '''Admin Notices''' tab in the upper-right Trac navigation bar. 
     66[[BR]] 
     67The Notice Administration panel lists the active notices and displays the expiration time of each. 
     68[[BR]] 
     69To permanently remove a Notice for all Users, click the '''X''' icon. 
    2770 
     71[[BR]] 
     72== Security == 
     73 
     74The Notice management capabilities are protected by a set of new Trac permissions: 
     75 * NOTICE_PUBLISH : Allows for creating Notices 
     76 * NOTICE_VIEW : Allows for viewing Notices 
     77 * NOTICE_ADMIN : Allows access to the Notices administration panel, to list Notices and delete them. 
     78 
     79[[BR]] 
     80[[BR]] 
     81[[BR]] 
    2882== Bugs/Feature Requests ==  
    2983 
     
    3488[http://trac-hacks.org/newticket?component=NoticePublisherPlugin&owner=seccanj new ticket]. 
    3589 
     90[[BR]] 
    3691== Download == 
     92[[BR]] 
    3793 
    38 Download the zipped source from [download:noticepublisherplugin here]. 
     94Download Egg files and the zipped source from [https://sourceforge.net/projects/faq4trac/files/ the project on SourceForge]. 
    3995 
     96[[BR]] 
    4097== Source == 
     98[[BR]] 
    4199 
    42 You can check out NoticePublisherPlugin from [http://trac-hacks.org/svn/noticepublisherplugin here] using Subversion, or [source:noticepublisherplugin browse the source] with Trac. 
     100You can check out NoticePublisherPlugin from [https://sourceforge.net/projects/faq4trac/code/ the repository on SourceForge] using Git. 
    43101 
    44 == Example == 
    45  
    46 a 
    47  
     102[[BR]] 
    48103== Recent Changes == 
     104[[BR]] 
    49105 
    50106[[ChangeLog(noticepublisherplugin, 3)]]