7.2.3 Timeclock

This module allows you to clock in and clock out of your projects (see Time Intervals) You can also generate reports with the <timeclock-report> tag. You may want to read the “Keeping Track of Time” page to see how you can use planner-timeclock to produce detailed reports; See Keeping Track of Time.

timeclock.el is part of GNU Emacs. If you are using XEmacs, please use the version of timeclock.el that comes with Planner in the contrib directory.

With planner-timeclock.el loaded, planner-task-in-progress clocks in a task. To clock out, use planner-task-done or timeclock-out.

planner-timeclock.el defines the following keybindings:

• C-c C-i: planner-task-in-progress.
• C-c C-o: timeclock-out.
• C-c C-T C-i: planner-timeclock-in. (XEmacs)
• C-c C-T C-o: timeclock-out. (XEmacs)
• C-c C-S-t C-i: planner-timeclock-in. (GNU Emacs)
• C-c C-S-t C-o: timeclock-out. (GNU Emacs)

If you use timeclock a lot, you may also be interested in Dryice Liu's planner-timeclock-summary.el, which produces timeclock reports for planner files.

Here is a sample report:

     Project               |     Time| Ratio| Task
     PlannerMaintenance    |  0:03:58|  1.1%| Merge doc patch
                           |  0:17:09|  5.0%| Track down subdirectories
                           |  0:18:11|  5.3%| Merge planner-timeclock-summary-proj.el
                    Total: |  0:39:18| 11.4%|
     JapanCaseStudy        |  2:37:56| 45.6%| Prototype search result page
                           |  0:31:50|  9.2%| Update design documents
                    Total: |  3:09:46| 54.8%|
     ChristmasLetter       |  1:46:37| 30.8%| Write and send my Christmas letters
                    Total: |  1:46:37| 30.8%|
     LinuxPeople           |  0:10:29|  3.0%| Send questions for Linux in Education
                    Total: |  0:10:29|  3.0%|

If you add (require 'planner-timeclock-summary) to your ~/.emacs, you can then use it in two ways.

• Display a temporary buffer

  Call planner-timeclock-summary-show and Emacs will ask you which day's summary do you want. Choose the date as anywhere else of Emacs planner, and a tempory buffer will be displayed with the timeclock summary of that day.

  To review tasks over a date range, use planner-timeclock-summary-show-range. You can use a regexp or a function to filter tasks by calling planner-timeclock-summary-show-range-filter.

• Rewrite sections of your planner

  Choose this approach if you want timeclock summary to be in their own section and you would like them to be readable in your plain text files even outside Emacs. Caveat: The timeclock summary section should already exist in your template and will be rewritten when updated. Tip: Add planner-timeclock-summary-section (default: ‘"Timeclock"’) to your planner-day-page-template.

  To use, call planner-timeclock-summary-update in the planner day page to update the section. If you want rewriting to be automatically performed, call planner-timeclock-summary-insinuate in your .emacs file.

planner-timeclock-summary-proj.el produces task / time breakdowns on plan pages. Reports are of the form:

     TASK 0 | duration
     TASK 1 | duration
      TOTAL | duration.

To use, add (require 'planner-timeclock-summary) to your ~/.emacs. Call planner-timeclock-summary-proj-current from a project page. The report is inserted at the current position in the buffer. The function planner-timeclock-summary-proj-section does the same but the report is inserted inside a section called ‘* Report’.