David F. Houghton > App-JobLog-1.032 > App::JobLog::Command::note

Download:
App-JobLog-1.032.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  1
View/Report Bugs
Module Version: 1.032   Source  

NAME ^

App::JobLog::Command::note - take a note

VERSION ^

version 1.032

SYNOPSIS ^

 houghton@NorthernSpy:~$ job note --help
 job <command>
 
 job note <text of note>
        -t --tag          tag the note; multiple tags are acceptable; e.g.,
                          -t foo -t bar -t quux
        -T --clear-tags   inherit no tags from preceding note; this is
                          equivalent to -t ""; this option has no effect if
                          any tag is specified
        --help            this usage screen
 houghton@NorthernSpy:~$ job note taking a note
 houghton@NorthernSpy:~$ job note -t money taking a note about money
 houghton@NorthernSpy:~$ job n taking another note that will be tagged with 'money'
 houghton@NorthernSpy:~$ job n -T taking a note without any tags

DESCRIPTION ^

Notes differ from tasks in several ways:

 * they aren't "on the clock"
 * they don't change the current task
 * they have a timestamp but no duration

They are like tasks in that it is nice to find them by time, tag, text, etc. and they are well suited to a log format. note is the command that lets you log notes as you would tasks.

TAGS

You may optionally attach categories to tasks with tags. Any string can be a tag but to make the output readable you'll want them to be short. Also, in the logs tags are delimited by whitespace and separated from the timestamp and description by colons, so these characters will be escaped with a slash. If you edit the log by hand and forget to escape these characters the log will still parse but you will be surprised by the summaries you get.

You may specify multiple tags, but each one needs its own --tag flag.

If you don't specify otherwise the new note will inherit the tags of the previous note, so you will need to apply the --clear-tags option to prevent this. The reasoning behind this feature is that when you take notes you frequently take several in succession and want them all tagged the same way.

AUTHOR ^

David F. Houghton <dfhoughton@gmail.com>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2011 by David F. Houghton.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: