dav/README.md

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