weeklog
How I Use It
Licence
Template
Orangeness
What It Is

weeklog is a program which generates a log file from a template for the current week, or for a specified week. It requires Template.pm to be in the library path.

The usage text for this tool is:

Usage:
    weeklog [{-containing|-starting} <date>] [-dir <path>]
            [-template <tfile>] [{-5|-7}]
            -thisweek {link|rename|none} [<file>]
            [-notes [<notes-file>]]
... where:
    <date> is in the format dd-mm-yyyy, and defaults to today. A -starting
        week will begin on the specified day; a -containing week will start on
        a Monday. -containing is the default.
    <path> defaults to the current directory, and defines the output path
    <tfile> defaults to "log.template", and is assumed to reside relative to
        the output directory
    -5 or -7 specifies the number of days in the week log, the default being
        seven
    <file> defaults to "thisweek", and must be a bare filename if supplied
    <notes-file> is a file containing note tokens which are attached to each
        day's clump row if the day date matches that of the note. The file
        name defaults to "notes" and is assumed to reside relative to the
        output directory.

The 'link', 'rename' and 'none' options require some explanation. These
describe the way in which the current week log will be denoted, and operate in
the following way 

    'none' will generate just a log file named for the canonical start date.
    'link' will generate the canonical date log file, and will also create a
        symbolic link to that this log file with the name <file>
    'rename' will generate the log file to <file>, having renamed the previous
        <file> to the date given in the associated file <file>.date

Canonical dates are defined as being in the form yymmdd.

Get weeklog.

Top

How I Use It

I have been using week log files at home and at work since 1999. It didn't take me long to get bored of creating the blank log files manually, so this program has been used for automating the process for most of that time.

Take a look at log.template which is the template I use on my home machine and contains a nice example of defining a subroutine in an [eval] construct for later use.

The command line I use is as follows, where log.template lives in the log directory:

weeklog -dir ~/write/log -thisweek link

This is for a *nix system so I use 'link'. On my Windows machine at work I would use 'rename'.

Top

Licence

This software copyright (c) Duncan Ellis 1999-2002.

This is freely distributable software, but I'd appreciate your passing any fixes or improvements back to me so I can publish them here.

No warranty is offered for the fitness of this software for any particular purpose. Use it at your own risk.

Top

weeklog
How I Use It
Licence
Template
Orangeness
Last updated 22-September-2005