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

   1 Overview
   2 ========
   3
   4 Two SaxObjC drivers for iCalendar and vCard files, initially written by
   5 Max Berger <max@berger.name>.
   6
   7 VSiCalSaxDriver basically maps iCal 2.0 components, properties and parameters
   8 to the XML events according to 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 The VSiCalSaxDriver is aimed to be a replacement for the older (but better
  16 tested as of now) iCalSaxDriver. However, the iCalSaxDriver depends on the
  17 abandoned and hardly maintainable libical, which itself is an additional
  18 dependency to the OGo project and thus a welcome candidate for replacement.
  19
  20 The VSSaxDriver attempts to follow RFC2445 closely, however the parser is
  21 written to be robust when it comes to parsing real life content. Currently,
  22 unescaping is done for more characters then it MUST according to RFC2445, but
  23 this is probably not a bad idea - wrongly escaped characters will still be
  24 parsed according to the original intent. Also, the VSSaxDriver supports Unix
  25 style terminated lines/folding.
  26
  27 ToDo
  28 ====
  29
  30 - improve error handling (SaxExceptions !)
  31 - make the driver fully xCal compliant
  32
  33
  34 Defaults
  35 ========
  36
  37 Name                            Type        Description
  38 ------------------------------------------------------------------------------
  39 VSSaxDriverDebugEnabled         BOOL        YES -> log some debug information
  40                                                    via NSLog
  41
  42
  43 Examples
  44 ========
  45
  46 To "convert" an iCalendar to xCal (the test programs print out some XML):
  47
  48   saxxml -XMLReader VSiCalSaxDriver test1.ics
  49   domxml -XMLReader VSiCalSaxDriver -xml  test1.ics
  50
  51 To "convert" an iCalendar to PYX:
  52
  53   domxml -XMLReader VSiCalSaxDriver -pyx  test1.ics