Changes between Initial Version and Version 1 of WikiNotificationPlugin

Timestamp:

Sep 30, 2006, 6:32:35 AM (18 years ago)

Author:

Pedro Algarvio, aka, s0undt3ch

Comment:

First version of plugin info page

WikiNotificationPlugin

@@ +1 @@
+{{{
+#!text/x-rst
+==============================
+ Trac Wiki Notification Plugin
+==============================
+
+Trac Wiki Notification is a pluggin that allows users(even anonymous,
+as long as email is set) to select the wiki pages that they wish to
+be notified(by email) when a change occurs on it.
+
+You can find more info on the
+`Trac WikiNotification <http://wikinotification.ufsoft.org/>`_ site where bugs and new
+feature requests should go to.
+
+Enabling the Plugin
+-------------------
+It's as simple as::
+
+   [componentes]
+   wikinotification.* = enabled
+
+Available Config Options
+------------------------
+These are the options available to include on your *trac.ini*.
+
+=====================  ====================  ================================
+ **Config Setting**     **Default Value**     **Explanation**
+---------------------  --------------------  --------------------------------
+*redirect_time*        5 (in secconds)       The default secconds a redirect should take when
+                                             watching/un-watching a wiki page.
+                                             This value is also definable per user, ie, user
+                                             is able to configure this, of course for himself.
+---------------------  --------------------  --------------------------------
+*smtp_always_bcc*      *empty*               Email address(es) to always send notifications to,
+                                             addresses do not appear publicly (Bcc:).
+---------------------  --------------------  --------------------------------
+*smtp_always_cc*       *empty*               Email address(es) to always send notifications to,
+                                             addresses can be see by all recipients (Cc:).
+---------------------  --------------------  --------------------------------
+*smtp_from*            trac.wiki\@localhost  Sender address to use in notification emails.
+---------------------  --------------------  --------------------------------
+*use_public_cc*        False                 Recipients can see email addresses of other
+                                             CC'ed recipients. If this option is
+                                             disabled(the default), recipients are put on BCC.
+=====================  ====================  ================================
+
+
+Download and Installation
+-------------------------
+
+Trac WikiNotification can be installed with `Easy Install
+<http://peak.telecommunity.com/DevCenter/EasyInstall>`_ by typing::
+
+    > easy_install TracWikiNotification
+}}}
+