Author: vgritsenko Date: Wed Apr 18 18:53:00 2007 New Revision: 530224 URL: http://svn.apache.org/viewvc?view=rev&rev=530224 Log: draft upgrading documentation
Added: xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/ xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/book.xml (with props) xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/index.xml (with props) xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/one-oh.xml (with props) xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/one-one.xml (with props) Modified: xml/xindice/trunk/src/documentation/content/xdocs/community/howto/book.xml xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/book.xml xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/index.xml xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/prereqs.xml xml/xindice/trunk/src/documentation/content/xdocs/community/howto/installation/book.xml Modified: xml/xindice/trunk/src/documentation/content/xdocs/community/howto/book.xml URL: http://svn.apache.org/viewvc/xml/xindice/trunk/src/documentation/content/xdocs/community/howto/book.xml?view=diff&rev=530224&r1=530223&r2=530224 ============================================================================== --- xml/xindice/trunk/src/documentation/content/xdocs/community/howto/book.xml (original) +++ xml/xindice/trunk/src/documentation/content/xdocs/community/howto/book.xml Wed Apr 18 18:53:00 2007 @@ -26,15 +26,29 @@ - Author: Vladimir R. Bossicard ([EMAIL PROTECTED]) - Author: Dave Viner ([EMAIL PROTECTED]) --> +<book software="Xindice" + title="Xindice installation HOWTOs" + copyright="2002 The Apache Foundation"> -<book software="Xindice" title="Xindice installation HOWTOs" copyright="2002 The Apache Foundation" xmlns:xlink="http://www.w3.org/1999/xlink"> + <menu label="How-Tos"> + <menu-item label="Overview" href="index.html"/> + </menu> - <menu label="Compilation How-Tos"> - <menu-item label="Unix" href="compilation/unix.html"/> - <menu-item label="Windows" href="compilation/windows.html"/> - </menu> + <menu label="Compilation"> + <menu-item label="Introduction" href="compilation/index.html"/> + <menu-item label="Prerequisites" href="compilation/prereqs.html"/> + <menu-item label="Unix" href="compilation/unix.html"/> + <menu-item label="Windows" href="compilation/windows.html"/> + </menu> + + <menu label="Installation"> + <menu-item label="Tomcat How-to" href="installation/tomcat.html"/> + </menu> + + <menu label="Upgrading"> + <menu-item label="Overview" href="upgrading/index.html"/> + <menu-item label="1.1b1 and up" href="upgrading/one-one.html"/> + <menu-item label="1.0" href="upgrading/one-oh.html"/> + </menu> - <menu label="Installation How-Tos"> - <menu-item label="Tomcat How-to" href="installation/tomcat.html"/> - </menu> </book> Modified: xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/book.xml URL: http://svn.apache.org/viewvc/xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/book.xml?view=diff&rev=530224&r1=530223&r2=530224 ============================================================================== --- xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/book.xml (original) +++ xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/book.xml Wed Apr 18 18:53:00 2007 @@ -26,15 +26,29 @@ - Author: Vladimir R. Bossicard ([EMAIL PROTECTED]) - Author: Dave Viner ([EMAIL PROTECTED]) --> +<book software="Xindice" + title="Xindice compilation HOWTOs" + copyright="2002 The Apache Foundation"> + + <menu label="How-Tos"> + <menu-item label="Overview" href="../index.html"/> + </menu> + + <menu label="Compilation"> + <menu-item label="Introduction" href="index.html"/> + <menu-item label="Prerequisites" href="prereqs.html"/> + <menu-item label="Unix" href="unix.html"/> + <menu-item label="Windows" href="windows.html"/> + </menu> + + <menu label="Installation"> + <menu-item label="Tomcat How-to" href="../installation/tomcat.html"/> + </menu> + + <menu label="Upgrading"> + <menu-item label="Overview" href="../upgrading/index.html"/> + <menu-item label="1.1b1 and up" href="../upgrading/one-one.html"/> + <menu-item label="1.0" href="../upgrading/one-oh.html"/> + </menu> -<book software="Xindice" title="Xindice compilation HOWTOs" copyright="2002 The Apache Foundation" xmlns:xlink="http://www.w3.org/1999/xlink"> - <menu label="How-Tos"> - <menu-item label="Index" href="../index.html"/> - </menu> - <menu label="Compilation How-Tos"> - <menu-item label="Introduction" href="index.html"/> - <menu-item label="Prerequisites" href="prereqs.html"/> - <menu-item label="Unix" href="unix.html"/> - <menu-item label="Windows" href="windows.html"/> - </menu> </book> Modified: xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/index.xml URL: http://svn.apache.org/viewvc/xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/index.xml?view=diff&rev=530224&r1=530223&r2=530224 ============================================================================== --- xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/index.xml (original) +++ xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/index.xml Wed Apr 18 18:53:00 2007 @@ -38,6 +38,7 @@ <audience title="Intended audience"> <p>These How-tos are aimed at developers who want to compile Xindice sources on their local platform.</p> </audience> + <prerequisites title="Prerequisites"> <p>The most important prerequisite is patience. Take lots of deep breaths. It will work. It just might take some time.</p> </prerequisites> Modified: xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/prereqs.xml URL: http://svn.apache.org/viewvc/xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/prereqs.xml?view=diff&rev=530224&r1=530223&r2=530224 ============================================================================== --- xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/prereqs.xml (original) +++ xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/prereqs.xml Wed Apr 18 18:53:00 2007 @@ -24,27 +24,33 @@ <!-- - Version: $Revision$ $Date$ --> - <howto> - <header> - <title>Compilation Prerequisites</title> - <version>1.0</version> - <authors> - <person name="Dave Viner" email="[EMAIL PROTECTED]"/> - </authors> - <last-modified-content-date date="2002-11-21"/> - </header> - <audience title="Intended audience"> - <p>This How-to is aimed at developers who want to prepare for compiling the Xindice sources.</p> - </audience> - <purpose title="Purpose"> - <p> Following the steps of this how-to should allow you to compile Xindice on windows.</p> - </purpose> - <prerequisites title="Prerequisites"> - <p>All you need is an internet connection and some patience.</p> - </prerequisites> - <steps title="Steps"> - <p>Obtain a working version of the JDK 1.3 or higher. You can get the jdk from lots of places, one of which is <fork href="http://java.sun.com/j2se/downloads.html">Sun</fork>.</p> - <p>Obtain the Xindice <link href="../../../download.html">sources</link> from the download page.</p> - </steps> + <header> + <title>Compilation Prerequisites</title> + <version>1.0</version> + <authors> + <person name="Dave Viner" email="[EMAIL PROTECTED]"/> + </authors> + <last-modified-content-date date="2002-11-21"/> + </header> + + <audience title="Intended audience"> + <p>This How-to is aimed at developers who want to prepare for compiling the Xindice sources.</p> + </audience> + + <purpose title="Purpose"> + <p> Following the steps of this how-to should allow you to compile Xindice on windows.</p> + </purpose> + + <prerequisites title="Prerequisites"> + <p>All you need is an internet connection and some patience.</p> + </prerequisites> + + <steps title="Steps"> + <p> + Obtain a working version of the JDK 1.3 or higher. You can get the jdk + from lots of places, one of which is <fork href="http://java.sun.com/j2se/downloads.html">Sun</fork>. + </p> + <p>Obtain the Xindice <link href="../../../download.html">sources</link> from the download page.</p> + </steps> </howto> Modified: xml/xindice/trunk/src/documentation/content/xdocs/community/howto/installation/book.xml URL: http://svn.apache.org/viewvc/xml/xindice/trunk/src/documentation/content/xdocs/community/howto/installation/book.xml?view=diff&rev=530224&r1=530223&r2=530224 ============================================================================== --- xml/xindice/trunk/src/documentation/content/xdocs/community/howto/installation/book.xml (original) +++ xml/xindice/trunk/src/documentation/content/xdocs/community/howto/installation/book.xml Wed Apr 18 18:53:00 2007 @@ -25,11 +25,29 @@ - Version: $Revision$ $Date$ - Author: Vladimir R. Bossicard ([EMAIL PROTECTED]) --> +<book software="Xindice" + title="Xindice installation HOWTOs" + copyright="2002 The Apache Foundation"> -<book software="Xindice" title="Xindice installation HOWTOs" copyright="2002 The Apache Foundation" xmlns:xlink="http://www.w3.org/1999/xlink"> + <menu label="How-Tos"> + <menu-item label="Overview" href="../index.html"/> + </menu> - <menu label="How-Tos"> - <menu-item label="Index" href="../index.html"/> - </menu> + <menu label="Compilation"> + <menu-item label="Introduction" href="../compilation/index.html"/> + <menu-item label="Prerequisites" href="../compilation/prereqs.html"/> + <menu-item label="Unix" href="../compilation/unix.html"/> + <menu-item label="Windows" href="../compilation/windows.html"/> + </menu> + + <menu label="Installation"> + <menu-item label="Tomcat How-to" href="tomcat.html"/> + </menu> + + <menu label="Upgrading"> + <menu-item label="Overview" href="../upgrading/index.html"/> + <menu-item label="1.1b1 and up" href="../upgrading/one-one.html"/> + <menu-item label="1.0" href="../upgrading/one-oh.html"/> + </menu> </book> Added: xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/book.xml URL: http://svn.apache.org/viewvc/xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/book.xml?view=auto&rev=530224 ============================================================================== --- xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/book.xml (added) +++ xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/book.xml Wed Apr 18 18:53:00 2007 @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + - Licensed to the Apache Software Foundation (ASF) under one or more + - contributor license agreements. See the NOTICE file distributed with + - this work for additional information regarding copyright ownership. + - The ASF licenses this file to You under the Apache License, Version 2.0 + - (the "License"); you may not use this file except in compliance with + - the License. You may obtain a copy of the License at + - + - http://www.apache.org/licenses/LICENSE-2.0 + - + - Unless required by applicable law or agreed to in writing, software + - distributed under the License is distributed on an "AS IS" BASIS, + - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + - See the License for the specific language governing permissions and + - limitations under the License. + - + - $Id$ + --> + +<!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN" "book-cocoon-v10.dtd"> + +<!-- + - Version: $Revision$ $Date$ + - Author: Vladimir R. Bossicard ([EMAIL PROTECTED]) + --> +<book software="Xindice" + title="Xindice upgrading HOWTOs" + copyright="2002 The Apache Foundation"> + + <menu label="How-Tos"> + <menu-item label="Overview" href="../index.html"/> + </menu> + + <menu label="Compilation"> + <menu-item label="Introduction" href="../compilation/index.html"/> + <menu-item label="Prerequisites" href="../compilation/prereqs.html"/> + <menu-item label="Unix" href="../compilation/unix.html"/> + <menu-item label="Windows" href="../compilation/windows.html"/> + </menu> + + <menu label="Installation"> + <menu-item label="Tomcat How-to" href="../installation/tomcat.html"/> + </menu> + + <menu label="Upgrading"> + <menu-item label="Overview" href="index.html"/> + <menu-item label="1.1b1 and up" href="one-one.html"/> + <menu-item label="1.0" href="one-oh.html"/> + </menu> + +</book> Propchange: xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/book.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/book.xml ------------------------------------------------------------------------------ svn:keywords = Id Revision Author Date Added: 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=auto&rev=530224 ============================================================================== --- xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/index.xml (added) +++ xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/index.xml Wed Apr 18 18:53:00 2007 @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + - Licensed to the Apache Software Foundation (ASF) under one or more + - contributor license agreements. See the NOTICE file distributed with + - this work for additional information regarding copyright ownership. + - The ASF licenses this file to You under the Apache License, Version 2.0 + - (the "License"); you may not use this file except in compliance with + - the License. You may obtain a copy of the License at + - + - http://www.apache.org/licenses/LICENSE-2.0 + - + - Unless required by applicable law or agreed to in writing, software + - distributed under the License is distributed on an "AS IS" BASIS, + - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + - See the License for the specific language governing permissions and + - limitations under the License. + - + - $Id$ + --> + +<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.0//EN" "howto-v10.dtd"> + +<!-- + - Version: $Revision$ $Date$ + --> +<howto> + <header> + <title>Xindice Upgrading How-Tos</title> + <authors> + <person name="Vadim Gritsenko" email="[EMAIL PROTECTED]"/> + </authors> + </header> + + <audience title="Intended audience"> + <p> + These How-tos are aimed at developers or administrator performing + upgrade of older release of Xindice to the newer ones. + </p> + </audience> + <prerequisites title="Prerequisites"> + <p> + Backup. Always back up your database before starting an upgrade. + </p> + <p> + Shutdown. Shutdown the database before starting an upgrade. + </p> + </prerequisites> + + <steps title="Upgrading to Xindice 1.1"> + <p>Pick the version you are currently running, and follow the steps.</p> + <ul> + <li> + <link href="one-one.html">Xindice 1.1b1 through 1.1b5</link> + </li> + <li> + <link href="one-oh.html">Xindice 1.0</link> + </li> + </ul> + + <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> Propchange: xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/index.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/index.xml ------------------------------------------------------------------------------ svn:keywords = Id Revision Author Date Added: 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=auto&rev=530224 ============================================================================== --- xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/one-oh.xml (added) +++ xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/one-oh.xml Wed Apr 18 18:53:00 2007 @@ -0,0 +1,83 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + - Licensed to the Apache Software Foundation (ASF) under one or more + - contributor license agreements. See the NOTICE file distributed with + - this work for additional information regarding copyright ownership. + - The ASF licenses this file to You under the Apache License, Version 2.0 + - (the "License"); you may not use this file except in compliance with + - the License. You may obtain a copy of the License at + - + - http://www.apache.org/licenses/LICENSE-2.0 + - + - Unless required by applicable law or agreed to in writing, software + - distributed under the License is distributed on an "AS IS" BASIS, + - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + - See the License for the specific language governing permissions and + - limitations under the License. + - + - $Id$ + --> + +<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.0//EN" "howto-v10.dtd"> + +<!-- + - Version: $Revision$ $Date$ + --> +<howto> + <header> + <title>Xindice Release 1.0 Upgrading How-To</title> + <authors> + <person name="Vadim Gritsenko" email="[EMAIL PROTECTED]"/> + </authors> + </header> + + <audience title="Intended audience"> + <p> + This How-to is aimed at developers or administrator performing + 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. + </p> + <p> + Backup. Always back up your database before starting an upgrade. + </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> + <li> + Something else? + </li> + </ul> + </steps> + + <steps title="Steps"> + <p>Follow procedure:</p> + <ul> + <li>Do this + </li> + <li>And this + </li> + </ul> + + <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> Propchange: xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/one-oh.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/one-oh.xml ------------------------------------------------------------------------------ svn:keywords = Id Revision Author Date Added: 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=auto&rev=530224 ============================================================================== --- xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/one-one.xml (added) +++ xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/one-one.xml Wed Apr 18 18:53:00 2007 @@ -0,0 +1,114 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + - Licensed to the Apache Software Foundation (ASF) under one or more + - contributor license agreements. See the NOTICE file distributed with + - this work for additional information regarding copyright ownership. + - The ASF licenses this file to You under the Apache License, Version 2.0 + - (the "License"); you may not use this file except in compliance with + - the License. You may obtain a copy of the License at + - + - http://www.apache.org/licenses/LICENSE-2.0 + - + - Unless required by applicable law or agreed to in writing, software + - distributed under the License is distributed on an "AS IS" BASIS, + - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + - See the License for the specific language governing permissions and + - limitations under the License. + - + - $Id$ + --> + +<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.0//EN" "howto-v10.dtd"> + +<!-- + - Version: $Revision$ $Date$ + --> +<howto> + <header> + <title>Xindice Release 1.1b1 Through 1.1b5 Upgrading How-To</title> + <authors> + <person name="Vadim Gritsenko" email="[EMAIL PROTECTED]"/> + </authors> + </header> + + <audience title="Intended audience"> + <p> + This How-to is aimed at developers or administrator performing + 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. + </p> + <p> + Backup. Always back up your database before starting an upgrade. + </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. + </li> + <li> + Test resulting database using command line tool. + </li> + </ul> + + <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> Propchange: xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/one-one.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: xml/xindice/trunk/src/documentation/content/xdocs/community/howto/upgrading/one-one.xml ------------------------------------------------------------------------------ svn:keywords = Id Revision Author Date