QuiXML (c) Copyright 2003 Sean O'Dell

QuiXML is released under the GNU General Public License
"The QuiXML API" reference is released under the GNU Free Documentation License



ABOUT
-----

QuiXML is an XML library for Ruby written in C, utilizing the expat library
for parsing XML string buffers. It uses only Ruby native data structures to
store its XML data internally, so there is no "built-in" way to create XML
trees; how they are generated is completely open. The library both parses and
generates XML, automatically performing pretty printing and encoding/decoding
special characters (<, >, &, ', and "). Transmutations to/from attribute
string values and Ruby objects can occur when reading/writing XML, allowing
for a limited degree of object marshalling. Element path addressing makes it
easy to find one or more nodes using literal strings, regular expressions or
any other object which supports Ruby case-equality to match against XML node
names and attributes.



EXAMPLE CODE
------------

  require "quixml"

  qxml = QuiXML::Tree.new

  # parse and transmutate attributes
  qxml.parse(xmlstring) do | name, value |
    case name
      when "active"
        value == "yes" ? true : false
      when "id"
        value.to_i
      else
        value
    end
  end

  # find the node /root/acc whose id is 123
  node = qxml.find_first(["root", ["acc", "id", 123]])

  p node.attributes #<-- {"acc"=>123, "active"=>true}



LICENSE
-------

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

A full copy of the GNU license is provided in the file LICENSE.



INSTALL
-------

First run these commands from the shell to build QuiXML:

    cd quixml-[CURRENT VERSION HERE]
		./configure
    make

Then as root, run this command to install QuiXML:

    make install



DOCUMENTATION
-------------

All API documentation is provided in the file doc.html.
