Changes between Version 86 and Version 87 of AnnouncerPlugin
- Timestamp:
- Sep 16, 2016, 10:39:27 PM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
AnnouncerPlugin
v86 v87 28 28 AnnouncerPlugin extensions: QuietPlugin 29 29 30 == Installation and Configuration 30 == Bugs/Feature Requests 31 32 Existing bugs and feature requests for AnnouncerPlugin are [report:9?COMPONENT=AnnouncerPlugin here]. 33 34 If you have any issues, create a [/newticket?component=AnnouncerPlugin new ticket]. 35 36 [[TicketQuery(component=AnnouncerPlugin&group=type,format=progress)]] 37 38 == Download 39 40 Download the zipped source from ~~[export:announcerplugin/0.11 0.11]~~, ~~[export:announcerplugin/0.12 0.12]~~ or [export:announcerplugin/trunk trunk]. 41 42 == Source 43 44 You can check out AnnouncerPlugin from [/svn/announcerplugin here] using Subversion, or [source:announcerplugin browse the source] with Trac. 45 46 '''Note:''' Don't use anything older than `trunk`, or you may lose some of your settings when upgrading. This might, but is not guaranteed to get addressed later on due to a number of rather experimental db schema versions (see comments in [12296] to [12302]). 47 48 == Installation 31 49 32 50 === Prerequisites … … 36 54 Beware: This plugin may break notifications from other Trac plugins that use the default [t:wiki:TracNotification TracNotification] system. A plugin that sends notifications using the !TracNotification system needs to be modified to use the AnnouncerPlugin API. For example, see the aforementioned [AnnouncerPlugin/PluginSupport/FullBlogPlugin FullBlogPlugin]. 37 55 38 === Download39 40 * Download the zipped source from ~~[export:announcerplugin/0.11 0.11]~~, ~~[export:announcerplugin/0.12 0.12]~~ or [export:announcerplugin/trunk trunk].41 * You can check out AnnouncerPlugin from [/svn/announcerplugin here] using Subversion, or [source:announcerplugin browse the source] with Trac.42 43 '''Note:''' Don't use anything older than `trunk`, or you may lose some of your settings when upgrading. This might, but is not guaranteed to get addressed later on due to a number of rather experimental db schema versions (see comments in [12296] to [12302]).44 45 56 After installing AnnouncerPlugin, run `trac-admin /path/to/env upgrade`. This is needed because the plugin adds two tables to the Trac db. The upgrade script allows the plugin to create the needed table or update any older schema. Note that data conversion is still worked on and even might never get fully done for the more ancient revisions. 46 57 … … 49 60 The email distribution is not as stable and complete as the default [t:wiki:TracNotification TracNotifications] yet; there are options that are not yet taken into account, and a lot of stuff particularly focused around codecs that are ignored right now. So while it could still work, there could be errors. 50 61 51 === Installation 62 === Installation steps 52 63 53 64 The easiest way to install AnnouncerPlugin is to use easy_install from the t-h.o SVN repository: … … 65 76 For the newer branches (`0.12`/`trunk`) see the i18n/l10n section below for an '''[#Abouti18nl10nsupport important hint on egg creation]''' that applies to system wide installations as well. 66 77 67 === =Development Environment78 === Development Environment 68 79 69 80 Scroll to the [#DevelopmentVersion DevelopmentVersion] for a quick development environment setup. 70 81 71 == = Central configuration72 73 === =Fast path82 == Configuration 83 84 === Fast path 74 85 75 86 For a system that is basically compatible with your existing setup and allowing minimally invasive wiki features, the following is suggested for `trac.ini`: … … 85 96 If you are still using Trac 0.11, you'll need `smtp_enabled` instead of `email_enabled`. See the TracIni page after installation for additional available options. 86 97 87 === =Save on migration98 === Save on migration 88 99 89 100 If you configured the [t:wiki:TracNotification TracNotification] system before, another approach to configuration is to simply rename the `[notification]` section in your ''trac.ini'' to `[announcer]`. Where possible, the option names are the same. Additional options that may be available are specified above in the modules section. 90 101 91 === =Deep waters102 === Deep waters 92 103 93 104 After you have installed the AnnouncerPlugin, you should carefully evaluate the modules you wish to use and enable them. The simplest method of doing this is through Trac's built in Admin panels. The following recommendations should make decisions easier: … … 136 147 * ''!CarbonCopySubscriber'': If enabled, any name (or address) put into the CC field of a ticket will receive a notification. ''Note'': I recommend you turn this off and instead use the CC field for groups and the Watch This feature for CC's! See below. 137 148 138 [[Image(TicketNotificationPreferences.png )]]149 [[Image(TicketNotificationPreferences.png, border=2)]] 139 150 140 151 ==== Groups … … 152 163 }}} 153 164 154 [[Image(AnnouncerPlugin:Groups-Prefs.jpg )]]165 [[Image(AnnouncerPlugin:Groups-Prefs.jpg, border=2)]] 155 166 156 167 ==== Watches … … 158 169 If ''!WatchSubscriber'' is enabled, then in the context-sensitive navigation portion of each ticket and wiki page, a 'Watch This' link will be provided. Clicking on it will add you to the watch list for the resource and any changes to it will be sent to you. This can be in addition to the CC field if you have !CarbonCopySubscriber enabled, or you can use it to replace the functionality. When a page is already watched, the link changes to 'Unwatch This' 159 170 160 [[Image(AnnouncerPlugin:WatchThis.png )]]171 [[Image(AnnouncerPlugin:WatchThis.png, border=2)]] 161 172 162 173 ==== General Wiki … … 168 179 This is particularly useful in situations where the wiki uses a hierarchical structure; so if you use a pattern such as 'Project*', then 'Project/Plan' and 'Project/Concerns' will all match. 169 180 170 [[Image(AnnouncerPlugin:GeneralWiki.png )]]181 [[Image(AnnouncerPlugin:GeneralWiki.png, border=2)]] 171 182 172 183 ==== Formatters … … 183 194 A list of fields that are always sent at the top of the email notification; Defaults to ''owner, reporter, milestone, priority, severity''. 184 195 185 [[Image(AnnouncerPlugin:HtmlEmail.jpg )]]196 [[Image(AnnouncerPlugin:HtmlEmail.jpg, border=2)]] 186 197 187 198 ==== Distributors … … 224 235 The AnnouncerPlugin has plugins to support the following Trac plugins: 225 236 [[TitleIndex(AnnouncerPlugin/PluginSupport/)]] 226 227 == Bugs/Feature Requests228 229 Existing bugs and feature requests for WantedPagesMacro are [report:9?COMPONENT=AnnouncerPlugin here].230 231 If you have any issues, create a [/newticket?component=AnnouncerPlugin new ticket].232 233 [[TicketQuery(component=AnnouncerPlugin&group=type,format=progress)]]234 237 235 238 == Development Version