[[PageOutline(2-5,Contents,pullout)]]

= Time estimation and tracking

== Description

This plugin supports time tracking by adding the following to Trac:
* A ''Tasks'' admin panel, where tasks can be created and assigned a time estimate.
* A ''Log'' admin panel, where users can log the time they spend on these tasks.
* A new permission `TIME_TRACKING` that is required to use these panels.
* Two new database tables (to store these tasks and log entries).

Trac's reporting module can be used to define various reports that summarize these tasks and log entries. For reporting purposes tasks can be grouped into ''projects'' and ''categories'', and log entries can record a ''location''.

Tasks are created and estimated per ''year''.

(There is ''no'' formal connection between tasks and tickets. Informally wiki-links to tickets can be entered in the task or log descriptions.)

== Screenshots

The tasks and estimation panel (rows link to ''Edit Task'' mode):
[[Image(Tasks-Panel.png)]]

The time logging panel (rows link to ''Edit Log Entry'' mode):
[[Image(Log-Panel.png)]]

One of many possible reports:
[[Image(Example-Report.png)]]

== !Bugs/Feature Requests

Existing bugs and feature requests for TimeTrackingPlugin are 
[report:9?COMPONENT=TimeTrackingPlugin here].

If you have any issues, create a 
[http://trac-hacks.org/newticket?component=TimeTrackingPlugin&owner=lucid new ticket].

== Download

Download the zipped source from [export:timetrackingplugin here].

== Source

You can check out TimeTrackingPlugin from [http://trac-hacks.org/svn/timetrackingplugin here] using Subversion, or [source:timetrackingplugin browse the source] with Trac.

== Installation

Installation of the plugin requires the usual step, e.g. easy_install `http://trac-hacks.org/svn/timetrackingplugin/trunk` and enable it in Trac's plugin admin page or by adding `timetracking.* = enabled` to the `[components]` section in trac.ini.

A database upgrade will be required as usual (`trac-admin path-to-your-trac-environment upgrade`).

Assign the new `TIME_TRACKING` permission to the appropriate Trac groups / users (e.g. in Trac's permission admin page).

Create reports under ''View Tickets''. You can copy from the [browser:timetrackingplugin/trunk/docs/reports.txt example reports].

== Recent Changes

[[ChangeLog(timetrackingplugin, 3)]]

== !Author/Contributors

**Author:** [wiki:lucid] [[BR]]
**Maintainer:** [[Maintainer]] [[BR]]
**Contributors:**