Changes between Version 54 and Version 55 of TracHoursPlugin


Ignore:
Timestamp:
Mar 30, 2015, 9:43:44 AM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • TracHoursPlugin

    v54 v55  
    1818= Track hours spent on tickets
    1919
    20 == Goals of TracHoursPlugin
     20== Description
    2121
    22 The 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:
     22The 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:
    2323
    2424 * 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).
    25  * 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.
     25 * 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.
    2626 * Hours are uniquely assigned to tickets and people.
    27  * 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.
     27 * 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.
    2828 * Tickets have links to `/hours/<ticket number>` as the total hours field so that a user can add and view hours for the ticket.
    2929
    … …  
    4141== Components
    4242
    43 !TracHours consists of a number of components that work together to help track your time:
     43!TracHours consists of a number of components that work together to help track time:
    4444
    4545=== TracHoursPlugin
    … …  
    5858=== SetupTracHours
    5959
    60 `SetupTracHours` sets up the database and custom fields for the TracHoursPlugin.  You must enable this component for anything to work, including the `TracHoursPlugin` component.
     60`SetupTracHours` sets up the database and custom fields for the TracHoursPlugin. You must enable this component for anything to work, including the `TracHoursPlugin` component.
    6161
    6262=== TracHoursRoadmapFilter
    … …  
    7272=== TracHoursByComment
    7373
    74 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, if the commenter has the `TICKET_ADD_HOURS` permission.
     74The `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, if the commenter has the `TICKET_ADD_HOURS` permission.
    7575
    7676=== MultiprojectHours
    7777
    78 The 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`.
     78The 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`.
    7979
    80 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.
     80The 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.
    8181
    8282[[Image(multiprojecthours.png, border=1)]]
    … …  
    8686The TracHoursHowto offers a guide to the features of the TracHoursPlugin and how to use them.
    8787
    88 == Installing and Enabling !TracHours
     88== Installation
    8989
    9090TracHoursPlugin requires the following components:
    … …  
    9494 * TracSqlHelperScript
    9595
    96 You 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:
     96See [http://trac.edgewall.org/wiki/TracPlugins#InstallingaTracPlugin InstallingaTracPlugin] for more information on installing plugins. Additionally, you will require on your server:
    9797
    98  * !DateUtil, avalaible [http://pypi.python.org/pypi/python-dateutil/1.4.1 here] or package ''python-dateutil'' on Debian based systems.
    99  * !FeedParser, avalaible [http://code.google.com/p/feedparser/downloads/list here] or package ''python-feedparser'' on Debian based systems.
     98 * !DateUtil, available [pypi:python-dateutil/1.4.1 here] or package ''python-dateutil'' on Debian based systems.
     99 * !FeedParser, available [http://code.google.com/p/feedparser/downloads/list here] or package ''python-feedparser'' on Debian based systems.
    100100
    101 Now, TracHoursPlugin is enabled like any other trac plugin:
     101Now, TracHoursPlugin is enabled like any other Trac plugin:
    102102
    103103Download the [download:trachoursplugin zipped source], check out [/svn/trachoursplugin using Subversion], or [source:trachoursplugin browse the source] with Trac.
    104104
    105105 * Download and install the plugin.
    106  * Enable the plugin. Use either the webadmin interface or add the following lines to the {{{trac.ini}}} file:
     106 * Enable the plugin. Use either the webadmin interface or add the following lines to the `trac.ini` file:
    107107{{{#!ini
    108108[components]
    109109trachours.* = enabled
    110110}}}
    111  * You will need to upgrade {{{trac-admin <env> upgrade}}} in order to create the correct database tables.
    112  * Add give users the permission `TICKET_ADD_HOURS`
     111 * You will need to upgrade {{{trac-admin <env> upgrade}}} to create the correct database tables.
     112 * Give users the permission `TICKET_ADD_HOURS`.
    113113
    114 '''Note:''' The TracHoursPlugin requires python at least 2.4
     114'''Note:''' The TracHoursPlugin requires Python at least 2.4.
    115115
    116 == Bugs/Feature Requests ==
     116== Bugs/Feature Requests
    117117
    118118Existing bugs and feature requests for TracHoursPlugin are [query:status!=closed&component=TracHoursPlugin&order=priority here].
    119119If you have any issues, create a [/newticket?component=TracHoursPlugin&owner=rjollos new ticket].
     120
     121[[TicketQuery(component=TracHoursPlugin&group=type,format=progress)]]
    120122
    121123== Recent Changes