Changes between Version 67 and Version 68 of AnnouncerPlugin


Ignore:
Timestamp:
Nov 5, 2012, 12:07:34 AM (2 years ago)
Author:
hasienda
Comment:

announce latest development work, quick updates to immediate correct some outdated information

Legend:

Unmodified
Added
Removed
Modified
  • AnnouncerPlugin

    v67 v68  
    11[[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}}}
    215
    316= Flexible notifications for Trac =
     
    3043=== Download ===
    3144
    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].
    3346 * You can check out AnnouncerPlugin from [/svn/announcerplugin here] using Subversion, or [source:announcerplugin browse the source] with Trac.
    3447
    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
     50After 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.
    3651
    3752As 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.
     
    4560{{{
    4661#!python
    47  easy_install http://trac-hacks.org/svn/announcerplugin/0.11
    48 }}}
    49 
    50 Alternatively, you may download the source via one of the above methods, go into the 0.11 directory and then run:
     62 easy_install http://trac-hacks.org/svn/announcerplugin/trunk
     63}}}
     64
     65Alternatively, you may download the source via one of the above methods, go into the `trunk` directory and then run:
    5166
    5267{{{
     
    5570}}}
    5671
    57 For the new 0.12/trunk branches see the i18n/l10n section below for an '''[#Abouti18nl10nsupport important hint on egg creation]''' that applies to system wide installations as well.
     72For 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.
    5873
    5974==== Development Environment ====
     
    6984#!ini
    7085[components]
    71 announcerplugin.* = enabled
    72 announcerplugin.subscribers.ticket_groups.* = disabled
     86announcer.* = enabled
     87
    7388[announcer]
    7489email_enabled = true
    7590}}}
    7691
    77 If you are using 0.11, changed `email_enabled` to `smtp_enabled`. See the TracIni page after installation for additional available options.
     92If 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.
    7893
    7994==== Save on migration ====
     
    8398==== Deep waters ====
    8499
    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:
     100After 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:
    86101
    87102 * Producers - ''It is recommended you enable all of the producers; they are the source of events that are fed into the !AnnouncementSystem.''
     
    239254
    240255
    241 Want to get started hacking TracAnnouncer?  Here's what'd I do.  Replace vim with the editor of your choice.  Replace git with the SCM of your choice.
     256Want 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.
    242257
    243258 1. Make sure you have virtualenv installed
     
    294309 2. do it yourself (see the [http://trac.edgewall.org/wiki/CookBook/PluginL10N#Dotranslatorswork l10n cookbook page for Trac plugins] for more details).
    295310
    296 You've done a new translation? Superb! Contributing your translation is highly appreciated.[[BR]]
     311You've done a new translation? Superb! Contributing your translation is highly appreciated.
     312
    297313You could send it to the plugin's maintainer or contribute to [TracPluginTranslation Trac plugin l10n project]
    298314via [http://www.transifex.net/projects/p/Trac_Plugin-L10N/ Transifex]:
     
    302318Kindly 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)]]
    303319
    304 Preparing the plugin from source requires the additional step of compiling message catalog files. Walk through:
     320Preparing 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:
    305321{{{
    306322#!sh
    307 cd announcerplugin
     323cd announcer
    308324python ./setup.py egg_info
    309325python ./setup.py compile_catalog -f
    310326python ./setup.py bdist_egg
    311327}}}
    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.
     328Due to a know Trac issue Babel has to be installed prior to Trac, to get it all working as expected.[[BR]]
    315329Again, for more details see the [t:wiki:CookBook/PluginL10N#Compileanduseit l10n cookbook page for Trac plugins].
    316330
     
    353367== Author/Contributors ==
    354368
    355 '''Author:''' [wiki:ixokai] [[BR]]
     369'''Authors:''' [wiki:ixokai], [wiki:doki_pen][[BR]]
    356370'''Maintainer:''' [wiki:hasienda][[BR]]
    357371'''Contributors:''' [wiki:doki_pen], [wiki:ebray], [wiki:jun66j5], [wiki:leorochael], [wiki:mixedpuppy], [wiki:rjollos], [wiki:spcamp], [wiki:slestak]