Protean TodoList - 1.0 (3rd September, 2007)
============================================

Quick Links
-----------

Project Homepage: http://www.sodaware.net/dev/tools/protean.todolist/
Protean Homepage: http://www.proteanide.co.uk


Contents
--------

   1) What is the TodoList plugin?
   2) Installing
   3) Usage
   4) Credits & Thanks
   5) Licence
   6) Support


1) What is the TodoList plugin?
-------------------------------

The Protean TodoList plugin is a very simple extension that will scan any 
files loaded into Protean for certain tags. These tags are typically used
for making notes in code, such as reminders to clean up functions or notes
about potential problems that may need fixing.


2) Installation
---------------

Copy the folder "TodoList" to your Protean "Plugins" folder. When you run 
Protean again, the plugin should be enabled and ready to roll.


3) Usage
--------

One the plugin has been installed, it can be enabled by selecting "Task List"
from the Protean view menu. To scan loaded files, click the "refresh" button
on the task pane's toolbar.

Todo List searches for the following tags at the start of comments:

TASK:, KLUDGE:, HACK:, NOTE:, TEMP:

For example, the following comment would generate a Todo entry in the Hack
category:

; HACK: This is a hack.
someBlitzCodeHere()

Tasks can be filtered using the drop-down menu, and can be sorted by their
line number, filename, type and description.


4) Credits
----------

The icons used in this plugin are from "Silk Icons", which are available
for free at: http://www.famfamfam.com/lab/icons/silk/


5) Licence
----------

This program is free to use without restriction, and may be freely
distributed provided all documentation is included in an unmodified
state.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.


6) Support
----------

Any updates to this project can be found at the project homepage located 
at: http://www.sodaware.net/dev/tools/protean.todolist/. Bug reports can
be opened at the bug tracker for this project (http://bugs.sodaware.net).

If you have any comments or queries, please feel free to get in touch with
me at phil@sodaware.net. 

