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 vl...@apache.org on 2002/11/24 01:33:47 UTC
cvs commit: xml-xindice/src/documentation/content/xdocs/community/howto/compilation compilation.xml
vladimir 2002/11/23 16:33:46
Modified: src/documentation/content/xdocs/community/howto book.xml
Added: src/documentation/content/xdocs/community/howto/compilation
compilation.xml
Log:
New essai for a compilation howto
Revision Changes Path
1.4 +11 -2 xml-xindice/src/documentation/content/xdocs/community/howto/book.xml
Index: book.xml
===================================================================
RCS file: /home/cvs/xml-xindice/src/documentation/content/xdocs/community/howto/book.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- book.xml 22 Nov 2002 19:39:25 -0000 1.3
+++ book.xml 24 Nov 2002 00:33:46 -0000 1.4
@@ -1,16 +1,25 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN" "book-cocoon-v10.dtd">
+
<!--
- Version: $Revision$ $Date$
- Author: Vladimir R. Bossicard (vladimir@apache.org)
- Author: Dave Viner (dviner@apache.org)
-->
+
<book software="Xindice" title="Xindice installation HOWTOs" copyright="2002 The Apache Foundation" xmlns:xlink="http://www.w3.org/1999/xlink">
+
<menu label="Compilation How-Tos">
- <menu-item label="Windows" href="compilation/windows.html"/>
<menu-item label="Unix" href="compilation/unix.html"/>
+ <menu-item label="Windows" href="compilation/windows.html"/>
+ </menu>
+
+ <menu label="General How-Tos">
+ <menu-item label="Compilation How-to" href="compilation/compilation.html"/>
</menu>
+
<menu label="Installation How-Tos">
<menu-item label="Tomcat How-to" href="installation/tomcat.html"/>
</menu>
+
</book>
1.1 xml-xindice/src/documentation/content/xdocs/community/howto/compilation/compilation.xml
Index: compilation.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.0//EN" "howto-v10.dtd">
<!--
- Version: $Revision: 1.1 $ $Date: 2002/11/24 00:33:46 $
-->
<howto>
<header>
<title>Compiling Xindice</title>
<version>1.0</version>
<authors>
<person name="Vldimir R. Bossicard" email="vladimir@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 from the
source distribution, a nightly snapshot or from a CVS checkout.
</p>
<note>
The steps are described for a Linux/*nix environment.
Windows users must simply replace the file separators and environment variables
accordinguely.
</note>
</audience>
<prerequisites title="Prerequisites">
<ul>
<li>The Xindice source code, available as a
<link href="http://xml.apache.org/xindice/download.html">downloadable archive</link> or via
<link href="http://xml.apache.org/cvs.html">CVS checkout</link>.
</li>
<li>The Java JDK Standard Edition, version 1.2 or higher correctly installed.</li>
<li>The
<code>${JAVA_HOME}</code> environment variable correctly set.
</li>
</ul>
</prerequisites>
<steps title="Steps">
<section>
<title>Unpack the distribution</title>
<p>
If you have downloaded the source archive, you first have to unpack it using either unzip:
</p>
<source><![CDATA[
unzip xindice-src-X.Y.zip
]]></source>
<p>or tar:</p>
<source><![CDATA[
tar zxf xindice-src-X.Y.tar.gz
]]></source>
<note>The folder names are different</note>
</section>
<section>
<title>Compile the source</title>
<p>Navigate to the root of your unpacked Xindice directory. Note that all
directory references will be relative to this directory. To compile and create
the jar files, simply type:
</p>
<source><![CDATA[
$ ./build.sh [ Unix ]
> build [ Windows ]
]]></source>
<p>The output looks like:</p>
<source><![CDATA[
]]></source>
</section>
<section>
<title>Verify the compilation</title>
<p>Xindice comes with a series of tests that you can run to make sure that the
If the compile was succeeded, you will find the output files in the
<code>dist</code> subdirectory.
</p>
<source><![CDATA[
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>
<p>
You are now ready to install Xindice. See the
<a href="../index.html">Installation How-Tos</a> for more details.
</p>
</section>
<section>
<title>Clean the compilation</title>
<p>
Simply delete the <code>build</code> directory.
</p>
</section>
</steps>
</howto>
RE: cvs commit: xml-xindice/src/documentation/content/xdocs/community/howto/compilation compilation.xml
Posted by Dave Viner <dv...@yahoo-inc.com>.
Vladimir,
The compilation.xml file in the
src/documenation/content/xdocs/community/howto/compilation subdirectory is
not valid. I realize that this is a work in progress, but when invalid XML
docs are checked in, I can't build the docs using forrest. Can you either
fix the file or remove it?
thanks
dave
-----Original Message-----
From: vladimir@apache.org [mailto:vladimir@apache.org]
Sent: Saturday, November 23, 2002 4:34 PM
To: xml-xindice-cvs@apache.org
Subject: cvs commit:
xml-xindice/src/documentation/content/xdocs/community/howto/compilation
compilation.xml
vladimir 2002/11/23 16:33:46
Modified: src/documentation/content/xdocs/community/howto book.xml
Added: src/documentation/content/xdocs/community/howto/compilation
compilation.xml
Log:
New essai for a compilation howto
Revision Changes Path
1.4 +11 -2
xml-xindice/src/documentation/content/xdocs/community/howto/book.xml
Index: book.xml
===================================================================
RCS file:
/home/cvs/xml-xindice/src/documentation/content/xdocs/community/howto/book.x
ml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- book.xml 22 Nov 2002 19:39:25 -0000 1.3
+++ book.xml 24 Nov 2002 00:33:46 -0000 1.4
@@ -1,16 +1,25 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN"
"book-cocoon-v10.dtd">
+
<!--
- Version: $Revision$ $Date$
- Author: Vladimir R. Bossicard (vladimir@apache.org)
- Author: Dave Viner (dviner@apache.org)
-->
+
<book software="Xindice" title="Xindice installation HOWTOs"
copyright="2002 The Apache Foundation"
xmlns:xlink="http://www.w3.org/1999/xlink">
+
<menu label="Compilation How-Tos">
- <menu-item label="Windows" href="compilation/windows.html"/>
<menu-item label="Unix" href="compilation/unix.html"/>
+ <menu-item label="Windows" href="compilation/windows.html"/>
+ </menu>
+
+ <menu label="General How-Tos">
+ <menu-item label="Compilation How-to"
href="compilation/compilation.html"/>
</menu>
+
<menu label="Installation How-Tos">
<menu-item label="Tomcat How-to"
href="installation/tomcat.html"/>
</menu>
+
</book>
1.1
xml-xindice/src/documentation/content/xdocs/community/howto/compilation/comp
ilation.xml
Index: compilation.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.0//EN" "howto-v10.dtd">
<!--
- Version: $Revision: 1.1 $ $Date: 2002/11/24 00:33:46 $
-->
<howto>
<header>
<title>Compiling Xindice</title>
<version>1.0</version>
<authors>
<person name="Vldimir R. Bossicard"
email="vladimir@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
from the
source distribution, a nightly snapshot or from a CVS
checkout.
</p>
<note>
The steps are described for a Linux/*nix environment.
Windows users must simply replace the file separators and
environment variables
accordinguely.
</note>
</audience>
<prerequisites title="Prerequisites">
<ul>
<li>The Xindice source code, available as a
<link
href="http://xml.apache.org/xindice/download.html">downloadable
archive</link> or via
<link href="http://xml.apache.org/cvs.html">CVS
checkout</link>.
</li>
<li>The Java JDK Standard Edition, version 1.2 or higher
correctly installed.</li>
<li>The
<code>${JAVA_HOME}</code> environment variable correctly
set.
</li>
</ul>
</prerequisites>
<steps title="Steps">
<section>
<title>Unpack the distribution</title>
<p>
If you have downloaded the source archive, you first have
to unpack it using either unzip:
</p>
<source><![CDATA[
unzip xindice-src-X.Y.zip
]]></source>
<p>or tar:</p>
<source><![CDATA[
tar zxf xindice-src-X.Y.tar.gz
]]></source>
<note>The folder names are different</note>
</section>
<section>
<title>Compile the source</title>
<p>Navigate to the root of your unpacked Xindice directory.
Note that all
directory references will be relative to this directory.
To compile and create
the jar files, simply type:
</p>
<source><![CDATA[
$ ./build.sh [ Unix ]
> build [ Windows ]
]]></source>
<p>The output looks like:</p>
<source><![CDATA[
]]></source>
</section>
<section>
<title>Verify the compilation</title>
<p>Xindice comes with a series of tests that you can run to
make sure that the
If the compile was succeeded, you will find the output
files in the
<code>dist</code> subdirectory.
</p>
<source><![CDATA[
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>
<p>
You are now ready to install Xindice. See the
<a href="../index.html">Installation How-Tos</a> for more
details.
</p>
</section>
<section>
<title>Clean the compilation</title>
<p>
Simply delete the <code>build</code> directory.
</p>
</section>
</steps>
</howto>