Changes between Version 15 and Version 16 of QuietPlugin


Ignore:
Timestamp:
Jun 17, 2015, 8:43:53 PM (9 years ago)
Author:
figaro
Comment:

More cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • QuietPlugin

    v15 v16  
    55== 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 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.
    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, eg 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
    1313== Bugs/Feature Requests
    … …  
    1717
    1818If you have any issues, create a
    19 [http://trac-hacks.org/newticket?component=QuietPlugin&owner=robguttman new ticket].
     19[/newticket?component=QuietPlugin new ticket].
    2020
    2121[[TicketQuery(component=QuietPlugin,group=type,format=progress)]]
    … …  
    3232
    3333 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
     35cd quietplugin/0.12
     36sudo python setup.py install
     37}}}
     38 See [http://trac.edgewall.org/wiki/TracPlugins TracPlugins] for more installation details and options.
    4039
    4140 2. Restart Trac's web server.
    4241
    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]
     45announcer.* = enabled
     46announcer.distributors.mail.EmailDistributor = disabled
     47quiet.* = enabled
     48}}}
    5149   
    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.
     50Alternatively, 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.
    5351
    5452== Configuration
    … …  
    5755
    5856 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     }}}
     57 {{{#!ini
     58[quiet]
     59enter_label = Enter Quiet Mode
     60leave_label = Leave Quiet Mode
     61}}}
    6462 1. Add the {{{QUIET_MODE}}} permission to users or groups as appropriate on the Admin > Permissions page.
    6563
    … …  
    9088}}}
    9189
    92 The above example defines three trigger rules explained as follows:
     90The above example defines three trigger rules:
    9391 1. When the "Analyze.." button is clicked, prompt to enter quiet mode.
    9492 1. When the "Batch Modify" button is clicked, prompt to enter quiet mode (and prevent the submission - but then they can submit again).
    9593 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).
    9694
    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.
     95The {{{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.
    9898
    99 == [/log/quietplugin Recent Changes]
     99== Recent Changes
    100100
    101101[[ChangeLog(quietplugin, 3)]]