| | 1 | |
| | 2 | = !TracHours Plugin User Manual = |
| | 3 | |
| | 4 | Track hours spent on tickets |
| | 5 | |
| | 6 | == Description |
| | 7 | |
| | 8 | This plugin helps to keep track of hours worked on tickets. This is an alternative to !TimingAndEstimationPlugin, but with a different approach: |
| | 9 | |
| | 10 | * 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 allotted hours if you have the appropriate permissions (`TICKET_ADD_HOURS` for your own hours, `TRAC_ADMIN` for the hours of others). |
| | 11 | * 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. |
| | 12 | * Hours are uniquely assigned to tickets and people. |
| | 13 | * 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. |
| | 14 | * Tickets have links to `/hours/<ticket number>` as the total hours field so that a user can add and view hours for the ticket. |
| | 15 | |
| | 16 | Hour tracking and estimation is most useful for the following types of questions: |
| | 17 | |
| | 18 | * How much time has been spent on a project? |
| | 19 | * How much time remains in a budget (estimate for a project)? |
| | 20 | * How much time have we committed to for the next time period? |
| | 21 | * How much time is a developer committed to over the next time period? |
| | 22 | |
| | 23 | If 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. |
| | 24 | |
| | 25 | For other Trac time-tracking solutions, see t:TimeTracking. |
| | 26 | |
| | 27 | == Components |
| | 28 | |
| | 29 | !TracHours consists of a number of components that work together to help track time: |
| | 30 | |
| | 31 | === !TracHoursPlugin |
| | 32 | |
| | 33 | `TracHoursPlugin` is the core component of !TracHours. |
| | 34 | |
| | 35 | * API function. |
| | 36 | * Navigation bar provider. |
| | 37 | * Query view for `/hours`. |
| | 38 | * Ticket hours view for `/hours/<ticket number>` |
| | 39 | * Stream filter for checking and rendering of estimated hours and total hours fields for tickets |
| | 40 | * RSS feeds at `/hours?format=rss` and `/hours/<ticket number>?format=rss` |
| | 41 | |
| | 42 | This component must be enabled to use the !TracHoursPlugin functionality. |
| | 43 | |
| | 44 | === !SetupTracHours |
| | 45 | |
| | 46 | `SetupTracHours` sets up the database and custom fields for the !TracHoursPlugin. You must enable this component for anything to work, including the `TracHoursPlugin` component. |
| | 47 | |
| | 48 | === !TracHoursRoadmapFilter |
| | 49 | |
| | 50 | `TracHoursRoadmapFilter` adds hours information for milestones at `/roadmap` and `/milestone/<milestone name>` |
| | 51 | |
| | 52 | === !TracHoursSidebarProvider |
| | 53 | |
| | 54 | The `TracHoursSidebarProvider` component uses the !TicketSidebarProviderPlugin (if enabled) to add a form to each ticket for direct addition of hours to the ticket. Hours will be logged as the authenticated user and comments will not be made. |
| | 55 | |
| | 56 | === !TracHoursByComment |
| | 57 | |
| | 58 | The `TracHoursByComment` component enables adding hours by ticket comments. Comments containing snippets like `5 hours`, `1 hour`, `3.7 hours`, or `0:30 hours` will be added to the total hours for the ticket, provided the commenter has the `TICKET_ADD_HOURS` permission. |
| | 59 | |
| | 60 | === !MultiprojectHours |
| | 61 | |
| | 62 | The !TracHoursPlugin exports RSS from the `/hours` handler. This has been utilized 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`. |
| | 63 | |
| | 64 | The 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. |
| | 65 | |
| | 66 | |
