Changes between Version 2 and Version 3 of MotdPlugin

Timestamp:

Mar 2, 2011, 3:17:08 PM (13 years ago)

Author:

Christian Masopust

Comment:

--

MotdPlugin

@@ -5 +5 @@
 == Description ==
 
-This plugin allows the system-administrator to display a MOTD on every trac page. Once the user acknowledge the message, it is no longer shown.
+Unlike the NewsFlashMacro, this plugin allows the system-administrator to display a MOTD on ''every'' trac page. Once the user acknowledge the message, it is no longer shown.
 
 For a system-admin it was always hard to inform every trac user about upcoming system updates, maintenance periods, hardware changes or whatever. With this plugin it's now possible to display such message(s) to every trac page, even when having many projects, by simply editing 1 (one!!) textfile.
@@ -17 +17 @@
 [http://trac-hacks.org/newticket?component=MotdPlugin&owner=ChristianM new ticket].
 
-== Download ==
+== Download and Source ==
 
-Download the zipped source from [download:motdplugin here].
+Download the zipped source from [download:motdplugin here], check out MotdPlugin from [http://trac-hacks.org/svn/motdplugin here] using Subversion, or [source:motdplugin browse the source] with Trac.
 
-== Source ==
+== Configuration ==
 
-You can check out MotdPlugin from [http://trac-hacks.org/svn/motdplugin here] using Subversion, or [source:motdplugin browse the source] with Trac.
+MotdPlugin can be configured with the following options:
+{{{
+[motd]
+message_file = /data/messag_of_the_day.ini
+message_dir = /data/motd.d
+date_format = <reserved for future use>
+}}}
+
+message_file
+ * default: /data/motd.ini
+ * location of the file containing the messages to display
+message_dir
+ * default: /data/motd.d
+ * directory containing HTML-files with messages to display
+date_format
+ * default: yyyy-mm-dd HH:MM
+ * allows configuration of the date-format for parameter ''valid_until''
+
+=== motd.ini file ===
+
+MotdPlugin uses an ini-style file for configuring the messages that should be displayed.
+{{{
+[MsgName]
+title = <message header>
+message = <message text (in one line!)>
+priority = <message priority, for future use>
+valid_until = <expiration date for message>
+repeat = <for future use>
+}}}
+
+The section name (MsgName) has to be unique within the message file.
+Format of the expiration date is (currently) "yyyy-mm-dd HH:MM", next version will have a configurable format.
+
 
 == Example ==
 
-will follow...
+{{{
+[Message1]
+title = System Maintenance
+message = Trac services will be unavailable next Friday from 4pm to 6pm!
+valid_until = 2011-03-04 18:00
+
+[Message2]
+title = New version of xxx has been installed
+valid_until = 2011-03-03 23:59
+}}}
+
+The first example should be selfexplaining. In the second example there is the ''message'' parameter missing! In that case MotdPlugin searches for a file named ''Message2.html'' in the directory specified by ''message_dir'' in trac.ini and displays the complete content of this file.
+
 
 == Recent Changes ==