vladimir 2002/11/26 01:20:42
Modified: src/documentation/content/xdocs news.xml related.xml
src/documentation/content/xdocs/dev book.xml
guide-administrator.xml guide-internals.xml
guide-user.xml news.xml todo.xml
src/documentation/content/xdocs/community/howto book.xml
src/documentation/content/xdocs/community/howto/installation
tomcat.xml
src/documentation/content/xdocs/community/howto/compilation
compilation.xml
Removed: src/documentation README.txt
Log:
Updated documentation, a little bit of everything, everywhere (patches and
bad links fixes)
Revision Changes Path
1.5 +2 -2 xml-xindice/src/documentation/content/xdocs/news.xml
Index: news.xml
===================================================================
RCS file: /home/cvs/xml-xindice/src/documentation/content/xdocs/news.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- news.xml 17 Nov 2002 08:14:25 -0000 1.4
+++ news.xml 26 Nov 2002 09:20:42 -0000 1.5
@@ -16,7 +16,7 @@
<ul>
<li>
- <strong>17 November 2002</strong>: the new website is published.
+ <strong>25 November 2002</strong>: the new website is published.
Many thanks to Kevin (guides), Nicola (logo) and Jeff (Forrest
hotline). And me (Vladimir) for the overall migration :-)
</li>
1.5 +25 -12 xml-xindice/src/documentation/content/xdocs/related.xml
Index: related.xml
===================================================================
RCS file: /home/cvs/xml-xindice/src/documentation/content/xdocs/related.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- related.xml 25 Nov 2002 18:29:29 -0000 1.4
+++ related.xml 26 Nov 2002 09:20:42 -0000 1.5
@@ -71,7 +71,7 @@
</fork>
</td>
<td>
- These are PHP-based Xindice access and
+ These are PHP-based Xindice access and
management tools.
</td>
</tr>
@@ -96,7 +96,7 @@
<caption>Configuration Help - User Contributed Pages</caption>
<tr>
<td>
- <fork
+ <fork
href="http://torchbox.com/xml/xindice/xindice.html";>
Getting started with Xindice 1.1
</fork>
@@ -113,19 +113,19 @@
</fork>
</td>
<td>
- Notes on running Xindice in a Windows 2000,
- Tomcat 4.0.1, Cocoon 2.0.1 and Xindice 1.0rc
+ Notes on running Xindice in a Windows 2000,
+ Tomcat 4.0.1, Cocoon 2.0.1 and Xindice 1.0rc
environment.
</td>
</tr>
<tr>
<td>
<fork href="http://www.waldhor.com/xindice.htm";>
- Xindice Hints (v1.0)
- </fork>
+ Xindice Hints (v1.0)
+ </fork>
</td>
<td>
- Installation and performance tips from Dr.
+ Installation and performance tips from Dr.
Klemens Waldhor
</td>
</tr>
@@ -182,7 +182,7 @@
</fork>
</td>
<td>
- Xindice (dbXml) Browser -
+ Xindice (dbXml) Browser -
O'Reilly's xml dot com Resource Guide
</td>
</tr>
@@ -193,7 +193,7 @@
</fork><em>(German)</em>
</td>
<td>
- Apache Software Foundation Stellt Xindice
+ Apache Software Foundation Stellt Xindice
fertig - Article at golem dot com
</td>
</tr>
@@ -296,10 +296,10 @@
</fork>
</td>
<td>
- CocoBlog is a
+ CocoBlog is a
<fork href="http://xml.apache.org/cocoon";>Cocoon</fork>
and Xindice-based weblogging software tool
- developed by
+ developed by
<fork href="http://www.luminas.co.uk";>Luminas</fork>
(UK).
</td>
@@ -314,9 +314,22 @@
Simple XML Data Manipulation Language (SiXDML)
</td>
</tr>
+ <tr>
+ <td>
+ <link href="mail.html">
+ You!
+ </link>
+ </td>
+ <td>
+ Is your commercial or open software solution
+ using Xindice? Drop us a line so we can
+ list your application here.
+ </td>
+ </tr>
</table>
+ <p> </p>
</body>
1.5 +10 -1 xml-xindice/src/documentation/content/xdocs/dev/book.xml
Index: book.xml
===================================================================
RCS file: /home/cvs/xml-xindice/src/documentation/content/xdocs/dev/book.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- book.xml 25 Nov 2002 16:15:25 -0000 1.4
+++ book.xml 26 Nov 2002 09:20:42 -0000 1.5
@@ -17,12 +17,21 @@
<menu-item label="Todo" href="todo.html"/>
</menu>
+<!--
+ <menu label="Documentation">
+ <menu-item label="Getting Started" href="guide-started.html"/>
+ <menu-item label="Database Programming" href="guide-programming.html"/>
+ <menu-item label="Tool Reference" href="guide-commandline.html"/>
+ </menu>
+-->
+
<menu label="Documentation">
<menu-item label="Administrator Guide"
href="guide-administrator.html"/>
<menu-item label="User Guide" href="guide-user.html"/>
<menu-item label="Developer Guide" href="guide-developer.html"/>
<menu-item label="Commandline Tool Guide"
href="guide-commandline.html"/>
</menu>
+
<menu label="Developer documentation">
<menu-item label="How to contribute" href="doc-contributing.html"/>
<menu-item label="Xindice internals" href="guide-internals.html"/>
1.2 +2 -40
xml-xindice/src/documentation/content/xdocs/dev/guide-administrator.xml
Index: guide-administrator.xml
===================================================================
RCS file:
/home/cvs/xml-xindice/src/documentation/content/xdocs/dev/guide-administrator.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- guide-administrator.xml 17 Nov 2002 08:16:03 -0000 1.1
+++ guide-administrator.xml 26 Nov 2002 09:20:42 -0000 1.2
@@ -25,7 +25,7 @@
allows you to view and alter the database configuration on the
fly
on a running system. A complete list of available commands and
more
detail about each command can be found in the
- <link href="guide-tools.html">Command Line Tools Reference
Guide</link>.
+ <link href="guide-commandline.html">Command Line Tools Reference
Guide</link>.
</p>
<section>
<title>Managing Collections</title>
@@ -147,44 +147,6 @@
</section>
<section>
<title>Server Administration</title>
- <section>
- <title>Starting the Server</title>
- <p>
- The server must be started from within the Xindice directory.
- A future revision of the server will fix this limitation.
- </p>
- <section>
- <title>Starting the Server on UNIX</title>
- <source><![CDATA[
-cd Xindice
-./start
- ]]></source>
- </section>
- <section>
- <title>Starting the Server on Windows</title>
- <source><![CDATA[
-cd Xindice
-startup
- ]]></source>
- </section>
- </section>
- <section>
- <title>Stopping the Server</title>
- <p>
- The Xindice server can be easily shutdown from the command line. You
- must provide the name of the server instance to shutdown.
- </p>
- <section>
- <title>Stopping the Server</title>
- <p>
- This example assumes that the Xindice/bin directory
- is in your path.
- </p>
- <source><![CDATA[
-xindice shutdown -c /db
- ]]></source>
- </section>
- </section>
<section>
<title>Backing up Your Data</title>
<p>
1.2 +2 -2
xml-xindice/src/documentation/content/xdocs/dev/guide-internals.xml
Index: guide-internals.xml
===================================================================
RCS file:
/home/cvs/xml-xindice/src/documentation/content/xdocs/dev/guide-internals.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- guide-internals.xml 25 Nov 2002 16:15:25 -0000 1.1
+++ guide-internals.xml 26 Nov 2002 09:20:42 -0000 1.2
@@ -273,7 +273,7 @@
easy access. Pages have a fixed length. If data that must
be stored is
longer than the length of one page, subsequent pages in
the file can
be "linked" to the first.</p>
- <figure src="/images/pagedfile.png" alt="Paged file
structure"/>
+ <figure src="images/pagedfile.png" alt="Paged file
structure"/>
<p>As shown in the diagram, a paged file consists of a file
header, followed by
a list of fixed-length pages. The file header is 4kb
long, and each page is,
by default, 4kb long. (These values can be modified in the
1.2 +9 -14
xml-xindice/src/documentation/content/xdocs/dev/guide-user.xml
Index: guide-user.xml
===================================================================
RCS file:
/home/cvs/xml-xindice/src/documentation/content/xdocs/dev/guide-user.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- guide-user.xml 17 Nov 2002 08:16:03 -0000 1.1
+++ guide-user.xml 26 Nov 2002 09:20:42 -0000 1.2
@@ -16,6 +16,13 @@
<body>
<warning>This documentation is a work in progress and is only
applicable to the CVS version of Xindice. There is absolutely no guarantee that
this information is accurate. You have been warned.
</warning>
+
+ <section>
+<title>Getting Started with Xindice</title>
+<section><title>Introduction to XML Databases</title></section>
+<section><title>Apache Xindice</title></section>
+</section>
+
<section>
<title>Introduction to Xindice</title>
<section>
@@ -85,10 +92,6 @@
You should review the README file that is part of the Xindice
distribution for the most current status on the project.
</p>
- <p>
- NOTE: Both the Xindice server and this document are works in
- progress. Any comments are welcome and encouraged.
- </p>
</section>
<section>
<title>Feature Summary</title>
@@ -140,14 +143,6 @@
from the command line.
</p>
<p>
- CORBA Network API: For developers who are interested in
working in
- languages other then Java, Xindice provides a CORBA API that
can be
- used to build applications. All functionality available
through the
- XML:DB API is also available through the CORBA API. In fact
the
- XML:DB API is built on top of the CORBA API. Most Java
developers
- though, will never even need to know that the CORBA API
exists.
- </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
@@ -240,7 +235,7 @@
data stored in the server.
A complete list of available commands and more
detail about each command can be found in the
- <link href="guide-tools.html">Command Line Tools Reference
Guide</link>.
+ <link href="guide-commandline.html">Command Line Tools
Reference Guide</link>.
</p>
<p>
The
1.2 +2 -2 xml-xindice/src/documentation/content/xdocs/dev/news.xml
Index: news.xml
===================================================================
RCS file: /home/cvs/xml-xindice/src/documentation/content/xdocs/dev/news.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- news.xml 17 Nov 2002 08:16:03 -0000 1.1
+++ news.xml 26 Nov 2002 09:20:42 -0000 1.2
@@ -16,7 +16,7 @@
<ul>
<li>
- <strong>17 November 2002</strong>: the new website is published.
+ <strong>25 November 2002</strong>: the new website is published.
Many thanks to Kevin (guides), Nicola (logo) and Jeff (Forrest
hotline). And me (Vladimir) for the overall migration :-)
</li>
1.2 +11 -6 xml-xindice/src/documentation/content/xdocs/dev/todo.xml
Index: todo.xml
===================================================================
RCS file: /home/cvs/xml-xindice/src/documentation/content/xdocs/dev/todo.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- todo.xml 24 Nov 2002 06:48:44 -0000 1.1
+++ todo.xml 26 Nov 2002 09:20:42 -0000 1.2
@@ -21,10 +21,11 @@
<section>
<title>Introduction</title>
<p>
- Once these todos are completed, a new version of Xindice will
- be released. But don't expect anything if these tasks are
not
- completed! So if you want to see a new release before the end
- of the millenium, choose your task!
+ For a new version of Xindice to be released, these
+ following todos must be completed. Do not expect
+ anything if these tasks are not done! So if you want
+ to see a new release before the end of the millenium,
+ choose your task!
</p>
</section>
@@ -35,6 +36,9 @@
<code>build.xml</code>: generate the <code>tar.gz</code>
and <code>zip</code> files.
</li>
+ <li>
+ create jsp pages to replace the ugly debug tool.
+ </li>
</ul>
</section>
@@ -42,7 +46,8 @@
<title>Documentation</title>
<ul>
<li>
- Define the tables of content for the different guides.
+ Define the tables of content for the different
+ guides and fill the holes!
</li>
</ul>
</section>
1.5 +3 -1
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.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- book.xml 24 Nov 2002 00:33:46 -0000 1.4
+++ book.xml 26 Nov 2002 09:20:42 -0000 1.5
@@ -14,9 +14,11 @@
<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"/>
1.3 +69 -5
xml-xindice/src/documentation/content/xdocs/community/howto/installation/tomcat.xml
Index: tomcat.xml
===================================================================
RCS file:
/home/cvs/xml-xindice/src/documentation/content/xdocs/community/howto/installation/tomcat.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- tomcat.xml 22 Nov 2002 19:39:26 -0000 1.2
+++ tomcat.xml 26 Nov 2002 09:20:42 -0000 1.3
@@ -10,7 +10,7 @@
<authors>
<person name="Dave Viner" email="[EMAIL PROTECTED]"/>
</authors>
- <last-modified-content-date date="2002-11-21"/>
+ <last-modified-content-date date="2002-11-25"/>
</header>
<audience title="Intended audience">
<p>This How-to is aimed at developers or administrators who want to
install Xindice with Tomcat.</p>
@@ -51,7 +51,32 @@
D:\xindice\current\xml-xindice>
</source>
<note>In this example, I have built Xindice in
D:\xindice\current. If you compile the source in another location, just
substitute that path for D:\xindice\current.</note>
- <fixme author="dviner">Need some unix examples here.</fixme>
+ <p> </p>
+ <p>If you are using Linux, your session might resemble:</p>
+ <source>
[EMAIL PROTECTED]:/local/xml-xindice# ls -oat dist
+total 2760
+drwxr-xr-x 2 root 4096 Nov 25 20:10 .
+-rw-r--r-- 1 root 247 Nov 25 20:10 xindice-1.1b.xml
+drwxr-xr-x 13 root 4096 Nov 25 00:01 ..
+-rw-r--r-- 1 root 9504 Nov 23 15:27 xindice-1.1b-examples.jar
+-rw-r--r-- 1 root 2408531 Nov 23 15:27 xindice-1.1b.war
+-rw-r--r-- 1 root 379794 Nov 23 15:27 xindice-1.1b.jar
[EMAIL PROTECTED]:/local/xml-xindice# cp dist/xindice-1.1b.war
$CATALINA_HOME/webapps
[EMAIL PROTECTED]:/local/xml-xindice#
+ </source>
+ <note>In this Linux session, the Xindice root directory
+ is in <code>/local/xml-xindice</code>. You should
+ substitute your actual <code>XINDICE_HOME</code>
+ path for <code>/local/xml-xindice</code>.
+ </note>
+ </section>
+ <section>
+ <title>Edit the Tomcat <code>server.xml</code> File</title>
+ <fixme author="jcarroll">Need section on inserting
+ XINDICE_HOME/dist/xindice-1.1b.xml entry into the
+ CATALINA_HOME/conf/server.xml file here.
+ </fixme>
</section>
<section>
<title>Restart Tomcat</title>
@@ -68,7 +93,30 @@
D:\jakarta-tomcat-4.1.12\bin>
</source>
<note>In this example, I have installed Tomcat in
D:\jakarta-tomcat-4.1.12. If you've installed it in another location, just
ensure that the CATALINA_HOME environmental variable points to your Tomcat
installation directory, or substitute that path for
D:\jakarta-tomcat-4.1.12.</note>
- <fixme author="dviner">Need some unix examples here.</fixme>
+ <p> </p>
+ <p>Here's what that might look like on Linux</p>
+ <source>
[EMAIL PROTECTED]:/var/tomcat4/bin# ./catalina.sh start
+Using CATALINA_BASE: /var/tomcat4
+Using CATALINA_HOME: /var/tomcat4
+Using CATALINA_TMPDIR: /var/tomcat4/temp
+Using JAVA_HOME: /usr/java/jdk1.3.1_06
[EMAIL PROTECTED]:/var/tomcat4/bin#
+ </source>
+ <note>The name of the Tomcat installation directory may
+ differ for your Linux platform. The default
+ location is <code>/var/tomcat4</code>. If you
+ are unsure of the location, check the
+ <code>tomcat4.conf</code> file in your
+ <code>/etc/tomcat4</code> directory.
+ </note>
+ <p> </p>
+ <warning>If you installed the RPM version of Tomcat v4.x,
+ you may need to enter "<code>tomcat4 start</code>"
+ to invoke the Tomcat server. The FreeBSD version
+ of Tomcat may be using <code>tomcat41ctl</code>.
+ </warning>
+ <p> </p>
</section>
<section>
<title>Verify the installation</title>
@@ -95,7 +143,23 @@
Nov 21, 2002 1:42:24 PM org.apache.jk.server.JkMain start
INFO: Jk running ID=0 time=20/70
config=D:\jakarta-tomcat-4.1.12\conf\jk2.properties
</source>
- <fixme author="dviner">Need some unix examples here.</fixme>
+ <p> </p>
+ <p>Here's what the <code>$CATALINA_HOME/logs/catalina.out</code>
+ output looks like on Linux</p>
+ <source>
+[INFO] Registry - -Loading registry information
+[INFO] Registry - -Creating new Registry instance
+[INFO] Registry - -Creating MBeanServer
+[INFO] Http11Protocol - -Initializing Coyote HTTP/1.1 on port 8080
+Starting service Tomcat-Standalone
+Apache Tomcat/4.1
+Server 1.6 is running
+Press [Ctrl]+[C] to abort
+[INFO] Http11Protocol - -Starting Coyote HTTP/1.1 on port 8080
+[INFO] ChannelSocket - -JK2: ajp13 listening on tcp port 8009
+[INFO] JkMain - -Jk running ID=0 time=4/168
+config=/var/tomcat4/conf/jk2.properties
+ </source>
<p>In addition, you should be able to verify that xindice is
running by loading this URL in your browser http://localhost:8080/xindice-1.1b
If it works, you should see something that says "THIS
IS AN UGLY DEBUG TOOL!".
</p>
1.3 +3 -3
xml-xindice/src/documentation/content/xdocs/community/howto/compilation/compilation.xml
Index: compilation.xml
===================================================================
RCS file:
/home/cvs/xml-xindice/src/documentation/content/xdocs/community/howto/compilation/compilation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- compilation.xml 25 Nov 2002 18:54:17 -0000 1.2
+++ compilation.xml 26 Nov 2002 09:20:42 -0000 1.3
@@ -24,7 +24,7 @@
<note>
The steps are described for a Linux/*nix environment.
Windows users must simply replace the file separators and
environment variables
- accordinguely.
+ accordingly.
</note>
</audience>
@@ -72,7 +72,7 @@
> build [ Windows ]
]]></source>
- <p>The output looks like:</p>
+ <p>The output during the compilation looks like:</p>
<source><![CDATA[
]]></source>
</section>
