Changes between Version 15 and Version 16 of QuietPlugin
- Timestamp:
- Jun 17, 2015, 8:43:53 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
QuietPlugin
v15 v16 5 5 == Description 6 6 7 This plugin provides a link (in the contextual nav ) to toggle on and off sending emails for your ticket changes. The purpose is to reduce superfluous emails for changesthe author deems low-value.7 This plugin provides a link (in the contextual navigation menu) to toggle on and off sending emails for your ticket changes. The purpose is to reduce superfluous emails for ticket changes that the author deems low-value. 8 8 9 9 [[Image(quiet.png)]] 10 10 11 This plugin is dependent upon the [wiki:AnnouncerPlugin Announcer plugin] (which must already be installed) and Javascript. The toggling is handled via ajaxso you can remain on the same page and not disrupt any current work. The toggle link will appear on {{{/newticket}}}, {{{/ticket}}}, {{{/query}}}, and {{{/report}}} pages since ticket changes are possible on all of these, eg via [wiki:BatchModifyPlugin BatchModify] or [wiki:GridModifyPlugin GridModify].11 This plugin is dependent upon the [wiki:AnnouncerPlugin Announcer plugin] (which must already be installed) and Javascript. The toggling is handled via AJAX, so you can remain on the same page and not disrupt any current work. The toggle link will appear on {{{/newticket}}}, {{{/ticket}}}, {{{/query}}}, and {{{/report}}} pages since ticket changes are possible on all of these, eg via [wiki:BatchModifyPlugin BatchModify] or [wiki:GridModifyPlugin GridModify]. 12 12 13 13 == Bugs/Feature Requests … … 17 17 18 18 If you have any issues, create a 19 [ http://trac-hacks.org/newticket?component=QuietPlugin&owner=robguttman new ticket].19 [/newticket?component=QuietPlugin new ticket]. 20 20 21 21 [[TicketQuery(component=QuietPlugin,group=type,format=progress)]] … … 32 32 33 33 1. Install the plugin after downloading and unzipping: 34 {{{#!sh 35 cd quietplugin/0.12 36 sudo python setup.py install 37 }}} 38 39 See [http://trac.edgewall.org/wiki/TracPlugins TracPlugins] for more installation details and options. 34 {{{#!sh 35 cd quietplugin/0.12 36 sudo python setup.py install 37 }}} 38 See [http://trac.edgewall.org/wiki/TracPlugins TracPlugins] for more installation details and options. 40 39 41 40 2. Restart Trac's web server. 42 41 43 3. Enable the plugin and disable {{{announcer.distributors.mail.EmailDistributor}}} in {{{trac.ini}}}: 44 45 {{{#!ini 46 [components] 47 announcer.* = enabled 48 announcer.distributors.mail.EmailDistributor = disabled 49 quiet.* = enabled 50 }}} 42 3. Enable the plugin and disable {{{announcer.distributors.mail.EmailDistributor}}} in your `trac.ini` file: 43 {{{#!ini 44 [components] 45 announcer.* = enabled 46 announcer.distributors.mail.EmailDistributor = disabled 47 quiet.* = enabled 48 }}} 51 49 52 Alternatively, you can use the Trac Web Admin GUI. The trac.ini lines above ensure that the quietplugin uses its own email distributor. This distributor effectively wraps the announcer's !EmailDistributor with an extra check to see if the user entered quiet mode or not.50 Alternatively, you can use the Trac Web Admin GUI. The `trac.ini` lines above ensure that the plugin uses its own email distributor. This distributor effectively wraps the announcer's !EmailDistributor with an extra check to see if the user entered quiet mode or not. 53 51 54 52 == Configuration … … 57 55 58 56 1. Customize the quiet mode labels in {{{trac.ini}}}: 59 60 61 62 63 57 {{{#!ini 58 [quiet] 59 enter_label = Enter Quiet Mode 60 leave_label = Leave Quiet Mode 61 }}} 64 62 1. Add the {{{QUIET_MODE}}} permission to users or groups as appropriate on the Admin > Permissions page. 65 63 … … 90 88 }}} 91 89 92 The above example defines three trigger rules explained as follows:90 The above example defines three trigger rules: 93 91 1. When the "Analyze.." button is clicked, prompt to enter quiet mode. 94 92 1. When the "Batch Modify" button is clicked, prompt to enter quiet mode (and prevent the submission - but then they can submit again). 95 93 1. When a ticket's "Submit changes" button is clicked ''and'' there's some text in the comment field, then prompt to enter quiet mode (and prevent the submission - but then they can submit again). 96 94 97 The {{{only_if}}} option can either be just a CSS selector or also include an expected regex value (e.g., the {{{=.+}}} above). If just a selector, then the selector must exist. If also an expected rege value, then the selected item's jQuery {{{val()}}} must match the expected value. 95 The {{{only_if}}} option can either be just a CSS selector or also include an expected regex value (eg the {{{=.+}}} above). 96 * If it is a CSS selector, then the selector must exist. 97 * If it is an expected regex value, then the selected item's jQuery {{{val()}}} must match the expected value. 98 98 99 == [/log/quietplugin Recent Changes]99 == Recent Changes 100 100 101 101 [[ChangeLog(quietplugin, 3)]]