Changes between Version 9 and Version 10 of WikiNotificationPlugin
- Timestamp:
- Jan 14, 2008, 2:36:39 PM (16 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiNotificationPlugin
v9 v10 5 5 ============================== 6 6 7 Trac Wiki Notificationis a plugin that allows users(even anonymous,7 Trac WikiNotification_ is a plugin that allows users(even anonymous, 8 8 as long as email is set) to select the wiki pages that they wish to 9 9 be notified(by email) when a change occurs on it. 10 10 11 You can find more info on the 12 `Trac WikiNotification <http://wikinotification.ufsoft.org/>`_ site where bugs and new 11 **Note**: The user updating the wiki page won't be notified about his own 12 changes. 13 14 You can find more info on the trac WikiNotification_ site where bugs and new 13 15 feature requests should go to. 14 16 … … 24 26 ctxtnavadd.* = enabled 25 27 26 27 Available Config Options 28 ------------------------ 29 These are the options available to include on your *trac.ini*.28 Available Configuration Options 29 ------------------------------- 30 These are the options available to include on your ``trac.ini`` under 31 ``wiki-notification``. 30 32 31 33 ===================== ==================== ================================ 32 34 **Config Setting** **Default Value** **Explanation** 33 35 --------------------- -------------------- -------------------------------- 34 *redirect_time* 5 (in seconds) The default seconds a redirect should take when 36 *redirect_time* 5 (in seconds) The default seconds a redirect 37 should take when 35 38 watching/un-watching a wiki page. 36 This value is also definable per user, ie, user 37 is able to configure this, of course for himself. 39 This value is also definable per 40 user, ie, user is able to 41 configure this, of course for 42 himself. 38 43 --------------------- -------------------- -------------------------------- 39 *smtp_always_bcc* *empty* Email address(es) to always send notifications to, 40 addresses do not appear publicly (Bcc:). 44 *smtp_always_bcc* *empty* Email address(es) to always send 45 notifications to, addresses do 46 not appear publicly (Bcc:). 41 47 --------------------- -------------------- -------------------------------- 42 *smtp_always_cc* *empty* Email address(es) to always send notifications to, 43 addresses can be see by all recipients (Cc:). 48 *smtp_always_cc* *empty* Email address(es) to always send 49 notifications to, addresses can 50 be seen by all recipients (Cc:). 44 51 --------------------- -------------------- -------------------------------- 45 *smtp_from* trac.wiki\@localhost Sender address to use in notification emails. 52 *smtp_from* trac.wiki\@localhost Sender address to use in 53 notification emails. 46 54 --------------------- -------------------- -------------------------------- 47 *use_public_cc* False Recipients can see email addresses of other 48 CC'ed recipients. If this option is 49 disabled(the default), recipients are put on BCC. 55 *use_public_cc* False Recipients can see email 56 addresses of other CC'ed 57 recipients. If this option is 58 disabled(the default), recipients 59 are put on BCC. 50 60 ===================== ==================== ================================ 61 62 If you want to override these settings then you can include it like the 63 following example:: 64 65 [wiki-notification] 66 redirect_time = 5 67 smtp_always_bcc = 68 smtp_always_cc = 69 smtp_from = trac.wiki@localhost 70 use_public_cc = false 71 72 73 **Note**: For an up-to-date version of this info please `read this`_. 51 74 52 75 … … 54 77 ------------------------- 55 78 56 Trac WikiNotification can be installed with `Easy Install 57 <http://peak.telecommunity.com/DevCenter/EasyInstall>`_ by typing:: 79 Trac WikiNotification can be installed with `Easy Install`_ by typing:: 58 80 59 81 > easy_install TracWikiNotification 82 60 83 61 84 Trac 0.11 support 62 85 ~~~~~~~~~~~~~~~~~ 63 86 64 As of time of this writing (Jan 5 2008), 0.11 support available only in trunk version (svn). Which is natural, since Trac 0.11 is still in beta as well. You won't need ``ctxnavadd`` no more. To install this development version type:: 87 As of time of this writing (Jan 5 2008), 0.11 support available only in trunk 88 version (svn). Which is natural, since Trac 0.11 is still in beta as well. 89 You won't need ``ctxnavadd`` no more. 90 91 To install this development version type:: 65 92 66 93 > easy_install http://wikinotification.ufsoft.org/svn/trunk 67 94 95 Aditional Notes(from user input) 96 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 68 97 69 Some notes for the *noobs* amongst us: 70 71 1. ``easy_install`` is run from the command line (on Linux) not from within Python. 72 73 2. After installing any plugin for Trac you'll need to restart Apache to see it (not all changes to ``trac.ini`` require a restart but adding a plugin does). 74 75 3. Make sure to add the new plugin to ``trac.ini``: 76 77 :: 78 79 [components] 80 wikinotification.* = enabled 98 * ``easy_install`` is run from the command line (on Linux) not from within 99 Python. 81 100 82 101 83 4. Also should be noted that the trac.ini configuration for the wiki notification should look something like: 102 * After installing any plugin for Trac you'll need to restart Apache to see 103 it (not all changes to trac.ini require a restart but adding a plugin does). 84 104 85 ::86 105 87 [wiki-notification] 88 smtp_always_cc = someone@somedomain 89 smtp_from = trac.wiki@localhost 106 * Make sure to add the new plugin to ``trac.ini`` :: 90 107 91 5. **Another note**: a user will never get a notice of his/her own wiki modification (which is a little tricky when testing the plugin :)) 108 [components] 109 wikinotification.* = enabled 110 111 112 * Also should be noted that the ``trac.ini`` configuration for the wiki 113 notification should look something like:: 114 115 [wiki-notification] 116 smtp_always_cc = someone@somedomain 117 smtp_from = trac.wiki@localhost 118 119 120 * **Another note**: a user will never get a notice of his/her own wiki 121 modification (which is a little tricky when testing the plugin :)) 122 123 124 .. _read this: http://wikinotification.ufsoft.org/browser/trunk/README 125 .. _Easy Install: http://peak.telecommunity.com/DevCenter/EasyInstall 126 .. _WikiNotification: http://wikinotification.ufsoft.org 127 }}}