Changes between Version 67 and Version 68 of AnnouncerPlugin
- Timestamp:
- Nov 4, 2012, 11:07:34 PM (11 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
AnnouncerPlugin
v67 v68 1 1 [[PageOutline(2-5,Contents,pullout)]] 2 3 {{{ 4 #!NewsFlash 5 = News = 6 2012-11-04:: Major db code changes, '''requires a Trac environment upgrade''' `announcer-1.0dev` to address many pending issue. 7 2012-10-20:: Set the stage: On the way to `announcer-1.0` now, that should be compatible for Trac 0.11, but also will work up to current stable Trac 1.0. 8 9 = !ToDo = 10 * "downgrade db API code for compatibility with Trac 0.11 (currently only 0.12)" 11 * fix more bugs 12 * document current subscription API 13 * release `announcer-1.0` 14 }}} 2 15 3 16 = Flexible notifications for Trac = … … 30 43 === Download === 31 44 32 * Download the zipped source from [download:announcerplugin/0.11 0.11], [download:announcerplugin/0.12 0.12]or [download:announcerplugin/trunk trunk].45 * Download the zipped source from ~~[download:announcerplugin/0.11 0.11]~~, ~~[download:announcerplugin/0.12 0.12]~~ or [download:announcerplugin/trunk trunk]. 33 46 * You can check out AnnouncerPlugin from [/svn/announcerplugin here] using Subversion, or [source:announcerplugin browse the source] with Trac. 34 47 35 After installing AnnouncerPlugin, be sure to run `trac-admin /path/to/env upgrade`. This is needed because the plugin adds a table to the db. The upgrade script allows the plugin to create the needed table. 48 '''Note:''' Don't use anything older than current `trunk`, or be prepared to at least loose some/all 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] for details.) 49 50 After installing AnnouncerPlugin, be sure to 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 though, that data conversion is still worked on and even might never get fully done for the more ancient revisions. 36 51 37 52 As of r3107 (dubbed v0.2), the AnnouncerPlugin has been working (for me!) in a basic way in our corporate Trac installation. This includes all the mentioned modules above, in particular the notification of Wiki additions/changes/deletions to anyone interested, 'watching' interesting resources, HTML ticket notifications, and such. … … 45 60 {{{ 46 61 #!python 47 easy_install http://trac-hacks.org/svn/announcerplugin/ 0.1148 }}} 49 50 Alternatively, you may download the source via one of the above methods, go into the 0.11directory and then run:62 easy_install http://trac-hacks.org/svn/announcerplugin/trunk 63 }}} 64 65 Alternatively, you may download the source via one of the above methods, go into the `trunk` directory and then run: 51 66 52 67 {{{ … … 55 70 }}} 56 71 57 For the new 0.12/trunk branchessee the i18n/l10n section below for an '''[#Abouti18nl10nsupport important hint on egg creation]''' that applies to system wide installations as well.72 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. 58 73 59 74 ==== Development Environment ==== … … 69 84 #!ini 70 85 [components] 71 announcer plugin.* = enabled72 announcerplugin.subscribers.ticket_groups.* = disabled 86 announcer.* = enabled 87 73 88 [announcer] 74 89 email_enabled = true 75 90 }}} 76 91 77 If you are using 0.11, changed `email_enabled` to `smtp_enabled`. See the TracIni page after installation for additional available options.92 If you are still using `0.11`, you'll need `smtp_enabled` instead of `email_enabled`. See the TracIni page after installation for additional available options. 78 93 79 94 ==== Save on migration ==== … … 83 98 ==== Deep waters ==== 84 99 85 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 0.11's built in Admin panels. The following recommendations should make decisions easier:100 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: 86 101 87 102 * Producers - ''It is recommended you enable all of the producers; they are the source of events that are fed into the !AnnouncementSystem.'' … … 239 254 240 255 241 Want to get started hacking TracAnnouncer? Here's what 'd Ido. Replace vim with the editor of your choice. Replace git with the SCM of your choice.256 Want to get started hacking TracAnnouncer? Here's what I would do. Replace vim with the editor of your choice. Replace git with the SCM of your choice. 242 257 243 258 1. Make sure you have virtualenv installed … … 294 309 2. do it yourself (see the [http://trac.edgewall.org/wiki/CookBook/PluginL10N#Dotranslatorswork l10n cookbook page for Trac plugins] for more details). 295 310 296 You've done a new translation? Superb! Contributing your translation is highly appreciated.[[BR]] 311 You've done a new translation? Superb! Contributing your translation is highly appreciated. 312 297 313 You could send it to the plugin's maintainer or contribute to [TracPluginTranslation Trac plugin l10n project] 298 314 via [http://www.transifex.net/projects/p/Trac_Plugin-L10N/ Transifex]: … … 302 318 Kindly provided by [[Image(http://sw.transifex.net/2/static/charts/images/tx-logo-micro.png, link=http://www.transifex.net/, title=the open translation platform, valign=bottom)]] 303 319 304 Preparing the plugin from source requires the additional step of compiling message catalog files. Walk through:320 Preparing the plugin from source requires '''no additional steps''' for compiling message catalog files. Only to include translations marked as `# fuzzy` by the translator, you'll want to do a manual message catalog compilation with the extra `-f` argument before packaging: 305 321 {{{ 306 322 #!sh 307 cd announcer plugin323 cd announcer 308 324 python ./setup.py egg_info 309 325 python ./setup.py compile_catalog -f 310 326 python ./setup.py bdist_egg 311 327 }}} 312 If you missed the 3rd step, you'll get an error in the 4th step complaining about missing `locale` directory. 313 This is just a side-effect, because there are no complied message catalogs for inclusion into Python egg, hence the whole path is missing.[[BR]] 314 To exclude translations marked as `# fuzzy` by the translator, you'll want to omit the extra `-f` argument to message catalog compilation. 328 Due to a know Trac issue Babel has to be installed prior to Trac, to get it all working as expected.[[BR]] 315 329 Again, for more details see the [t:wiki:CookBook/PluginL10N#Compileanduseit l10n cookbook page for Trac plugins]. 316 330 … … 353 367 == Author/Contributors == 354 368 355 '''Author :''' [wiki:ixokai][[BR]]369 '''Authors:''' [wiki:ixokai], [wiki:doki_pen][[BR]] 356 370 '''Maintainer:''' [wiki:hasienda][[BR]] 357 371 '''Contributors:''' [wiki:doki_pen], [wiki:ebray], [wiki:jun66j5], [wiki:leorochael], [wiki:mixedpuppy], [wiki:rjollos], [wiki:spcamp], [wiki:slestak]