
Shared Todo List Plugin

Bjarne Maschoreck, SAT Consulting ApS
(bjarne.maschoreck@satconsulting.dk)

The plugin allows creation and maintenance of personal, public and shared
todo lists between users of SquirrelMail. 

Todo list features:

	- set start date, title, description, duration, owner, priority.
	- assign tasks to other persons.
	- public lists with read-write access for all.
	- shared lists with user-defined access per user.
	- personal lists with user-defined access per user.
	- todays task at a glance across multiple todo lists.
	- sort tasks on start date/priority or user/start date/priority.
	- show all tasks for list or only tasks with passed start date.
	- select multiple tasks for deletion or start date change.

Todo list administration
------------------------

Todo lists administrators (see INSTALL file) can create new public or shared
todo lists and maintain the list of users allowed to read/write to these
todo lists. Users are defined by the SquirrelMail user name. Each user
can have a nick name attached. This can be used for task assignments in the
todo lists. The same nick name may be used for several users. This might be a
good idea to facilate when the same person has several SquirrelMail user
names. The todo lists will then be filtered correctly disregarding which
account is used by the person.

These actions are performed under Options -> Shared Todo List Administration.
If you cannot access this, see INSTALL on how to enable access.

Todo list task entries
----------------------

Each todo entry has a start date. This date should be seen as the date from
where the task can be performed. A duration can be specified in hours. Besides
of informative purposes, the hour number is used in sum calculations.

A task owner specified who should perform the task. The task owner can be one
of the nick names defined by the todo list administrators for the users.

Task entries also carry a title, a description and a priority.

Using todo list overview
------------------------

When selecting Todo in the SquirrelMail menu, your tasks for today is shown.
This is defined as tasks assigned to you (with your nick name) and with a
start date of today or older as today.

The task list is sorted on start date and priority. Tasks from all accessible
todo lists is shown.

Tasks can be edited directly by clicking on the start date. One or more tasks
can be selected and be deleted or have its start date changed. NOTE: This is
possible even if the user do not have write access to the todo list with a
selected items. Tasks can not be changed by the user, but this global action
is possible since the tasks was assigned to him.

Under the list of todays tasks, the list of accessible todo lists are shown.
Click on a todo list to go to it.

All users has a personal todo list. Tasks created under this list is personal
and should for that reason not be assigned to other users unless you wdo not
want the task shown on your todays task list overview.

Maintaining a todo list
-----------------------

Having selected a task list, all tasks for the list is shown (disregarding
to who the tasks are assigned). Tasks can be edited by clicking on the start
date. If you do not have write access to the task list, only all details about
the task can be seen; changes cannot be made.

One or more tasks can be selected and be deleted or have its start date
changed.

If durations were set, a sum of all tasks for each user are shown. If only one
user has tasks to a list, only the grand total is shown.

By default, all tasks in the list is shown. Click on "Show Active" to show only
tasks with a start date of today or before today. "Show All" again shows all
tasks.

The default sorting of the displayed tasks is start date and then priority.
Click on "Sort who/date/pri" to sort on the assigned user nick name and then
start date and finally priority.

Final words
-----------

This plugin module was highly inspired by the shared calendar plugin module 
by Jason Munro. Much code has been reused or converted for this plugin.

See the INSTALL file for setup instructions.

Please do not hesitate sending mails about problems, questions or comments to
Bjarne.Maschoreck@satconsulting.dk.

