You are viewing a plain text version of this content. The canonical link for it is here.
Posted to xindice-dev@xml.apache.org by vg...@apache.org on 2007/03/29 05:55:54 UTC
svn commit: r523547 - in /xml/xindice/trunk/src/documentation/content/xdocs:
community/howto/compilation/index.xml community/howto/compilation/unix.xml
community/howto/compilation/windows.xml dev/doc-contributing.xml
dev/news.xml dev/todo.xml
Author: vgritsenko
Date: Wed Mar 28 20:55:53 2007
New Revision: 523547
URL: http://svn.apache.org/viewvc?view=rev&rev=523547
Log:
documentation updates
Modified:
xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/index.xml
xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/unix.xml
xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/windows.xml
xml/xindice/trunk/src/documentation/content/xdocs/dev/doc-contributing.xml
xml/xindice/trunk/src/documentation/content/xdocs/dev/news.xml
xml/xindice/trunk/src/documentation/content/xdocs/dev/todo.xml
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=523547&r1=523546&r2=523547
==============================================================================
--- 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 Mar 28 20:55:53 2007
@@ -24,33 +24,34 @@
<!--
- Version: $Revision$ $Date$
-->
-
<howto>
- <header>
- <title>Xindice Compilation How-Tos</title>
- <version>1.0</version>
- <authors>
- <person name="Dave Viner" email="dviner@apache.org"/>
- <person name="Vladimir R. Bossicard" email="vladimir@apache.org"/>
- </authors>
- <last-modified-content-date date="2002-11-21"/>
- </header>
- <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>
- <steps title="Steps">
- <p>Just choose your platform, and give it a try.</p>
- <ul>
- <li>
- <link href="unix.html">Linux|*nix</link>
- </li>
- <li>
- <link href="windows.html">Windows</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>
+ <header>
+ <title>Xindice Compilation How-Tos</title>
+ <version>1.0</version>
+ <authors>
+ <person name="Dave Viner" email="dviner@apache.org"/>
+ <person name="Vladimir R. Bossicard" email="vladimir@apache.org"/>
+ </authors>
+ <last-modified-content-date date="2002-11-21"/>
+ </header>
+
+ <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>
+
+ <steps title="Steps">
+ <p>Just choose your platform, and give it a try.</p>
+ <ul>
+ <li>
+ <link href="unix.html">Linux, Mac OS X, *nix</link>
+ </li>
+ <li>
+ <link href="windows.html">Windows</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>
Modified: xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/unix.xml
URL: http://svn.apache.org/viewvc/xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/unix.xml?view=diff&rev=523547&r1=523546&r2=523547
==============================================================================
--- xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/unix.xml (original)
+++ xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/unix.xml Wed Mar 28 20:55:53 2007
@@ -24,105 +24,99 @@
<!--
- Version: $Revision$ $Date$
-->
-
<howto>
- <header>
- <title>Compiling Xindice on Unix</title>
- <version>1.0</version>
- <authors>
- <person name="Dave Viner" email="dviner@apache.org"/>
- </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 compile Xindice on Unix.</p>
- </audience>
- <purpose title="Purpose">
- <p>Following the steps of this how-to should allow you to compile Xindice on unix.</p>
- </purpose>
- <prerequisites title="Prerequisites">
- <p>See the <link href="prereqs.html">prerequisites</link> page.</p>
- </prerequisites>
- <steps title="Steps">
- <section>
- <title>Don't skip the prerequisites</title>
- <p>Be sure to follow the <link href="prereqs.html">prerequisites.</link>
- </p>
- </section>
- <section>
- <title>Verify your environment</title>
- <p>Make sure you have the JAVA_HOME environment variable set.</p>
- <source>
-quintara:~> echo $JAVA_HOME
-/usr/java/jdk1.3.1_06
-quintara:~>
- </source>
- </section>
- <section>
- <title>Compile</title>
- <p>Navigate to the location where you untarred your
- Xindice sources and run the <code>build.sh</code>
- script. Your output will resemble:
- </p>
- <source>
-quintara:/xml-xindice> ./build.sh
-
-Xindice Build System
---------------------
-
-Building with classpath java/lib/ant-1.5.1.jar:java/lib/commons-logging-1.0.
-1.jar:java/lib/infozone-tools.jar:java/lib/junit-3.8.1.jar:java/lib/junit-ad
-dons-1.1.jar:java/lib/junitperf-1.8.jar:java/lib/servlet.jar:java/lib/xalan-
-2.4.0.jar:java/lib/xercesImpl-2.1.0.jar:java/lib/xml-apis-1.0b3.jar:java/lib
-/xmldb-api-20021118.jar:java/lib/xmldb-api-sdk-20021118.jar:java/lib/xmldb-x
-update.jar:java/lib/xmlrpc-1.1.jar::/usr/java/jdk1.3.1_06/lib/tools.jar
-
-Starting Ant...
-Buildfile: ./build.xml
-
-init:
-
-src-build:
-
-test-build:
-
-examples-build:
-
-build:
-
-jar-release:
-
-war-release:
-
-examples-release:
-
-release:
-
-BUILD SUCCESSFUL
-Total time: 11 seconds
- </source>
- <warning>NOTE: Certain flavors of Unix require a space
- after the <code>#!</code> in the first line of the
- shell script. In this case, edit the <code>build.sh</code>
- file and change the first line from "<code>#!/bin/sh</code>"
- to "<code>#! /bin/sh</code>".
- </warning>
- </section>
- <section>
- <title>Verify the compilation</title>
- <p>If the compile was succeeded, you will find the output files in the dist/ subdirectory.</p>
- <source>
-quintara:~>ls -l dist
-total 2778
--rw-r--r-- 1 dviner users 9467 Nov 21 11:56 xindice-1.1b-examples.jar
--rw-r--r-- 1 dviner users 392842 Nov 21 11:56 xindice-1.1b.jar
--rw-r--r-- 1 dviner users 2421719 Nov 21 11:56 xindice-1.1b.war
-quintara:~>
- </source>
- </section>
- <section>
- <title>Feedback</title>
- <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>
- </section>
- </steps>
+ <header>
+ <title>Compiling Xindice on Unix</title>
+ <version>1.0</version>
+ <authors>
+ <person name="Dave Viner" email="dviner@apache.org"/>
+ <person name="Vadim Gritsenko" email="vgritsenko@apache.org"/>
+ </authors>
+ <last-modified-content-date date="2007-03-28"/>
+ </header>
+
+ <audience title="Intended audience">
+ <p>This How-to is aimed at developers who want to compile Xindice on Unix platform.</p>
+ </audience>
+ <purpose title="Purpose">
+ <p>Following the steps of this how-to should allow you to compile Xindice on unix platform.</p>
+ </purpose>
+ <prerequisites title="Prerequisites">
+ <p>See the <link href="prereqs.html">prerequisites</link> page.</p>
+ </prerequisites>
+
+ <steps title="Steps">
+ <section>
+ <title>Don't skip the prerequisites</title>
+ <p>Be sure to follow the <link href="prereqs.html">prerequisites.</link>
+ </p>
+ </section>
+ <section>
+ <title>Verify your environment</title>
+ <p>
+ Make sure you have the JAVA_HOME environment variable set. If you are
+ running Mac OS X, build script will attempt to guess it so you get away
+ with skipping this step.
+ </p>
+ <source>
+ quintara:~> echo $JAVA_HOME
+ /usr/java/jdk1.3.1_10
+ quintara:~>
+ </source>
+ </section>
+ <section>
+ <title>Compile</title>
+ <p>Navigate to the location where you untarred your Xindice sources
+ (or to your svn checkout of Xindice source code) and run the
+ <code>build.sh</code> script. Your output will resemble:
+ </p>
+ <source>
+ quintara:/xml-xindice> ./build.sh
+
+ Apache Xindice Build System
+ ---------------------------
+ Buildfile: ./build.xml
+
+ init:
+ [echo] Building with Java 1.3.1_10
+
+ compile-src:
+ [javac] Compiling 4 source files to /home/vgritsenko/xml-xindice/build/classes
+
+ jar:
+ [jar] Building jar: /home/vgritsenko/xml-xindice/xindice-1.1b5-dev.jar
+
+ bin:
+ [copy] Copying 2 files to /home/vgritsenko/xml-xindice/build/bin
+
+ war:
+ [war] Building war: /home/vgritsenko/xml-xindice/xindice-1.1b5-dev.war
+
+ BUILD SUCCESSFUL
+ Total time: 2 seconds
+ </source>
+ <warning>NOTE: Certain flavors of Unix require a space after the
+ <code>#!</code> in the first line of the shell script. In this case,
+ edit the <code>build.sh</code> file and change the first line from
+ "<code>#!/bin/sh</code>" to "<code>#! /bin/sh</code>".
+ </warning>
+ </section>
+ <section>
+ <title>Verify the compilation</title>
+ <p>If the compile was succeeded, you will find the output files in the current directory.</p>
+ <source>
+ quintara:~>ls -l dist
+ total 2778
+ -rw-r--r-- 1 vgritsen vgritsen 475742 Mar 28 23:35 xindice-1.1b5-dev.jar
+ -rw-r--r-- 1 vgritsen vgritsen 4279855 Mar 28 23:35 xindice-1.1b5-dev.war
+ -rw-r--r-- 1 vgritsen vgritsen 1748 Mar 27 22:31 xindice-1.1b5-dev.xml
+ -rw-r--r-- 1 vgritsen vgritsen 6503 Mar 27 22:31 xindice-dom-1.1b5-dev.jar
+ quintara:~>
+ </source>
+ </section>
+ <section>
+ <title>Feedback</title>
+ <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>
+ </section>
+ </steps>
</howto>
Modified: xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/windows.xml
URL: http://svn.apache.org/viewvc/xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/windows.xml?view=diff&rev=523547&r1=523546&r2=523547
==============================================================================
--- xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/windows.xml (original)
+++ xml/xindice/trunk/src/documentation/content/xdocs/community/howto/compilation/windows.xml Wed Mar 28 20:55:53 2007
@@ -24,151 +24,152 @@
<!--
- Version: $Revision$ $Date$
-->
-
<howto>
- <header>
- <title>Compiling Xindice on Windows</title>
- <version>1.0</version>
- <authors>
- <person name="Dave Viner" email="dviner@apache.org"/>
- </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 compile Xindice on Windows.</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>See the <link href="prereqs.html">prerequisites</link> page.</p>
- </prerequisites>
- <steps title="Steps">
- <section>
- <title>Don't skip the prerequisites</title>
- <p>Be sure to follow the <link href="prereqs.html">prerequisites.</link>
- </p>
- </section>
- <section>
- <title>Verify your environment</title>
- <p>Open a new command window. Click Start, choose Run. Enter cmd and hit return. A new command window should appear.</p>
- <p>Make sure you have the JAVA_HOME environment variable set.</p>
- <source>
-C:\>echo %JAVA_HOME%
-C:\j2sdk1.4.1_01
-
-C:\>
- </source>
- </section>
- <section>
- <title>Compile</title>
- <p>Navigate to your the location where you unzipped your Xindice sources and run the compile.</p>
- <note>This example assumes that you unzip the Xindice sources into D:\xindice\current. If you unzip the sources elsewhere, just substitute that path for D:\xindice\current.</note>
- <source>
-C:\>d:
-
-D:\>cd xindice\current\xml-xindice
-D:\xindice\current\xml-xindice>dir
- Volume in drive D is Data
- Volume Serial Number is A3EB-9689
-
- Directory of D:\xindice\current\xml-xindice
-
-11/20/2002 08:40p <DIR> .
-11/20/2002 08:40p <DIR> ..
-10/29/2002 11:59a 1,507 .classpath
-10/29/2002 11:59a 64 .cvsignore
-10/29/2002 11:59a 387 .project
-11/18/2002 01:41p <DIR> bin
-11/20/2002 10:20a <DIR> build
-12/06/2001 10:33a 864 build.bat
-10/26/2002 05:06p 431 build.properties.sample
-10/25/2002 01:18a 753 build.sh
-11/18/2002 01:41p 14,109 build.xml
-11/20/2002 02:43p <DIR> classes
-11/18/2002 01:41p <DIR> config
-10/25/2002 12:33a 348 contributor.properties.sample
-10/25/2002 12:33a 2,268 contributor.xml
-11/20/2002 03:51p <DIR> CVS
-11/01/2002 03:53p <DIR> deploy
-11/18/2002 01:55p <DIR> dist
-11/20/2002 03:51p <DIR> docs
-11/20/2002 08:40p 15 fclean.bat
-11/01/2002 01:52p 1,026 forrest.properties
-11/20/2002 03:51p <DIR> java
-12/06/2001 11:22a 2,743 LICENSE
-12/06/2001 10:33a 230 README
-11/18/2002 01:42p <DIR> src
-11/01/2002 01:52p 3,668 status.xml
- 15 File(s) 28,797 bytes
- 12 Dir(s) 6,087,512,064 bytes free
-
-D:\xindice\current\xml-xindice>build
-
-Xindice Build System
-
-Building with classpath C:\j2sdk1.4.1_01\lib\tools.jar;.\java\lib\ant-1.5.1.jar;
-.\java\lib\commons-logging-1.0.1.jar;.\java\lib\infozone-tools.jar;.\java\lib\ja
-karta-oro-2.0.6.jar;.\java\lib\junit-3.8.1.jar;.\java\lib\junit-addons-1.1.jar;.
-\java\lib\junitperf-1.8.jar;.\java\lib\servlet.jar;.\java\lib\xalan-2.4.0.jar;.\
-java\lib\xercesImpl-2.1.0.jar;.\java\lib\xindice.jar;.\java\lib\xml-apis-1.0b3.j
-ar;.\java\lib\xmldb-api-20021118.jar;.\java\lib\xmldb-api-sdk-20021118.jar;.\jav
-a\lib\xmldb-xupdate.jar;.\java\lib\xmlrpc-1.1.jar
-
-Starting Ant...
-Buildfile: build.xml
-
-init:
-
-src-build:
-
-test-build:
-
-examples-build:
-
-build:
-
-jar-release:
-
-war-release:
-
-examples-release:
-
-release:
-
-BUILD SUCCESSFUL
-Total time: 7 seconds
-
-D:\xindice\current\xml-xindice>
- </source>
- <note>Your compile will probably show a few more lines reporting that some files were compiled. I omitted those for brevity.</note>
- </section>
- <section>
- <title>Verify the compilation</title>
- <p>If the compile was succeeded, you will find the output files in the dist\ subdirectory.</p>
- <source>
-D:\xindice\current\xml-xindice>dir dist
- Volume in drive D is Data
- Volume Serial Number is A3EB-9689
-
- Directory of D:\xindice\current\xml-xindice\dist
-
-11/18/2002 01:55p <DIR> .
-11/18/2002 01:55p <DIR> ..
-11/18/2002 01:55p 9,467 xindice-1.1b-examples.jar
-11/20/2002 03:57p 392,842 xindice-1.1b.jar
-11/20/2002 03:57p 2,421,719 xindice-1.1b.war
- 3 File(s) 2,824,028 bytes
- 2 Dir(s) 6,090,211,328 bytes free
-
-D:\xindice\current\xml-xindice>
- </source>
- </section>
- <section>
- <title>Feedback</title>
- <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>
- </section>
- </steps>
+ <header>
+ <title>Compiling Xindice on Windows</title>
+ <version>1.0</version>
+ <authors>
+ <person name="Dave Viner" email="dviner@apache.org"/>
+ </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 compile Xindice on Windows.</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>See the <link href="prereqs.html">prerequisites</link> page.</p>
+ </prerequisites>
+
+ <steps title="Steps">
+ <section>
+ <title>Don't skip the prerequisites</title>
+ <p>Be sure to follow the <link href="prereqs.html">prerequisites.</link>
+ </p>
+ </section>
+ <section>
+ <title>Verify your environment</title>
+ <p>
+ Open a new command window. Click Start, choose Run. Enter cmd and hit
+ return. A new command window should appear.
+ </p>
+ <p>
+ Make sure you have the JAVA_HOME environment variable set.
+ </p>
+ <source>
+ C:\>echo %JAVA_HOME%
+ C:\j2sdk1.4.1_01
+
+ C:\>
+ </source>
+ </section>
+ <section>
+ <title>Compile</title>
+ <p>
+ Navigate to your the location where you unzipped your Xindice sources
+ and run the compile.
+ </p>
+ <note>
+ This example assumes that you unzip the Xindice sources into
+ D:\xindice\current. If you unzip the sources elsewhere, just
+ substitute that path for D:\xindice\current.</note>
+ <source>
+ C:\>d:
+
+ D:\>cd xindice\current\xml-xindice
+ D:\xindice\current\xml-xindice>dir
+ Volume in drive D is Data
+ Volume Serial Number is A3EB-9689
+
+ Directory of D:\xindice\current\xml-xindice
+
+ 11/20/2002 08:40p <DIR> .
+ 11/20/2002 08:40p <DIR> ..
+ 10/29/2002 11:59a 1,507 .classpath
+ 10/29/2002 11:59a 64 .cvsignore
+ 10/29/2002 11:59a 387 .project
+ 11/18/2002 01:41p <DIR> bin
+ 11/20/2002 10:20a <DIR> build
+ 12/06/2001 10:33a 864 build.bat
+ 10/26/2002 05:06p 431 build.properties.sample
+ 10/25/2002 01:18a 753 build.sh
+ 11/18/2002 01:41p 14,109 build.xml
+ 11/20/2002 02:43p <DIR> classes
+ 11/18/2002 01:41p <DIR> config
+ 10/25/2002 12:33a 348 contributor.properties.sample
+ 10/25/2002 12:33a 2,268 contributor.xml
+ 11/01/2002 03:53p <DIR> deploy
+ 11/20/2002 03:51p <DIR> docs
+ 11/20/2002 08:40p 15 fclean.bat
+ 11/01/2002 01:52p 1,026 forrest.properties
+ 11/20/2002 03:51p <DIR> java
+ 12/06/2001 11:22a 2,743 LICENSE
+ 12/06/2001 10:33a 230 README
+ 11/18/2002 01:42p <DIR> src
+ 11/01/2002 01:52p 3,668 status.xml
+ 15 File(s) 28,797 bytes
+ 12 Dir(s) 6,087,512,064 bytes free
+
+ D:\xindice\current\xml-xindice>build
+
+ Xindice Build System
+
+ Buildfile: build.xml
+
+ init:
+
+ src-build:
+
+ test-build:
+
+ examples-build:
+
+ build:
+
+ jar-release:
+
+ war-release:
+
+ examples-release:
+
+ release:
+
+ BUILD SUCCESSFUL
+ Total time: 7 seconds
+
+ D:\xindice\current\xml-xindice>
+ </source>
+ <note>
+ Your compile will probably show a few more lines reporting that some
+ files were compiled. I omitted those for brevity.
+ </note>
+ </section>
+ <section>
+ <title>Verify the compilation</title>
+ <p>If the compile was succeeded, you will find the output files in the current directory.</p>
+ <source>
+ D:\xindice\current\xml-xindice>dir
+ Volume in drive D is Data
+ Volume Serial Number is A3EB-9689
+
+ Directory of D:\xindice\current\xml-xindice
+
+ 11/18/2002 01:55p <DIR> .
+ 11/18/2002 01:55p <DIR> ..
+ 11/20/2002 03:57p 392,842 xindice-1.1b5-dev.jar
+ 11/20/2002 03:57p 2,421,719 xindice-1.1b5-dev.war
+ 11/20/2002 03:57p 1,748 xindice-1.1b5-dev.xml
+ 11/20/2002 03:57p 6,503 xindice-dom-1.1b5-dev.jar
+ </source>
+ </section>
+ <section>
+ <title>Feedback</title>
+ <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>
+ </section>
+ </steps>
</howto>
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=523547&r1=523546&r2=523547
==============================================================================
--- xml/xindice/trunk/src/documentation/content/xdocs/dev/doc-contributing.xml (original)
+++ xml/xindice/trunk/src/documentation/content/xdocs/dev/doc-contributing.xml Wed Mar 28 20:55:53 2007
@@ -25,13 +25,13 @@
- Version: $Revision$ $Date$
- Author: Vladimir R. Bossicard (vladimir@apache.org)
-->
-
<document>
<header>
<title>Documentation: How to contribute</title>
<version>$Revision$</version>
<authors>
<person name="Vladimir R. Bossicard" email="vladimir@apache.org"/>
+ <person name="Vadim Gritsenko" email="vgritsenko@apache.org"/>
</authors>
</header>
@@ -39,28 +39,27 @@
<section>
<title>General rules</title>
<p>
- Writing the documentation is a team effort so let's
- first set some basic rules to prevent a mess:
+ Writing the documentation is a team effort so let's first set some
+ basic rules to prevent a mess:
</p>
<ul>
<li>Keep consistent indentation!</li>
<li>
- If you write a complete document or participate
- substancially to one, please add your name to the
- <code><header><authors></code> list.
+ If you write a complete document or participate substantially to one,
+ please add your name to the <code><header><authors></code>
+ list.
</li>
<li>
- If you only contribute partially to the document
- (correcting errors), please add your name to the
- <code>Author:</code> list.
+ If you only contribute partially to the document (correcting errors),
+ please add your name to the <code>Author:</code> list.
</li>
</ul>
<note>
- If you know an Open Source XML beautifier that can be
- used in our build process, please drop <link
- href="mailto:vladimir@apache.org">me</link> a line!
+ If you know an Open Source XML beautifier that can be used in our build
+ process, please drop <link href="mailto:vladimir@apache.org">me</link>
+ a line!
</note>
</section>
@@ -69,69 +68,40 @@
<p>
The Xindice website and documentation are generated using the <link
- href="http://xml.apache.org/forrest">Forrest</link>
- tool. If you are new to Forrest, please read the <link
+ href="http://xml.apache.org/forrest">Forrest</link> tool (currently,
+ it s built using upcoming Forrest 0.8 version). If you are new to
+ Forrest, please read the <link
href="http://xml.apache.org/forrest/your-project.html">Using
- Forrest</link> guide to get you started. After several
- tries, I recommand the following settings:
+ Forrest</link> guide to get you started. After you install Forrest,
+ you can start editing Xindice documentation by following these simple
+ steps:
</p>
<ul>
<li>
- Generate the documentation as a webapp by invoking
- <code>forrest webapp</code> from the xml-xindice
- repository.
+ Start Forrest up by invoking <code>forrest run</code> from the
+ xml-xindice repository.
</li>
<li>
- Forrest copies the
- <code>src/documentation/content/xdocs</code> files
- into the <code>build/webapp/content/xdocs</code>
- directory. If you want to only work with the
- <code>src</code> directory, you will need to
- create links. The directories/files that need to
- be linked (and deleted from the webapp) are:
+ Forrest automatically loads required plugins, prepares
+ <code>build/tmp</code> and <code>build/webapp</code> directories,
+ and starts web application serving contents of
+ <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 org.mortbay.jetty.Server@42a80d
+ </source>
</li>
- <ul>
- <li>
- <code>skinconf.xml</code>
- </li>
- <li>
- <code>status.xml</code>
- </li>
- <li>
- <code>content/xdocs</code>
- </li>
- <li>
- <code>resources/images</code>
- </li>
- </ul>
-
- <li>
- Rename the <code>build/webapp</code> into another
- name: this will prevent you from deleting the
- documentation with a call to <code>ant
- clean</code>...
- </li>
<li>
- Add the following context to the
- <code>${TOMCAT_HOME}/conf/server.xml</code> configuration file:
+ Now you can open up <link href="http://localhost:8888">localhost:8888</link>
+ and edit the source from the <code>src/documentation/content/xdocs</code>
+ folder.
</li>
</ul>
- <!-- TODO the source should be included in the li tag -->
- <source><![CDATA[
- <Context path="/Xindice-documentation"
- docBase="${path-to-the-webapp-documentation}/webapp"
- reloadable="true"/>
- ]]></source>
-
- <p>
- After restarting Tomcat, you can browse the documentation on <link
- href="http://localhost:8888/Xindice-documentation">
- localhost:8888/Xindice-documentation</link> and edit
- the source from the <code>src/documentation</code> folder.
- </p>
<p>
Have fun!
Modified: xml/xindice/trunk/src/documentation/content/xdocs/dev/news.xml
URL: http://svn.apache.org/viewvc/xml/xindice/trunk/src/documentation/content/xdocs/dev/news.xml?view=diff&rev=523547&r1=523546&r2=523547
==============================================================================
--- xml/xindice/trunk/src/documentation/content/xdocs/dev/news.xml (original)
+++ xml/xindice/trunk/src/documentation/content/xdocs/dev/news.xml Wed Mar 28 20:55:53 2007
@@ -35,6 +35,11 @@
<body>
<ul>
<li>
+ <strong>March 2007</strong>:
+ Xindice test suite is set up to run on Sunday with code coverage report
+ <link href="http://xml.apache.org/xindice/coverage/">posted online</link>.
+ </li>
+ <li>
<strong>23 February 2007</strong>:
Updated Xindice site to work with Forrest 0.8-dev (trunk).
</li>
Modified: xml/xindice/trunk/src/documentation/content/xdocs/dev/todo.xml
URL: http://svn.apache.org/viewvc/xml/xindice/trunk/src/documentation/content/xdocs/dev/todo.xml?view=diff&rev=523547&r1=523546&r2=523547
==============================================================================
--- xml/xindice/trunk/src/documentation/content/xdocs/dev/todo.xml (original)
+++ xml/xindice/trunk/src/documentation/content/xdocs/dev/todo.xml Wed Mar 28 20:55:53 2007
@@ -25,7 +25,6 @@
- Version: $Revision$ $Date$
- Author: Vladimir R. Bossicard (vladimir@apache.org)
-->
-
<document>
<header>
<title>Dev Todo List</title>
@@ -46,7 +45,8 @@
end of the millenium, choose your task!
</p>
<p>
- Some plan items duplicating items from the main TODO page.
+ Some plan items duplicating items from the main <link
+ href="../todo.html">todo page</link>.
</p>
</section>
@@ -62,6 +62,13 @@
to release 1.1.
</li>
<li>
+ <strong>Hash Filer</strong> Replace HashFiler's hash function implementation
+ with Java's hash function which gives better distribution. Such change to hash
+ filer means that DatabaseRebuild tool should be updated to support rebuilding
+ of hash filer backed collections. Once all this is done, hash filer can be
+ un-deprecated.
+ </li>
+ <li>
...
</li>
</ul>
@@ -92,14 +99,15 @@
dirty data can not be placed in the cache.
</li>
<li>
- <strong>Admin Tool</strong> Extend admin tool to provide
- database consistency check, recovery operations.
+ <strong>Admin Tool</strong> DatabaseRebuild utility implements just one of
+ low level database administration tasks. Implement tasks for checking
+ database consistency, database recovery, and any other low level tasks
+ and combine them all as a single <code>xindiceadmin</code> tool.
</li>
<li>
<strong>Paged</strong> Introduce Paged interface to separate logical Hash
- and Tree structures from the physical storage mechanism. Implement
- nio based Paged as an option in addition to existing raf
- based Paged.
+ and Tree structures from the physical storage mechanism. Implement nio
+ based Paged as an option in addition to existing raf based Paged.
</li>
<li>
<strong>FullText</strong> Implement full text indexing and searching.
@@ -110,6 +118,35 @@
catalogue and utilize it. Catalogue management operations should be made
available via Collection API.
</li>
+ <li>
+ <strong>Meta Data</strong> Review handling of creation, modification
+ timestamps. This information should be primarily stored in the Filer's Record,
+ and made available to the meta data service. This way a change to the document
+ will require only single write to document collection, instead of two writes
+ as currently is the case.
+ </li>
+ <li>
+ <strong>Inline Meta Data</strong> Review handling of inline meta data. Currently
+ it stores only <code>XML/Binary</code> bit, which can be made part of page header
+ which already stores information such as creation and modification timestamp.
+ This would also increase overall performance as data won't be copied by inline
+ meta service implementation.
+ </li>
+ <li>
+ <strong>Configuration</strong> It would be nice to implement user configurable
+ default configuration parameters for all filers and collections, so that
+ system or meta collections filers can be created with parameters specified by
+ user instead of always using constants built into filer's code.
+ </li>
+ <li>
+ ...
+ </li>
+ </ul>
+ </section>
+
+ <section>
+ <title>Xindice 1.3 Release Plan</title>
+ <ul>
<li>
...
</li>