$Id$

See LICENSE for the Xindice licensing terms.


Table of Contents
=================
   Introduction
   Target Platforms
   Release Notes
   Known Issues


Introduction
------------

Xindice is an open source Native XML Database.  It stores and indexes
compressed XML documents in order to provide that data to a client
application with very little server-side processing overhead.  It
also provides functionality that is unique to XML data, which can't
easily be reproduced by relational databases.


Target Platforms
----------------

The Xindice code base is written in Java.  Because of this, Xindice
will work on any operating system that supports the Java Developer's
Kit.  Xindice is tested on major platforms (Linux, OS X, Windows) and
Java version (1.3 to 1.5).


Release Notes
-------------

Complete change list for the Apache Xindice releases is available
in the docs directory or online, at:
   http://xml.apache.org/xindice/changes.html

Instructions for upgrading from previous releases are available in
the docs directory or online, at:
   http://xml.apache.org/xindice/community/howto/upgrading/


IMPORTANT NOTE:
  Deployment of Xindice 1.1 is very different from Xindice 1.0.
  In many ways this should constitute a full version change since
  it is not completely backwards compatible with 1.0. However, the
  reasons this was done was to simplify the code base in preparation
  for future development. Unfortunately, the new features added do
  not justify a version change to 2.0.

- Documentation for this release is incomplete. Please submit
  documentation updates to the developers list.

- Server side installation is now done by deploying a WAR
  archive within a Java servlet engine. See the document in
  docs/community/howto/installation/tomcat.html for information
  on using Tomcat. Note: this document needs to be updated along
  with all the others. Embedded Jetty servler engine and startup
  scripts are included for convenience.

- The database is now deployed within a servlet engine to enable
  network access. This is different from in 1.0 where Xindice had
  its own server framework. This change was made because the
  custom Xindice server framework just duplicated much of the
  functionality provided by servlet engines. This has the nice
  side effect of creating more flexibility in deployment options.

- The network access API is now based on XML-RPC rather then
  CORBA. This was done for simplification and to eliminate the
  constant problems with the CORBA ORB and consumption of
  resources. It also was done to address UTF-8 encoding issues
  that were present with CORBA. Initial tests show a minimal
  performance impact from this change.

- All CORBA related code has been removed from the system.

- The server should now fully support the storage and retrieval
  of documents encoded as UTF-8.

- There is now an embedded version of the XML:DB API. This allows
  you to build Xindice applications that access the database
  without using the network. The API should be fully compatible
  with the network enabled XML:DB API implementation. An embedded
  database can be used by simply changing the XML:DB URI from
  xmldb:xindice:// to xmldb:xindice-embed://.

- The xindiceadmin tool has been removed. All commands that were
  previously only accessible through xindiceadmin are now
  available through the xindice command. This should make
  working with the server a little simpler.

- An option was added to the command line tools to allow the
  specification of namespaces to be used with XPath queries.
  This option is -s. Refer to the Tools Reference document for
  more information.

- On the command line tools the confirmation during deletion
  has been removed. Along with this the -y option that would force
  automatic deletion has also been removed.

- The command line tools can be run against a network version of
  Xindice or directly against local database files. See the -l and
  -d options to learn more about local database access. If using
  direct file access, please ensure that server process is not running.

- XMLObjects have been removed.


Known Issues
------------

- See bug database for a list of currently open issues, located at
  http://issues.apache.org/bugzilla/buglist.cgi?query_format=specific&bug_status=__open__&product=Xindice