README
1File Backend for SquirrelMail Calendar plugin
2=============================================
3Ver 1.0, 25/02/2005
4
5
6Copyright (c) 2004-2005 Paul Lesneiwski <pdontthink@angrynerds.com>
7
8
9
10Description
11===========
12
13This plugin implements a file-based backend for user calendar data
14for the SquirrelMail Calendar plugin.
15
16
17
18License
19=======
20
21This plugin is released under the GNU General Public
22License (see COPYING for details).
23
24
25
26TODO
27====
28
29 - Implement TODO/Task, Holiday and other event types
30
31
32
33Migrating From Other Backends
34=============================
35
36There is currently no automated support for migrating your calendar
37data from one backend to another. You will have to manually export
38the calendars you want to migrate using "export" links on the main
39calendar list page (click "Calendar" at the top of the main SquirrelMail
40interface), and then re-import them when you have installed and
41activated the new backend.
42
43
44
45Data Structure
46==============
47
48This is the overview of how data is stored in this backend:
49
50
51<data_dir>
52 |
53 |---- calendar_data
54 |
55 |---- private_calendars
56 | |
57 | |- iCal files containing only calendar info
58 | for user personal calendars
59 |
60 |---- public_calendars
61 | |
62 | |- iCal files containing only calendar info
63 | for public calendars
64 |
65 |---- shared_calendars
66 | |
67 | |- iCal files containing only calendar info
68 | for shared calendars
69 |
70 |---- events
71 |
72 |---- <calendar id>
73 |
74 |---- 2004 (year)
75 | |
76 | |---- 5 (month)
77 | |
78 | | ---- 1 (day)
79 | |
80 | |- iCal files containing one
81 | (one time) event each
82 | Note that events that run across
83 | months will be stored on the 1st
84 | of each month they occur in except
85 | the month of origin.
86 |
87 |---- 2005
88 |
89 |---- recurring
90 | |
91 | |---- iCal files containing one recurring event each
92 |
93 |---- tasks
94 |
95 |---- TBD
96
97
98
99Change Log
100==========
101
102 v1.0 25/02/05
103 * Initial version
104
105