dav/README.md

   1 Calendar with CalDAV Support
   2
   3 This is a rewrite of the calendar system used by the german social network [Animexx](http://www.animexx.de/).
   4 It's still in a very early stage, so expect major bugs. Please feel free to report any of them, by mail (cato@animexx.de) or Friendica: http://friendica.hoessl.eu/profile/cato
   5
   6 At the moment, the calendar system supports the following features:
   7 - A web-based drag&drop interface for managing events
   8 - All-Day-Events, Multi-Day-Events, and time-based events
   9 - Giving the subject, a description, a location and a color for the event (the color is not available through CalDAV, though)
  10 - Recurrences (not the whole set of options given in the iCalendar spec, but the most important ones)
  11 - Notification by e-mail. Multiple notifications can be set per event
  12 - Multiple calendars per user
  13 - Access to the events using CalDAV (using iPhone, Thunderbird Lightning etc., see below)
  14 - Read-only access to the friendica-native events (also using CalDAV)
  15 - The friendica-contacts are made available using CardDAV (confirmed to work with iOS)
  16 - The events of a calendar can be exported as ICS file. ICS files can be imported into a calendar
  17
  18
  19 Internationalization:
  20 - At the moment, settings for the US and the german systems are selectable (regarding the date format and the first day of the week). More will be added on request.
  21 - The basic design of the system is aware of timezones; however this is not reflected in the UI yet. It currently assumes that the timezone set in the friendica-installation matches the user's local time and matches the local time set in the user's operating system.
  22
  23 CalDAV device compatibility:
  24 - iOS (iPhone/iPodTouch) works
  25 - Thunderbird Lightning works
  26 - Android:
  27   - aCal (http://andrew.mcmillan.net.nz/projects/aCal) works, available in F-Droid and Google Play
  28   - CalDAV-Sync (http://dmfs.org/caldav/) works, non-free
  29
  30 ## Installation
  31 After activating, serveral tables in the database have to be created. The admin-interface of the addon will try to do this automatically.
  32 In case of errors, the SQL-statement to create the tables manually are shown in the admin-interface.
  33
  34
  35 Functuality missing: (a.k.a. "Roadmap")
  36 - Sharing events; all events are private at the moment, therefore this system is not a complete replacement for the friendica-native events
  37 - Attendees / Collaboration
  38
  39
  40 Used libraries
  41
  42 SabreDAV
  43 http://code.google.com/p/sabredav/
  44 New BSD License
  45
  46 wdCalendar
  47 http://www.web-delicious.com/jquery-plugins/
  48 GNU Lesser General Public License
  49
  50 jQueryUI
  51 http://jqueryui.com/
  52 Dual-licenced: MIT and GPL licenses
  53
  54 TimePicker
  55 http://www.texotela.co.uk/code/jquery/timepicker/
  56 Dual-licenced: MIT and GPL licenses
  57
  58 ColorPicker
  59 http://laktek.com/2008/10/27/really-simple-color-picker-in-jquery/
  60 MIT License
  61
  62
  63
  64 Author of this addon (the parts that are not part of the libraries above):
  65 Tobias Hößl
  66 http://friendica.hoessl.eu/profile/cato
  67 http://www.hoessl.eu/
  68 tobias@hoessl.eu
  69 @TobiasHoessl
  70
  71 Originally developed for:
  72  Animexx e.V. / http://www.animexx.de/