File Backend for SquirrelMail Calendar plugin
=============================================
Ver 1.0, 25/02/2005


Copyright (c) 2004-2005 Paul Lesneiwski <pdontthink@angrynerds.com>



Description
===========

This plugin implements a file-based backend for user calendar data 
for the SquirrelMail Calendar plugin.



License
=======

This plugin is released under the GNU General Public
License (see COPYING for details).



TODO
====

 - Implement TODO/Task, Holiday and other event types



Migrating From Other Backends
=============================

There is currently no automated support for migrating your calendar
data from one backend to another.  You will have to manually export
the calendars you want to migrate using "export" links on the main
calendar list page (click "Calendar" at the top of the main SquirrelMail
interface), and then re-import them when you have installed and 
activated the new backend.



Data Structure
==============

This is the overview of how data is stored in this backend:


<data_dir>
  |
  |---- calendar_data 
         |
         |---- private_calendars
         |       |
         |       |- iCal files containing only calendar info
         |          for user personal calendars
         |
         |---- public_calendars
         |       |
         |       |- iCal files containing only calendar info
         |          for public calendars
         |
         |---- shared_calendars
         |       |
         |       |- iCal files containing only calendar info
         |          for shared calendars
         |
         |---- events
                 |
                 |---- <calendar id>
                         |
                         |---- 2004 (year)
                         |       |
                         |       |---- 5 (month)
                         |             | 
                         |             | ---- 1 (day)
                         |                    |
                         |                    |- iCal files containing one 
                         |                       (one time) event each
                         |                       Note that events that run across
                         |                       months will be stored on the 1st
                         |                       of each month they occur in except
                         |                       the month of origin.
                         |
                         |---- 2005
                         |
                         |---- recurring
                         |       | 
                         |       |---- iCal files containing one recurring event each
                         |
                         |---- tasks
                                 | 
                                 |---- TBD



Change Log
==========

  v1.0 25/02/05
    * Initial version

