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

   1 # $Id$
   2
   3 Overview
   4 ========
   5
   6 Two SaxObjC drivers for iCalendar and vCard files, initially written by
   7 Max Berger <max@berger.name>.
   8
   9 VSiCalSaxDriver basically maps iCal 2.0 components, properties and parameters
  10 to the XML events according to the xCal 02 draft (iCal 3.0).
  11
  12 Having a SAX driver for iCal might seem strange and a bit inefficient at
  13 first look, but the time saved for the application-level developer is
  14 significant, since he only needs to learn (or usually already knows) the
  15 SAX or DOM APIs and any XML API based on them (like XPATH, XQUERY).
  16
  17 The VSiCalSaxDriver is aimed to be a replacement for the older (but better
  18 tested as of now) iCalSaxDriver. However, the iCalSaxDriver depends on the
  19 abandoned and hardly maintainable libical, which itself is an additional
  20 dependency to the OGo project and thus a welcome candidate for replacement.
  21
  22 The VSSaxDriver attempts to follow RFC2445 closely, however the parser is
  23 written to be robust when it comes to parsing real life content. Currently,
  24 unescaping is done for more characters then it MUST according to RFC2445, but
  25 this is probably not a bad idea - wrongly escaped characters will still be
  26 parsed according to the original intent. Also, the VSSaxDriver supports Unix
  27 style terminated lines/folding.
  28
  29 ToDo
  30 ====
  31
  32 - improve error handling (SaxExceptions !)
  33 - make the driver fully xCal compliant
  34
  35
  36 Defaults
  37 ========
  38
  39 Name                            Type        Description
  40 ------------------------------------------------------------------------------
  41 VSSaxDriverDebugEnabled         BOOL        YES -> log some debug information
  42                                                    via NSLog
  43
  44
  45 Examples
  46 ========
  47
  48 To "convert" an iCalendar to xCal (the test programs print out some XML):
  49
  50   saxxml -XMLReader VSiCalSaxDriver test1.ics
  51   domxml -XMLReader VSiCalSaxDriver -xml  test1.ics
  52
  53 To "convert" an iCalendar to PYX:
  54
  55   domxml -XMLReader VSiCalSaxDriver -pyx  test1.ics