Changes between Version 14 and Version 15 of QuietPlugin


Ignore:
Timestamp:
Mar 6, 2015, 10:27:42 AM (9 years ago)
Author:
figaro
Comment:

Rearranged paragraphs, cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • QuietPlugin

    v14 v15  
    11[[PageOutline(2-5,Contents,pullout)]]
    22
    3 = Toggle sending Announcer emails =
     3= Toggle sending Announcer emails upon ticket changes
    44
    5 == Description ==
     5== Description
    66
    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 changes the author deems low-value.
     7This 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 changes the author deems low-value.
    88
    99[[Image(quiet.png)]]
    1010
    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 (e.g., via [wiki:BatchModifyPlugin BatchModify] or [wiki:GridModifyPlugin GridModify]).
     11This 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].
    1212
    13 == Configuration ==
    14  1. Install the plugin (after downloading and unzipping):
    15     {{{#!sh
    16     cd quietplugin/0.12
    17     sudo python setup.py install
    18     }}}
    19 
    20     See [http://trac.edgewall.org/wiki/TracPlugins TracPlugins] for more installation details and options.  You'll likely need to restart Trac's web server after installation.
    21 
    22  2. Enable the plugin ''and'' '''disable''' {{{announcer.distributors.mail.EmailDistributor}}} in {{{trac.ini}}}:
    23     {{{#!ini
    24     [components]
    25     announcer.* = enabled
    26     announcer.distributors.mail.EmailDistributor = disabled
    27     quiet.* = enabled
    28     }}}
    29 
    30     You can alternatively use the Trac Web Admin GUI.  The above is because the quietplugin provides its own email distributor which effectively wraps the announcer's !EmailDistributor with an extra check to see if the user entered quiet mode or not.
    31 
    32  3. (Optional) Customize the quiet mode labels in {{{trac.ini}}}:
    33     {{{#!ini
    34     [quiet]
    35     enter_label = Enter Quiet Mode
    36     leave_label = Leave Quiet Mode
    37     }}}
    38 
    39  There are a few additional optional configurations - see below.
    40 
    41  4. Add the {{{QUIET_MODE}}} permission to users or groups as appropriate on the Admin > Permissions page.
    42 
    43 
    44 == Bugs/Feature Requests ==
     13== Bugs/Feature Requests
    4514
    4615Existing bugs and feature requests for QuietPlugin are
     
    5019[http://trac-hacks.org/newticket?component=QuietPlugin&owner=robguttman new ticket].
    5120
    52 == Download ==
     21[[TicketQuery(component=QuietPlugin,group=type,format=progress)]]
     22
     23== Download
    5324
    5425Download the zipped source from [download:quietplugin here].
    5526
    56 == Source ==
     27== Source
    5728
    5829You can check out QuietPlugin from [http://trac-hacks.org/svn/quietplugin here] using Subversion, or [source:quietplugin browse the source] with Trac.
    5930
    60 == Examples ==
     31== Installation
    6132
     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.
     40
     41 2. Restart Trac's web server.
     42
     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    }}}
     51   
     52Alternatively, 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.
     53
     54== Configuration
     55
     56There are the following optional steps for configuration.
     57
     58 1. Customize the quiet mode labels in {{{trac.ini}}}:
     59    {{{#!ini
     60    [quiet]
     61    enter_label = Enter Quiet Mode
     62    leave_label = Leave Quiet Mode
     63    }}}
     64 1. Add the {{{QUIET_MODE}}} permission to users or groups as appropriate on the Admin > Permissions page.
     65
     66== Examples
     67
     68The following are typical scenarios of how this plugin could be used:
    6269 * During planning, I can now avoid barraging people with emails when I move large batches of tickets from one milestone to another using [wiki:BatchModifyPlugin BatchModify].
    6370 * I want to make a minor fix to a ticket's description that doesn't call for yet another email to be sent - enter quiet mode!
     
    6572 * I'm managing dependencies using the [wiki:AnalyzePlugin Analyze plugin] and don't want to inundate the team with emails of its fixes.
    6673
    67 === Trigger quiet mode ===
    68 To help you remember to enter quiet mode for the above use cases (or similar ones), you can create trigger rules on DOM elements that will prompt you to enter or leave quiet mode (if you're not already in that state):
     74=== Trigger quiet mode
     75
     76To help you remember to enter quiet mode for the above use cases or similar ones, you can create trigger rules on DOM elements that will prompt you to enter or leave quiet mode (if you're not already in that state):
    6977{{{#!ini
    7078[quiet]
     
    8997The {{{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.
    9098
    91 == [/log/quietplugin Recent Changes] ==
     99== [/log/quietplugin Recent Changes]
    92100
    93101[[ChangeLog(quietplugin, 3)]]
    94102
    95 == Author/Contributors ==
     103== Author/Contributors
    96104
    97105'''Author:''' [wiki:robguttman] [[BR]]
    98 '''Maintainer:''' [wiki:robguttman] [[BR]]
     106'''Maintainer:''' [[Maintainer]] [[BR]]
    99107'''Contributors:''' rjollos