Changes between Version 82 and Version 83 of AnnouncerPlugin


Ignore:
Timestamp:
Aug 10, 2015, 9:46:17 PM (9 years ago)
Author:
figaro
Comment:

Further cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • AnnouncerPlugin

    v82 v83  
    1212== Description
    1313
    14 The AnnouncerPlugin provides an alternative notification system, that can be used to completely replace the default [t:wiki:TracNotification TracNotification].
     14This plugin provides an alternative notification system, that can be used to replace the default [t:wiki:TracNotification TracNotification].
    1515
    1616=== Improve '''users''' Trac experience
    1717
    18 With growing number of both tickets and wiki pages, keeping yourself up-to-date on recent changes is a time consuming task and easy to miss important information. The bigger your Trac application and user base, the more important is a flexible announcement system. At the very least, it will allow users to receive ''notices about attachments'', and to ''opt-out from receiving messages'' due to the always_notify_(owner|reporter|updater) options. AnnouncerPlugin has ''wiki subscription'' capabilities ^[1]^ and provides each registered user with a large set of options to adapt change notifications to individual demand.
     18With growing number of both tickets and wiki pages, keeping yourself up-to-date on recent changes is a time consuming task and easy to miss important information. The bigger your Trac application and user base, the more important is a flexible announcement system. At the very least, it will allow users to receive ''notices about attachments'', and to ''opt-out from receiving messages'' due to the always_notify_(owner|reporter|updater) options. AnnouncerPlugin has ''wiki subscription'' capabilities and provides each registered user with a large set of options to adapt change notifications to individual demand (see WikiNotificationPlugin for another approach).
    1919
    2020=== Get room for promising '''development'''
    … …  
    2626While sharing all knowledge is a great idea in a perfect world, real-world businesses commonly rely on tight informational restrictions, that customers can rely on. In professional communication cryptographically signed and encrypted email is essential. AnnouncerPlugin will become a building block of this new [t:wiki:TracDev/TrustedTrac Trusted Trac] information management. OpenPGP support is [wiki:AnnouncerPlugin/MessageEncryption on the way].
    2727
    28 ^[1]^ see WikiNotificationPlugin for another approach
    29 
    30 AnnouncerPlugin extensions:
    31  * QuietPlugin
     28AnnouncerPlugin extensions: QuietPlugin
    3229
    3330== Installation and Configuration
    … …  
    3633
    3734 * AnnouncerPlugin will only ever run on Trac 0.11b1 or later.
    38  * While development is done with Trac 0.11 still in mind, i.e. to get full internationalization support you'll want to checkout from 'trunk' branch not before you have [http://babel.edgewall.org Babel] installed on your system.
     35 * While development is done with Trac 0.11 still in mind, ie to get full internationalization support you'll want to checkout from 'trunk' branch not before you have [http://babel.edgewall.org Babel] installed on your system.
    3936 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].
    4037
    … …  
    5047As of r3107 (dubbed v0.2), the AnnouncerPlugin has been working 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.
    5148
    52 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 simply ignored right now. So while it could still work, there could be errors.
     49The 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.
    5350
    5451=== Installation
    … …  
    9087==== Save on migration
    9188
    92 If you configured the [t:wiki:TracNotification TracNotification] system before, another approach to Announcer 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.
     89If 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.
    9390
    9491==== Deep waters
    … …  
    127124=== Modular per-user configuration
    128125
    129 The plugin itself is very modular, and exactly what features you have will depend on which modules you enable. You select modules in the 'Plugins' page of the 'Admin' section of your Trac as stated the [#Centralconfiguration previous section].
     126The plugin itself is very modular, and exactly what features you have depends on which modules you enable. You select modules in the 'Plugins' page of the 'Admin' section of your Trac as stated the [#Centralconfiguration previous section].
    130127
    131128==== Legacy Modules
    … …  
    165162==== General Wiki
    166163
    167 If you would like to receive more general notice of wiki changes, you can use the ''!GeneralWikiSubscriber''. With it you may specify any number of patterns, and if they match a wiki page name, you'll receive a notice if that page is created, edited, deleted, or such.
     164If you would like to receive more general notice of wiki changes, you can use the ''!GeneralWikiSubscriber''. With it you may specify any number of patterns, and if they match a wiki page name, you'll receive a notice if that page is created, edited or deleted.
    168165
    169166In particular, you may use a pattern of '*' and you'll see any wiki changes that happen on the site.
    … …  
    179176The HTML formatter also sends out a plain text alternative for those email clients that may not support HTML email.
    180177
    181 Ticket change messages are built from Genshi text template `ticket_email_plaintext.txt`. Additionally the following trac.ini options are available to configure the ticket formatter:
     178Ticket change messages are built from Genshi text template `ticket_email_plaintext.txt`. Additionally the following `trac.ini` options are available to configure the ticket formatter:
    182179
    183180 ticket_email_subject::
    … …  
    190187==== Distributors
    191188
    192 Although the goal is to allow many kinds of distribution, at this point we're only delivering to email addresses. The ''!EmailDistributor'' uses the same options as the old trac notification, just (as above) in the ''announcer'' section and not the ''notification'' section.
     189Although the goal is to allow many kinds of distribution, at this point we're only delivering to email addresses. The ''!EmailDistributor'' uses the same options as the old Trac notification, just (as above) in the ''announcer'' section and not the ''notification'' section.
    193190
    194191There are a few additional ones:
    … …  
    201198Currently, the following resolvers can be configured to map usernames to email addresses:
    202199
    203  * ''!DefaultDomainEmailResolver'': This will simply blindly append the domain specified in [announcer] smtp_default_domain onto the end of the username.
     200 * ''!DefaultDomainEmailResolver'': This will blindly append the domain specified in [announcer] smtp_default_domain onto the end of the username.
    204201 * ''!SpecifiedEmailResolver'': This will allow the user to override the email address in Trac (or anywhere else) to demand all email be sent to a certain address specified in their user preferences (and separate from Trac's normal address)
    205202 * ''!SessionEmailResolver'': This will retrieve the email address associated with the username's Trac session.
    … …  
    273270}}}
    274271 1. Setup a virtualenv and install everything in it:
    275 {{{
    276 #!sh
     272{{{#!sh
    277273~/src/th-announcer $ cd
    278274~ $ virtualenv th-announcer
    … …  
    313309python ./setup.py bdist_egg
    314310}}}
    315 Due to a know Trac issue Babel has to be installed prior to Trac, to get it all working as expected.[[BR]]
    316 Again, for more details see the [t:wiki:CookBook/PluginL10N#Compileanduseit l10n cookbook page for Trac plugins].
     311
     312Due to a known Trac issue Babel has to be installed prior to Trac, to get it all working as expected. For more details see the [t:wiki:CookBook/PluginL10N#Compileanduseit l10n cookbook page for Trac plugins].
    317313
    318314=== Email Configuration