vgritsenko 2004/01/31 19:37:24
Modified: src/documentation/content/xdocs guide-user.xml
Log:
Formatting. Comment out XObjects stuff.
Revision Changes Path
1.10 +58 -56
xml-xindice/src/documentation/content/xdocs/guide-user.xml
Index: guide-user.xml
===================================================================
RCS file:
/home/cvs/xml-xindice/src/documentation/content/xdocs/guide-user.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- guide-user.xml 25 Dec 2003 22:06:48 -0000 1.9
+++ guide-user.xml 1 Feb 2004 03:37:24 -0000 1.10
@@ -87,10 +87,9 @@
flexiblity in how you store your data, but, also means you
give up
some common database functionality such as data
types.
- In its current
- state Xindice is already a powerful tool for managing XML
data.
- However, there is still much that needs to be done. Feedback
and
- contributions are actively encouraged.
+ In its current state Xindice is already a powerful tool for
managing
+ XML data. However, there is still much that needs to be done.
+ Feedback and contributions are actively encouraged.
</p>
<p>
This document attempts to
@@ -102,57 +101,58 @@
<section>
<title>Feature Summary</title>
<p>
- Document Collections: Documents are stored in collections
that can
- be queried as a whole. You can create collections that
contain just
- documents of the same type or you can create a collection to
store
- all your documents together. The database doesn't care.
+ <strong>Document Collections</strong>: Documents are stored in
+ collections that can be queried as a whole. You can create
+ collections that contain just documents of the same type or
you
+ can create a collection to store all your documents together.
+ The database doesn't care.
</p>
<p>
- XPath Query Engine: To query the Document Collections you use
- <link href="http://www.w3.org/TR/xpath";>XPath</link> as
defined
- by the W3C. This provides a reasonably flexible mechanism for
- querying documents by navigating and restricting the result
tree
+ <strong>XPath Query Engine</strong>: To query the Document
+ Collections you use <link
href="http://www.w3.org/TR/xpath";>XPath</link>
+ as defined by the W3C. This provides a reasonably flexible
mechanism
+ for querying documents by navigating and restricting the
result tree
that is returned.
</p>
<p>
- XML Indexing: In order to improve the performance of queries
over
- large numbers of documents you can define indexes on element
and
- attribute values. This can dramatically speed up query
response
- time.
- </p>
- <p>
- XML:DB XUpdate Implementation: When you store XML in the
database
- you may want to be able to change that data without
retrieving the
- entire document. XUpdate is the mechanism to use when you
want to do
- server side updates of the data. It is an XML based language
for
- specifying XML modifications and allows those modifications
to be
- applied to entire document collections as well as single
documents.
- </p>
- <p>
- Java XML:DB API Implementation: For Java programmers Xindice
provides
- an implementation of the XML:DB API. This API is intended to
bring
- portability to XML database applications just as JDBC has
done for
- relational databases. Most applications developed for Xindice
will use
- the XML:DB API.
+ <strong>XML Indexing</strong>: In order to improve the
performance
+ of queries over large numbers of documents you can define
indexes on
+ element and attribute values. This can dramatically speed up
query
+ response time.
+ </p>
+ <p>
+ <strong>XML:DB XUpdate Implementation</strong>: When you
store XML
+ in the database you may want to be able to change that data
without
+ retrieving the entire document. XUpdate is the mechanism to
use when
+ you want to do server side updates of the data. It is an XML
based
+ language for specifying XML modifications and allows those
modifications
+ to be applied to entire document collections as well as
single documents.
+ </p>
+ <p>
+ <strong>Java XML:DB API Implementation</strong>: For Java
programmers
+ Xindice provides an implementation of the XML:DB API. This
API is
+ intended to bring portability to XML database applications
just as
+ JDBC has done for relational databases. Most applications
developed
+ for Xindice will use the XML:DB API.
</p>
- <p>
+ <!-- p>
XMLObjects: XMLObject provide a server extension mechanism for
adding extra functionality to the server. They can be used to
execute complex operations within the database engine to cut
down on
network bandwidth or to add functionality that doesn't
currently
exist in the server.
- </p>
+ </p -->
<p>
- Command Line Management Tools: To aid the administrator
Xindice
- provides a full suite of command line driven management
tools. Just
- about everything you can do through the XML:DB API can also
be done
- from the command line.
+ <strong>Command Line Management Tools</strong>: To aid the
administrator
+ Xindice provides a full suite of command line driven
management tools.
+ Just about everything you can do through the XML:DB API can
also be
+ done from the command line.
</p>
<p>
- Modular Architecture: The Xindice server is constructed in a
very
- modular manner. This makes it easy to add and remove
components to
- tailor the server to a particular environment or to embed it
into
- another application.
+ <strong>Modular Architecture</strong>: The Xindice server is
+ constructed in a very modular manner. This makes it easy to
add and
+ remove components to tailor the server to a particular
environment or
+ to embed it into another application.
</p>
</section>
<section>
@@ -184,7 +184,7 @@
my-child-collection collection would be
</p>
<source><![CDATA[
-/db/my-collection/my-child-collection
+ /db/my-collection/my-child-collection
]]></source>
</section>
<p>
@@ -200,7 +200,7 @@
referenced via a path.
</p>
<source><![CDATA[
-/db/my-collection/my-child-collection/my-document
+ /db/my-collection/my-child-collection/my-document
]]></source>
</section>
<p>
@@ -223,13 +223,13 @@
something like this.
</p>
<source><![CDATA[
-myhost.domain.com:4080/db/my-collection/my-child-collection/my-document
+ myhost.domain.com:8080/db/my-collection/my-child-collection/my-document
]]></source>
<p>
This can also take the form of a Xindice URI.
</p>
<source><![CDATA[
-xindice://myhost.domain.com:4080/db/my-collection/my-child-collection/my-document
+
xindice://myhost.domain.com:8080/db/my-collection/my-child-collection/my-document
]]></source>
</section>
</section>
@@ -278,7 +278,7 @@
/db/data/products and will be stored under the key fx102.
</p>
<source><![CDATA[
-xindice add_document -c /db/data/products -f fx102.xml -n fx102
+ xindice add_document -c /db/data/products -f fx102.xml -n fx102
]]></source>
</section>
<section>
@@ -290,7 +290,7 @@
to this 0625df6b0001a5d4000bc49d0060b6f5
</p>
<source><![CDATA[
-xindice add_document -c /db/data/products -f fx102.xml
+ xindice add_document -c /db/data/products -f fx102.xml
]]></source>
</section>
</section>
@@ -307,7 +307,7 @@
the /db/data/products collection and stored in the file
fx102.xml
</p>
<source><![CDATA[
-xindice retrieve_document -c /db/data/products -n fx102 -f fx102.xml
+ xindice retrieve_document -c /db/data/products -n fx102 -f fx102.xml
]]></source>
</section>
</section>
@@ -321,7 +321,7 @@
collection /db/data/products.
</p>
<source><![CDATA[
-xindice delete_document -c /db/data/products -n fx102
+ xindice delete_document -c /db/data/products -n fx102
]]></source>
</section>
</section>
@@ -354,17 +354,19 @@
Here we assume we have a collection /db/data/products that
contains
documents that are similar to the following.
</p>
- <source><![CDATA[<?xml version="1.0"?>
-<product product_id="120320">
-<description>Glazed Ham</description>
-</product>]]></source>
+ <source><![CDATA[
+ <?xml version="1.0"?>
+ <product product_id="120320">
+ <description>Glazed Ham</description>
+ </product>
+ ]]></source>
<p>
The XPath /[EMAIL PROTECTED]"120320"] will be executed against
the collection /db/data/products and all matching product
entries
will be returned.
</p>
<source><![CDATA[
-xindice xpath_query -c /db/data/products -q /[EMAIL PROTECTED]"120320"]
+ xindice xpath_query -c /db/data/products -q /[EMAIL PROTECTED]"120320"]
]]></source>
<p>
The result of the query is an XPath node-set that contains one
