]> mj.ucw.cz Git - libucw.git/blob - ucw-xml/doc/index.txt
XML: Brief documentation of LibUCW-XML
[libucw.git] / ucw-xml / doc / index.txt
1 The UCW-XML library
2 ===================
3
4 This library provides a light-weight XML parser built atop <<../ucw/index:,LibUCW>>.
5 It is primarily intended for efficient parsing of huge data sets, where other
6 parsers are too slow and cumbersome.
7
8 Its features include:
9
10 * High speed and low memory consumption, mainly thanks to efficient LibUCW
11   primitives like fastbufs and mempools.
12 * Multiple interfaces:
13 ** SAX-like: callback functions called on various parser events
14 ** Pull: for each call of the parser, it returns the next node
15 ** DOM-like: returns a data structure describing the whole tree of nodes
16 ** Any combination of the above: For example, when given a database with millions
17    of records, you can pull on the top level and ask for DOM of each record
18    separately.
19 * Support of namespaces.
20 * Complies with W3C recommendations on XML 1.0, XML 1.1, and Namespaces in XML 1.0
21   as a non-validating parser, but does not aim to support all frills of other
22   XML-related standards.
23 * Partial support for DTD-driven parsing: basic checks of document structure,
24   filling in default values, expanding user-defined entities.
25
26 Modules
27 -------
28 - <<xml:,XML Parser>>
29
30 Authors
31 -------
32
33 - Pavel Charvát <mailto:pchar\@ucw.cz[]> (main author)
34 - Martin Mareš <mailto:mj\@ucw.cz[]> (minor hacking and support for namespaces)