view release on metacpan or  search on metacpan

lib/App/TimelogTxt/Tutorial.pod  view on Meta::CPAN

task. Since we are going to be talking about the C<Foo> project, note that in
the command.

   $ timelog start +Foo @ConfCall Team Meeting

The meeting is over and you need to change tasks. During the meeting, you
agreed to do some general work on the manual for the project's software. Enter
the task to begin working on that.

   $ timelog start +Foo @Docs working on manual

We are in the same project, so C<timelog> will be able to report the cumulative
total of the last two tasks. About 20 minutes after you start on the manual,
Sue comes by to ask about the project you were working on last week. Since this
is will be a temporary interruption, we use the B<push> command. It saves the
current task, so that we can restore it when the interruption is over.

   $ timelog push +Bar @Help Sue questions

When all of Sue's questions are answered, you want to go back to the manual
work.

   $ timelog pop

The B<pop> command restores the task that was current when the last B<push>
command was executed. This way you don't need to type in the whole command (or
up-arrow through your command history), for short interruptions.

A while later, you've finished with the manual for today and want to finish up
the work on the database module for the I<Foo> project.

   $ timelog start +Foo @Code database module

You get some good uninterrupted time on this and finish up the module in time
to stop at 5.

   $ timelog stop

As you can see, this requires the addition of a bit more to your daily work
flow. Later in the manual we will cover a few features that can reduce your
typing. The main benefit of all of this work though is the ability to generate
reports of your work.

=head2 Reports

The most detailed report you might do is to list all of the events for a given
day. If you executed the following command the day after the example above, you
would get a list of the tasks for that day.

   $ timelog ls yesterday

The output of this command (assuming only the commands from the example) would
look like this:

    2013-07-01 12:50:02 +Admin @Email
    2013-07-01 13:00:21 +Foo @ConfCall Team Meeting
    2013-07-01 14:02:43 +Foo @Docs working on manual
    2013-07-01 14:22:03 +Bar @Help Sue questions
    2013-07-01 14:27:06 +Foo @Docs working on manual
    2013-07-01 15:10:20 +Foo @Code database module
    2013-07-01 17:00:24 stop

This is the most detailed report, but it isn't really useful for much. Usually,
you want some form of summarized information. The other reporting commands take
care of that.

=head3 Detail Report

The report I use the most looks like the following:

   $ timelog report yesterday

This report shows the data for the given date grouped by project. Although the
actual times are missing and the data is re-ordered, you can get a really good
sense of where your time went with this report.

    2013-07-01  4:10
      Admin         0:10
          Email                0:10
      Bar           0:05
          Help                 0:05 (Sue questions)
      Foo           3:55
          Code                 1:50 (database module)
          Docs                 1:03 (working on manual)
          ConfCall             1:02 (Team Meeting)

=head3 Summary Report

Sometimes, the normal report is still too much data. Let's say I only care
about the aggregate amount of time spent on each project. I would then use the
following command:

   $ timelog summary yesterday

This report has no task information, it just reports the time on each project
for the day.

    2013-07-01  4:10
      Admin         0:10
      Bar           0:05
      Foo           3:55

=head3 Hours Report

Finally, you may only want the amount of time you spent for the whole day. That
report is generated by the following command:

   $ timelog hours yesterday

This just tells how long you were working. Sometimes it is all you need.

    2013-07-01  4:10

=head1 Simplifying Usage with Aliases

As you use the C<timelog> program more, typing long strings for individual
events becomes annoying. If you are working on the same projects or tasks on a
regular basis, you might find typing the detail annoying even if you want it
for reporting.

The C<timelog> program supports defining aliases in your F<.timelogrc> file.