Changes between Version 30 and Version 31 of TimeEstimationUserManual


Ignore:
Timestamp:
May 13, 2022, 6:52:52 AM (6 weeks ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • TimeEstimationUserManual

    v30 v31  
    88== Abstract Design Goal
    99
    10 My goal in writing this plugin was to use as much of the existing structure as possible, thereby not needing to add extra structure that might make maintainability difficult. The largest downside to this is that there is no way to attach more permissions to anything.
     10The original design goal of this plugin was to use as much of the existing structure as possible and without adding extra structures that might make maintainability difficult. The largest downside to this is that there is no way to add more permissions to this plugin differentiated by feature.
    1111
    1212== Custom Ticket Fields
    1313
    14 In adhering to the design goal, rather than creating a new ticket interface, I created some custom fields and a small daemon to watch over them.
     14In adhering to the design goal, rather than creating a new ticket interface, some custom fields and a small daemon to watch over them were created.
    1515
    1616=== Fields
     
    2828== Billing / Management Page / Time Reports
    2929
    30 This page provide a small interface for querying the tickets and adding a bill date at the current time. This interface gives you links that match the interface to open any of the given reports, by providing it the correct set of input parameters.
     30This page provides a small interface for querying the tickets and adding a bill date at the current time. This interface gives you links that match the interface to open any of the given reports, by providing it the correct set of input parameters.
    3131
    3232The direct url is '/Billing'.
     
    3434=== No Permissions Branch
    3535
    36 The 'Management' button should be in the main title bar. It is possible that if you are viewing at a low resolution, it is pushed off the edge of the screen. Also if you are not logged in with REPORT_VIEW permissions, then it will not show that button.
     36The 'Management' button should be in the main title bar. It is possible that if you are viewing at a low resolution, it is pushed off the edge of the screen. Also if you are not logged in with `REPORT_VIEW` permissions, then it will not show that button.
    3737
    3838=== Permissions Branch
    3939
    40 The 'Time Reports' button should be in the main title bar. The user sees this depending on whether (s)he has the TIME_VIEW permission.
    41  * [https://trac-hacks.org/ticket/10318 Email Notifications are currently unaffected]
     40The 'Time Reports' button should be in the main title bar. The user sees this depending on whether (s)he has the `TIME_VIEW` permission.
     41Note that Email notifications are currently unaffected, see #10318.
    4242
    4343=== Set Bill Date
     
    8585Remember to fill in the @reportID of the report you want to insert, and to select the insert statement for the section of your choice.
    8686
    87 '''Note''': @uuid is a globally unique identifier created via a tool such as {{{uuidgen}}} on Linux or various [http://www.famkruithof.net/uuid/uuidgen online tools]. It is used in this plugin to provide programmatic reference to specific reports such that they can be upgraded successfully on future revisions of the plugin.
     87'''Note''': @uuid is a globally unique identifier created via a tool such as {{{uuidgen}}} on Linux or [http://www.famkruithof.net/uuid/uuidgen online tools]. It is used in this plugin to provide programmatic reference to specific reports such that they can be upgraded successfully on future revisions of the plugin.
    8888
    8989=== Removing a Report
     
    109109A branch of this plugin was sponsored by [http://www.obsidiansoft.com/ Obsidian Software], so that it would support per field permissions. 
    110110
    111  * [https://trac-hacks.org/ticket/10318 Email Notifications are currently unaffected]
     111Note that Email notifications are currently unaffected, see #10318.
    112112
    113113This is accomplished with Genshi 5 stream filters in Trac 0.11. This code draws from the [https://trac-hacks.org/wiki/BlackMagicTicketTweaksPlugin BlackMagicTicketTweaksPlugin].
     
    140140}}}
    141141
    142 It also adds an "Internal" checkbox which allows you to set a ticket as internal. For this policy to work correctly you need to add a line to the trac section of the configuration file telling it which permission policies to use. The setup will attempt to put this line of configuration in place. The permission that looks at currently is 'TIME_ADMIN'. To change that group set the internalgroup of the ticket section in the `trac.ini` file as follows:
     142It also adds an "Internal" checkbox which allows you to set a ticket as internal. For this policy to work correctly you need to add a line to the `trac` section of the `trac.ini` configuration file telling it which permission policies to use. The setup will attempt to put this line of configuration in place. The permission that looks at currently is `TIME_ADMIN`. To change that group set the `internalgroup` of the ticket section in the `trac.ini` file as follows:
    143143
    144144{{{#!ini