Changes between Version 86 and Version 87 of AnnouncerPlugin


Ignore:
Timestamp:
Sep 16, 2016, 10:39:27 PM (8 years ago)
Author:
figaro
Comment:

Moved sections to maintain consistency

Legend:

Unmodified
Added
Removed
Modified
  • AnnouncerPlugin

    v86 v87  
    2828AnnouncerPlugin extensions: QuietPlugin
    2929
    30 == Installation and Configuration
     30== Bugs/Feature Requests
     31
     32Existing bugs and feature requests for AnnouncerPlugin are [report:9?COMPONENT=AnnouncerPlugin here].
     33
     34If you have any issues, create a [/newticket?component=AnnouncerPlugin new ticket].
     35
     36[[TicketQuery(component=AnnouncerPlugin&group=type,format=progress)]]
     37
     38== Download
     39
     40Download 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
     44You 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
    3149
    3250=== Prerequisites
     
    3654 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].
    3755
    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  * 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 
    4556After 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.
    4657
     
    4960The 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.
    5061
    51 === Installation
     62=== Installation steps
    5263
    5364The easiest way to install AnnouncerPlugin is to use easy_install from the t-h.o SVN repository:
     
    6576For 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.
    6677
    67 ==== Development Environment
     78=== Development Environment
    6879
    6980Scroll to the [#DevelopmentVersion DevelopmentVersion] for a quick development environment setup.
    7081
    71 === Central configuration
    72 
    73 ==== Fast path
     82== Configuration
     83
     84=== Fast path
    7485
    7586For a system that is basically compatible with your existing setup and allowing minimally invasive wiki features, the following is suggested for `trac.ini`:
     
    8596If 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.
    8697
    87 ==== Save on migration
     98=== Save on migration
    8899
    89100If 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.
    90101
    91 ==== Deep waters
     102=== Deep waters
    92103
    93104After 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:
     
    136147 * ''!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.
    137148
    138 [[Image(TicketNotificationPreferences.png)]]
     149[[Image(TicketNotificationPreferences.png, border=2)]]
    139150
    140151==== Groups
     
    152163}}}
    153164
    154 [[Image(AnnouncerPlugin:Groups-Prefs.jpg)]]
     165[[Image(AnnouncerPlugin:Groups-Prefs.jpg, border=2)]]
    155166
    156167==== Watches
     
    158169If ''!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'
    159170
    160 [[Image(AnnouncerPlugin:WatchThis.png)]]
     171[[Image(AnnouncerPlugin:WatchThis.png, border=2)]]
    161172
    162173==== General Wiki
     
    168179This 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.
    169180
    170 [[Image(AnnouncerPlugin:GeneralWiki.png)]]
     181[[Image(AnnouncerPlugin:GeneralWiki.png, border=2)]]
    171182
    172183==== Formatters
     
    183194  A list of fields that are always sent at the top of the email notification; Defaults to ''owner, reporter, milestone, priority, severity''.
    184195
    185 [[Image(AnnouncerPlugin:HtmlEmail.jpg)]]
     196[[Image(AnnouncerPlugin:HtmlEmail.jpg, border=2)]]
    186197
    187198==== Distributors
     
    224235The AnnouncerPlugin has plugins to support the following Trac plugins:
    225236[[TitleIndex(AnnouncerPlugin/PluginSupport/)]]
    226 
    227 == Bugs/Feature Requests
    228 
    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)]]
    234237
    235238== Development Version