Changes between Version 39 and Version 40 of TracHoursPlugin


Ignore:
Timestamp:
Sep 1, 2010 12:21:30 AM (4 years ago)
Author:
Havok
Comment:

Cleaning up installing information

Legend:

Unmodified
Added
Removed
Modified
  • TracHoursPlugin

    v39 v40  
    1 = track hours spent on tickets = 
     1= TracHoursPlugin - Track hours spent on tickets = 
    22 
    33[[TOC]] 
     
    55== Goals of TracHoursPlugin == 
    66 
    7 The goal of this plugin is to help keep track of hours worked on 
    8 tickets.  TracHoursPlugin is an alternative 
    9 [http://trac-hacks.org/wiki/TimingAndEstimationPlugin TimingAndEstimationPlugin], but with a different approach: 
     7The goal of this plugin is to help keep track of hours worked on tickets.  TracHoursPlugin is an alternative to [http://trac-hacks.org/wiki/TimingAndEstimationPlugin TimingAndEstimationPlugin], but with a different approach: 
    108 
    11  * instead of adding hours only via ticket fields, there is a separate view for managing ticket hours. `/hours/<ticket number>` displays the accrued hours for a particular ticket with a timeline-like view, but should also allow adding of new hours (by default, on "today", but this should be changeable via dropdown menus for day, month, year, etc), editing previously entered hours (amount, date, description) and deleting previously alloted hours if you have the appropriate permissions (`TICKET_ADD_HOURS` for your own hours, `TRAC_ADMIN` for the hours of others).    
    12  * a management and query view is at `/hours`.  This view displays the hours for all tickets for a given time period (last week, by default) in a way that combines the query interface for querying tickets and the timeline display for hours on the tickets in the time period. Query filters are available to find hours for people, hours for tickets of a certain component, etc.    
    13  * hours are uniquely assigned to tickets and people 
    14  * hours may have a description, which should be displayed in the applicable views;  if a description is provided, the hours and description are logged to ticket comments 
    15  * Tickets have links to `/hours/<ticket number>` as the total hours field so that a user can add and view hours for the ticket 
     9 * Instead of adding hours only via ticket fields, there is a separate view for managing ticket hours. `/hours/<ticket number>` displays the accrued hours for a particular ticket with a timeline-like view, but should also allow adding of new hours (by default, on "today", but this should be changeable via dropdown menus for day, month, year, etc), editing previously entered hours (amount, date, description) and deleting previously alloted hours if you have the appropriate permissions (`TICKET_ADD_HOURS` for your own hours, `TRAC_ADMIN` for the hours of others). 
     10 * A management and query view is at `/hours`.  This view displays the hours for all tickets for a given time period (last week, by default) in a way that combines the query interface for querying tickets and the timeline display for hours on the tickets in the time period. Query filters are available to find hours for people, hours for tickets of a certain component, etc. 
     11 * Hours are uniquely assigned to tickets and people. 
     12 * Hours may have a description, which should be displayed in the applicable views;  if a description is provided, the hours and description are logged to ticket comments. 
     13 * Tickets have links to `/hours/<ticket number>` as the total hours field so that a user can add and view hours for the ticket. 
    1614 
    1715Hour tracking and estimation is most useful when the following questions can be answered: 
     
    2220 * How much time is a developer committed to over the next time period? 
    2321 
    24 If we put hour estimates on tickets, assign tickets to people, associate 
    25 tickets with milestones, and give milestones due dates, !TracHours can generate reports to answer those questions. 
     22If we put hour estimates on tickets, assign tickets to people, associate tickets with milestones, and give milestones due dates, !TracHours can generate reports to answer those questions. 
    2623 
    27 For other trac time-tracking solutions, see 
    28 http://trac.edgewall.org/wiki/TimeTracking 
     24For other Trac time-tracking solutions, see http://trac.edgewall.org/wiki/TimeTracking 
    2925 
    3026== Components == 
     
    3531 
    3632`TracHoursPlugin` is the core component of !TracHours. 
    37  * API function 
    38  * Navigation bar provider 
    39  * Query view for `/hours` 
     33 
     34 * API function. 
     35 * Navigation bar provider. 
     36 * Query view for `/hours`. 
    4037 * Ticket hours view for `/hours/<ticket number>` 
    4138 * Stream filter for checking and rendering of estimated hours and total hours fields for tickets 
     
    6461=== [source:trachoursplugin/0.11/trachours/multiproject.py MultiprojectHours] === 
    6562 
    66 The TracHoursPlugin exports RSS from the `/hours` handler.  This has 
    67 been utilized in consumption to provide hours reports across projects 
    68 sharing the same parent directory.  If `trachours.multiproject` is 
    69 enabled, then `/hours/multiproject` will become a handler front-ending 
    70 hours reports throughout the project and a link to this will appear on 
    71 the `/hours` page to `/hours/multiproject`. 
     63The TracHoursPlugin exports RSS from the `/hours` handler.  This has been utilized in consumption to provide hours reports across projects sharing the same parent directory.  If `trachours.multiproject` is enabled, then `/hours/multiproject` will become a handler front-ending hours reports throughout the project and a link to this will appear on the `/hours` page to `/hours/multiproject`. 
    7264 
    73 The multiproject report breaks down hours by project and worker giving 
    74 row and column totals.  If there are no hours for a project then that 
    75 project will not be shown. 
     65The multiproject report breaks down hours by project and worker giving row and column totals. If there are no hours for a project then that project will not be shown. 
    7666 
    7767[[Image(multiprojecthours.png, border=1)]] 
     
    8171The TracHoursHowto offers a guide to the features of the TracHoursPlugin and how to use them. 
    8272 
    83  
    8473== Installing and Enabling !TracHours == 
    8574 
    86  ''NEW & HANDY!!''[[BR]] 
    87 '''Updated Missing Module and modifed setup file'''  
     75TracHoursPlugin requires the following components: 
    8876 
    89    * !FeederParser[http://code.google.com/p/feedparser/downloads/list] ,available as attachment 
    90    * !DateUtil[http://pypi.python.org/pypi/python-dateutil/1.4.1]  ,request you to download from the net and create .egg  
    91    * TracSQLHelper                                                 ,available as attachment 
    92    * TracHoursPlugin(modified)                                     ,available as attachment 
    93 Please install the plugins either the WebAdmin Way or the Trac.ini way [[BR]] 
    94 Once the Plugin is installed you need to upgrade your database and restart you server [[BR]] 
     77 * ComponentDependencyPlugin 
     78 * TicketSidebarProviderPlugin 
     79 * TracSqlHelperScript 
    9580 
     81You need to install them before installing TracHoursPlugin. See [http://trac.edgewall.org/wiki/TracPlugins#InstallingaTracPlugin InstallingaTracPlugin] for more information on installing plugins. Additionally, you will require on your server: 
    9682 
    97    
    98 {{{ 
     83 * !DateUtil, avalaible [http://pypi.python.org/pypi/python-dateutil/1.4.1 here] or package ''python-dateutil'' on Debian based systems. 
     84 * !FeedParser, avalaible [http://code.google.com/p/feedparser/downloads/list here] or package ''python-feedparser'' on Debian based systems. 
    9985 
    100 }}} 
    101 TracHoursPlugin is enabled like any other trac plugin: 
     86Now, TracHoursPlugin is enabled like any other trac plugin: 
    10287 
    103  * download and install the plugin; see plugin installation instructions at http://trac.edgewall.org/wiki/TracPlugins#InstallingaTracPlugin 
     88Download the [download:trachoursplugin zipped source], check out [/svn/trachoursplugin/0.11 using Subversion], or [source:trachoursplugin browse the source] with Trac. 
    10489 
    105  * enable the plugin.  Use either the webadmin interface or add the following lines to the {{{trac.ini}}} file: 
    106  
     90 * Download and install the plugin. 
     91 * Enable the plugin. Use either the webadmin interface or add the following lines to the {{{trac.ini}}} file: 
    10792{{{ 
    10893[components] 
    10994trachours.* = enabled 
    11095}}} 
    111  
    112  * add give users the permission `TICKET_ADD_HOURS` 
    113  
    114  * you will need to run {{{trac-admin <env> upgrade}}} in order to create the correct database tables 
     96 * You will need to upgrade {{{trac-admin <env> upgrade}}} in order to create the correct database tables. 
     97 * Add give users the permission `TICKET_ADD_HOURS` 
    11598 
    11699'''Note:''' The TracHoursPlugin requires python at least 2.4 
    117  
    118 The TracHoursPlugin also requires the ComponentDependencyPlugin and the TicketSidebarProviderPlugin to be installed and enabled in order to work properly.  (They may be enabled via the "Plugins" menu in the trac administration page.) 
    119  
    120 Download the [download:trachoursplugin zipped source], check out [/svn/trachoursplugin/0.11 using Subversion], or [source:trachoursplugin browse the source] with Trac. 
    121  
    122 See also the trac plugin installation instructions at http://trac.edgewall.org/wiki/TracPlugins#InstallingaTracPlugin 
    123  
    124100 
    125101== Bugs/Feature Requests ==  
    126102 
    127103Existing bugs and feature requests for TracHoursPlugin are [query:status!=closed&component=TracHoursPlugin&order=priority here]. 
    128 If you have any issues, create a  
    129 [/newticket?component=TracHoursPlugin&owner=k0s new ticket]. 
    130  
     104If you have any issues, create a [/newticket?component=TracHoursPlugin&owner=k0s new ticket]. 
    131105 
    132106== Recent Changes ==