Version 1.2                   Readme for To-Do               9 April 2003
                           ======================

1. What is it?
--------------
To-Do is a simple web-based application for keeping track of
things to be done. ie a To-Do list. It is written to be slim
and quick in what it does, with a minimum of dependencies and
haivng painless setup and operation.
It has configurable themes and a clean professional looking
interface. Extra themes (CSS styles) can be added easily.

2. What requirements does it have?
----------------------------------
In order to be able to use To-Do, you need a web server (Apache)
with PHP built in. Your web browser must have Javascript
enabled.
There are no other requirements.

3. How do I install it?
-----------------------
Installation is simple. Untar the archive into somewhere that
is accessible by your web server, and which allows PHP script
execution. You need to make the file 'todo.dat' writeable by
the web server (or the UID that the web server invokes the script).

Two ways to do this:

   1) "chmod 666 too.dat"
          Will always work, but is a fraction less secure (local
          users on the server could change this file).
   2) Run the suexec wrapper
          The better option. Look in the suexec documentation for
          how to do this.

If the file cannot be written to, you a warning will appear
at the top of all pages.

This completes the installation. If you would like password
protection for this script, you'll need to implement htaccess
and basic authentication.

4. How do I use it?
-------------------
Point your web browser to whichever URL you installed the script
in. You may not need the 'index.php' at the end if your server
has the correct DirectoryIndex options.

You will be presented with the main screen showing a single
task. The primary functions are as follows:

  1) New Item
     This allows you to add a task to the list. The options
     in the popup window are fairly self-explanatory. The
     "Hide Until" option will cause the entry to not be displayed
     in the main table until the date specified (They can still be
     shown with the "Show Hidden" lin).
  2) Prefs
     This allows you to set some basic preferences. At the moment
     you can configure the theme, category names and whether items
     are deleted from the database when completed.
  3) Show Completed
     Items that have been marked as done are never actually deleted
     from the database file. This link allows you to view the items
     which have been deleted.
  4) Show Hidden
     Items which have "Hide Until" dates in the future are by
     default not shown in the main window. This link displays
     these items.
  5) Category dropdown
     To limit the display to only items in certain categories, 
     select it in the dropdown box.

The main item table is fairly clear as to its use. The following
are the primary functions.

  - Click on a column header to set the sort order.

  - Click on a task title to view all settings for this task.

  - The checkbox marks an item as complete (with confirmation dialog)

  - The hammer icon pops up a window to let you edit the item.

Colours of the status dot for each entry are:

  Green  : Normal task entry, not yet due.
  Purple : Task is due within 5 days.
  Red    : Task is overdue.
  Grey   : Task is completed.

For items marked as recurring, the following applies. Upon being
marked as complete, the item is not closed. Instead, its due
date is reset to the following:

  - Every 'x' days: 'x' days from the due date.

  - Every 'x' weeks: 'x' times seven days.

  - Every 'x' months: The same day of the month, 'x' months away

To completely close a recurring item, first edit it to remove
the recurrance, then close it.

5. How do I customise it?
-------------------------
Edit the source, for most customisations.

To change the "theme", you can edit the .css files as you see
fit. Adding a new theme is easy - just make a new css file (or
copy/edit an existing one) and put it in the install directory.
It will then be detected by the script and shown as an extra
theme in the Prefs page. Be sure the filename has the suffix .css!

6. Changes
----------
Since version 1.0:

- Due date can be selected as "x" days from now instead of actual date
- Same for "hide until"
- Due date and "hide until" dates default to current date.

7. How do I contact the author / get new versions?
-------------------------------------------------
The author can be reached at:  bb at cactii dot net

New versions are available from: http://www.cactii.net/~bb/

8. Copyright information
------------------------
To-Do is distributed under the GNU GPL version 2.

It is Copyright (C) 2003 Ben Buxton