err.no Git - sope/blob - sope-ical/iCalSaxDriver/README

   1 # $Id$
   2
   3 Overview
   4 ========
   5
   6 An SaxObjC driver for iCalendar files. It basically maps iCal 2.0
   7 components, properties and paraemters to the XML events according to
   8 the xCal 02 draft (iCal 3.0).
   9
  10 Having a SAX driver for iCal might seem strange and a bit inefficient at
  11 first look, but the time saved for the application-level developer is
  12 significant, since he only needs to learn (or usually already knows) the
  13 SAX or DOM APIs and any XML API based on them (like XPATH, XQUERY).
  14
  15 ToDo
  16 ====
  17
  18 The driver is by no means complete or 100% compliant to xCal (which
  19 isn't final anyway ...). So:
  20 - improve error handling (SaxExceptions !)
  21 - make the driver fully xCal compliant
  22 - recurrence rules !!!
  23 - implement all components supported by libical
  24 - make it as fast as possible ;-) (probably most gains can be made by
  25   improving DOM, not iCalSaxDriver ...)
  26
  27 Examples
  28 ========
  29
  30 To "convert" an iCalendar to xCal (the test programs print out some XML):
  31
  32   saxxml -XMLReader iCalSaxDriver test1.ics
  33   domxml -XMLReader iCalSaxDriver -xml  test1.ics
  34
  35 To "convert" an iCalendar to PYX:
  36
  37   domxml -XMLReader iCalSaxDriver -pyx  test1.ics