Author: vgritsenko
Date: Thu Apr 19 18:59:36 2007
New Revision: 530610
URL: http://svn.apache.org/viewvc?view=rev&rev=530610
Log:
make forrest happy - make docs valid
Modified:
xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/index.xml
xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/one-oh.xml
xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/one-one.xml
xml/xindice/trunk/src/documentation/content/xdocs/dev/doc-contributing.xml
Modified:
xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/index.xml
URL:
http://svn.apache.org/viewvc/xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/index.xml?view=diff&rev=530610&r1=530609&r2=530610
==============================================================================
---
xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/index.xml
(original)
+++
xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/index.xml
Thu Apr 19 18:59:36 2007
@@ -19,7 +19,7 @@
- $Id$
-->
-<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.0//EN" "howto-v10.dtd">
+<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.3//EN" "howto-v13.dtd">
<!--
- Version: $Revision$ $Date$
@@ -27,9 +27,11 @@
<howto>
<header>
<title>Xindice Upgrading How-Tos</title>
+ <version>$Revision$</version>
<authors>
<person name="Vadim Gritsenko" email="[EMAIL PROTECTED]"/>
</authors>
+ <last-modified-content-date date="$Date$"/>
</header>
<audience title="Intended audience">
@@ -38,6 +40,7 @@
upgrade of older release of Xindice to the newer ones.
</p>
</audience>
+
<prerequisites title="Prerequisites">
<p>
Shutdown. Shutdown the database before starting an upgrade.
@@ -47,7 +50,7 @@
</p>
</prerequisites>
- <steps title="Upgrading to Xindice 1.1">
+ <steps title="Upgrade Steps">
<p>Pick the version you are currently running, and follow the steps.</p>
<ul>
<li>
Modified:
xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/one-oh.xml
URL:
http://svn.apache.org/viewvc/xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/one-oh.xml?view=diff&rev=530610&r1=530609&r2=530610
==============================================================================
---
xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/one-oh.xml
(original)
+++
xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/one-oh.xml
Thu Apr 19 18:59:36 2007
@@ -19,7 +19,7 @@
- $Id$
-->
-<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.0//EN" "howto-v10.dtd">
+<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.3//EN" "howto-v13.dtd">
<!--
- Version: $Revision$ $Date$
@@ -27,9 +27,11 @@
<howto>
<header>
<title>Xindice Release 1.0 Upgrading How-To</title>
+ <version>$Revision$</version>
<authors>
<person name="Vadim Gritsenko" email="[EMAIL PROTECTED]"/>
</authors>
+ <last-modified-content-date date="$Date$"/>
</header>
<audience title="Intended audience">
@@ -38,6 +40,7 @@
upgrade of 1.0 release of Xindice to the final 1.1 release.
</p>
</audience>
+
<prerequisites title="Prerequisites">
<p>
Shutdown. Shutdown the database before starting upgrade process.
@@ -47,32 +50,37 @@
</p>
</prerequisites>
- <steps title="Overview">
- <p>
- Xindice 1.0 and 1.1 have significant differences, namely:
- </p>
- <ul>
- <li>
- <strong>Transport.</strong> Xindice 1.0 used CORBA for communications
between
- clients and the server. Xindice 1.1 uses <link
href="http://www.xmlrpc.com/";>XML-RPC</link>
- instead, which is a lightweight XML over HTTP communication protocol.
Due to
- cross platform nature of XML-RPC, clients in Perl or PHP can be easily
written
- for the Xindice 1.1.
- </li>
- <li>
- <strong>XMLObjects.</strong> Xindice 1.1 does not have support for
Xindice 1.0
- XMLObjects.
- </li>
- </ul>
- </steps>
+ <steps title="Upgrade Steps">
+ <section>
+ <title>Overview</title>
+ <p>
+ Xindice 1.0 and 1.1 have significant differences, namely:
+ </p>
+ <ul>
+ <li>
+ <strong>Transport.</strong> Xindice 1.0 used CORBA for
communications between
+ clients and the server. Xindice 1.1 uses <link
href="http://www.xmlrpc.com/";>XML-RPC</link>
+ instead, which is a lightweight XML over HTTP communication
protocol. Due to
+ cross platform nature of XML-RPC, clients in Perl or PHP can be
easily written
+ for the Xindice 1.1.
+ </li>
+ <li>
+ <strong>XMLObjects.</strong> Xindice 1.1 does not have support for
Xindice 1.0
+ XMLObjects.
+ </li>
+ </ul>
+ </section>
- <steps title="Steps">
- <p>
- Despite all of the differences, steps for upgrading from Xindice 1.0 are
all
- the same as if upgrading from any of Xindice 1.1 betas. Please follow
the steps
- outlined <link href="one-one.html">here</link>.
- </p>
+ <section>
+ <title>Steps</title>
+ <p>
+ Despite all of the differences, steps for upgrading from Xindice 1.0
are all
+ the same as if upgrading from any of Xindice 1.1 betas. Please follow
the steps
+ outlined <link href="one-one.html">here</link>.
+ </p>
+ </section>
<p>If you run into problems, don't worry. Be sure to send <link
href="../../../mail.html">feedback</link> so that we can improve these
documents for the next person.</p>
</steps>
+
</howto>
Modified:
xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/one-one.xml
URL:
http://svn.apache.org/viewvc/xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/one-one.xml?view=diff&rev=530610&r1=530609&r2=530610
==============================================================================
---
xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/one-one.xml
(original)
+++
xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/one-one.xml
Thu Apr 19 18:59:36 2007
@@ -19,7 +19,7 @@
- $Id$
-->
-<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.0//EN" "howto-v10.dtd">
+<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.3//EN" "howto-v13.dtd">
<!--
- Version: $Revision$ $Date$
@@ -27,9 +27,11 @@
<howto>
<header>
<title>Xindice Release 1.1b1 Through 1.1b5 Upgrading How-To</title>
+ <version>$Revision$</version>
<authors>
<person name="Vadim Gritsenko" email="[EMAIL PROTECTED]"/>
</authors>
+ <last-modified-content-date date="$Date$"/>
</header>
<audience title="Intended audience">
@@ -38,6 +40,7 @@
upgrade of one of 1.1 beta releases of Xindice to the final 1.1 release.
</p>
</audience>
+
<prerequisites title="Prerequisites">
<p>
Shutdown. Shutdown the database before starting upgrade process.
@@ -47,132 +50,136 @@
</p>
</prerequisites>
- <steps title="Overview">
- <p>
- All Xindice 1.1 beta releases are utilising same configuration files and
backward
- compatible with the Xindice 1.1 final release. The areas where betas are
different
- are:
- </p>
- <ul>
- <li>
- Changes to BTreeFiler and HashFiler. BTreeFiler has been changed to
address
- incorrect handling of numeric indexes (see Bug #19203). HashFiler has
been changed
- to address inefficient hash function implementation. Due to these
changes,
- existing databases should be upgraded to the latest format using
supplied
- database rebuild utility.
- </li>
- <li>
- Changes to release packaging. Since Xindice 1.1, there are only two
releases
- are being shipped: source and binary. Binary release includes both
xindice.war file
- ready for deployment, as well as xindice.jar for embedded applications.
- </li>
- <li>
- Changes to Xindice scripts. Xindice now comes with two main commands,
<code>xindice</code>
- and <code>xindiced</code>. First one is a Xindice command line tool,
and second provides
- a way to start Xindice database with embedded HTTP server (Jetty).
- </li>
- </ul>
- </steps>
-
- <steps title="Procedure">
- <p>
- Upgrade procedure consists of the following:
- </p>
- <ul>
- <li>
- Install Xindice 1.1 release.
- </li>
- <li>
- Point XINDICE_HOME environment variable to the Xindice installation
directory.
- </li>
- <li>
- Copy existing database over to XINDICE_HOME/db. (Alternatively, set
environment
- variable XINDICE_DB_HOME to point to directory which contains db
directory.)
- </li>
- <li>
- In the shell, execute<br/>
- (Unix):
- <source>
- cd $XINDICE_HOME
- ./bin/xindice_rebuild rebuild db</source>
- (Windows):
- <source>
- cd %XINDICE_HOME%
- bin\xindice_rebuild rebuild db</source>
- (If using XINDICE_DB_HOME variable, substitute 'db' with
'$XINDICE_DB_HOME/db'.)
- </li>
- <li>
- Check tool output for any problems. If any of the collections or
indeces could
- not be rebuilt to new format, do not panic - just follow an alternate
approach
- outlined below.
- </li>
- <li>
- Test resulting database using command line tool.
- </li>
- </ul>
- </steps>
+ <steps title="Upgrade Steps">
+ <section>
+ <title>Overview</title>
+ <p>
+ All Xindice 1.1 beta releases are utilising same configuration files
and backward
+ compatible with the Xindice 1.1 final release. The areas where betas
are different
+ are:
+ </p>
+ <ul>
+ <li>
+ Changes to BTreeFiler and HashFiler. BTreeFiler has been changed to
address
+ incorrect handling of numeric indexes (see Bug #19203). HashFiler
has been changed
+ to address inefficient hash function implementation. Due to these
changes,
+ existing databases should be upgraded to the latest format using
supplied
+ database rebuild utility.
+ </li>
+ <li>
+ Changes to release packaging. Since Xindice 1.1, there are only two
releases
+ are being shipped: source and binary. Binary release includes both
xindice.war file
+ ready for deployment, as well as xindice.jar for embedded
applications.
+ </li>
+ <li>
+ Changes to Xindice scripts. Xindice now comes with two main
commands, <code>xindice</code>
+ and <code>xindiced</code>. First one is a Xindice command line tool,
and second provides
+ a way to start Xindice database with embedded HTTP server (Jetty).
+ </li>
+ </ul>
+ </section>
- <steps title="Alternate Procedure">
- <p>
- If any of the collections or indeces could not be converted to new
format,
- follow these steps. To migrate collections over to the new database:
- </p>
- <ul>
- <li>
- Start old Xindice database (using backed up data files).
- </li>
- <li>
- Export all documents from affected collections (replace <name>
with
- collection path):<br/>
- (Unix):
- <source>
- mkdir export
- ./bin/xindiceadmin export -c /db/<name> -f export</source>
- (Windows):
- <source>
- mkdir export
- bin\xindiceadmin export -c /db/<name> -f export</source>
- </li>
- <li>
- Stop old Xindice database.
- </li>
- <li>
- Start new database.
- </li>
- <li>
- Recreate collections in the new database.
- </li>
- <li>
- Delete corrupted collections from new database using command line
tool. This
- should also remove all data files and index files of these collections.
- </li>
- <li>
- Import all documents into the new database:<br/>
- (Unix):
- <source>
- ./bin/xindice import -c /db -f export/<name></source>
- (Windows):
- <source>
- bin\xindice import -c /db -f export\<name></source>
- </li>
- <li>
- Create all indexes which were present in the old database.
- </li>
- </ul>
- <p>
- For indeces which can not be converted:
- </p>
- <ul>
- <li>
- Start new database.
- </li>
- <li>
- Drop corrupted indeces.
- </li>
- <li>
- Recreate indeces anew.
- </li>
- </ul>
+ <section>
+ <title>Procedure</title>
+ <p>
+ Upgrade procedure consists of the following:
+ </p>
+ <ul>
+ <li>
+ Install Xindice 1.1 release.
+ </li>
+ <li>
+ Point XINDICE_HOME environment variable to the Xindice installation
directory.
+ </li>
+ <li>
+ Copy existing database over to XINDICE_HOME/db. (Alternatively, set
environment
+ variable XINDICE_DB_HOME to point to directory which contains db
directory.)
+ </li>
+ <li>
+ In the shell, execute<br/>
+ (Unix):
+ <source>
+ cd $XINDICE_HOME
+ ./bin/xindice_rebuild rebuild db</source>
+ (Windows):
+ <source>
+ cd %XINDICE_HOME%
+ bin\xindice_rebuild rebuild db</source>
+ (If using XINDICE_DB_HOME variable, substitute 'db' with
'$XINDICE_DB_HOME/db'.)
+ </li>
+ <li>
+ Check tool output for any problems. If any of the collections or
indeces could
+ not be rebuilt to new format, do not panic - just follow an
alternate approach
+ outlined below.
+ </li>
+ <li>
+ Test resulting database using command line tool.
+ </li>
+ </ul>
+ </section>
+ <section>
+ <title>Alternate Procedure</title>
+ <p>
+ If any of the collections or indeces could not be converted to new
format,
+ follow these steps. To migrate collections over to the new database:
+ </p>
+ <ul>
+ <li>
+ Start old Xindice database (using backed up data files).
+ </li>
+ <li>
+ Export all documents from affected collections (replace <name>
with
+ collection path):<br/>
+ (Unix):
+ <source>
+ mkdir export
+ ./bin/xindiceadmin export -c /db/<name> -f export</source>
+ (Windows):
+ <source>
+ mkdir export
+ bin\xindiceadmin export -c /db/<name> -f export</source>
+ </li>
+ <li>
+ Stop old Xindice database.
+ </li>
+ <li>
+ Start new database.
+ </li>
+ <li>
+ Recreate collections in the new database.
+ </li>
+ <li>
+ Delete corrupted collections from new database using command line
tool. This
+ should also remove all data files and index files of these
collections.
+ </li>
+ <li>
+ Import all documents into the new database:<br/>
+ (Unix):
+ <source>
+ ./bin/xindice import -c /db -f export/<name></source>
+ (Windows):
+ <source>
+ bin\xindice import -c /db -f export\<name></source>
+ </li>
+ <li>
+ Create all indexes which were present in the old database.
+ </li>
+ </ul>
+ <p>
+ For indeces which can not be converted:
+ </p>
+ <ul>
+ <li>
+ Start new database.
+ </li>
+ <li>
+ Drop corrupted indeces.
+ </li>
+ <li>
+ Recreate indeces anew.
+ </li>
+ </ul>
+ </section>
<p>If you run into problems, don't worry. Be sure to send <link
href="../../../mail.html">feedback</link> so that we can improve these
documents for the next person.</p>
</steps>
Modified:
xml/xindice/trunk/src/documentation/content/xdocs/dev/doc-contributing.xml
URL:
http://svn.apache.org/viewvc/xml/xindice/trunk/src/documentation/content/xdocs/dev/doc-contributing.xml?view=diff&rev=530610&r1=530609&r2=530610
==============================================================================
--- xml/xindice/trunk/src/documentation/content/xdocs/dev/doc-contributing.xml
(original)
+++ xml/xindice/trunk/src/documentation/content/xdocs/dev/doc-contributing.xml
Thu Apr 19 18:59:36 2007
@@ -19,7 +19,7 @@
- $Id$
-->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
"document-v11.dtd">
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN"
"document-v13.dtd">
<!--
- Version: $Revision$ $Date$
@@ -90,9 +90,9 @@
<code>src/documentation/content/xdocs</code> files as a live
website. Once Forrest starts everything up, you will see lines
similar to:
<source>
-22:50:44.242 EVENT Apache Cocoon 2.2.0-dev is up and ready.
-22:50:44.246 EVENT Started SocketListener on 0.0.0.0:8888
-22:50:44.246 EVENT Started [EMAIL PROTECTED]
+ 22:50:44.242 EVENT Apache Cocoon 2.2.0-dev is up and ready.
+ 22:50:44.246 EVENT Started SocketListener on 0.0.0.0:8888
+ 22:50:44.246 EVENT Started [EMAIL PROTECTED]
</source>
</li>
@@ -110,4 +110,3 @@
</section>
</body>
</document>
-
