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

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