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 ks...@apache.org on 2002/01/15 15:39:43 UTC
cvs commit: xml-xindice/docs/src AdministratorsGuide.xml DevelopersGuide.xml ToolsReference.xml UsersGuide.xml
kstaken 02/01/15 06:39:42
Modified: docs INSTALL INSTALL.windows
docs/src AdministratorsGuide.xml DevelopersGuide.xml
ToolsReference.xml UsersGuide.xml
Log:
Tweaking the docs for 1.0rc1 and the removal of default collections.
Revision Changes Path
1.2 +27 -3 xml-xindice/docs/INSTALL
Index: INSTALL
===================================================================
RCS file: /home/cvs/xml-xindice/docs/INSTALL,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- INSTALL 6 Dec 2001 19:33:45 -0000 1.1
+++ INSTALL 15 Jan 2002 14:39:42 -0000 1.2
@@ -30,10 +30,22 @@
4. The Xindice server should now be running on and can be accessed through
a web browser at http://localhost:4080/ or at gopher://localhost:4070
-5. Skip to the what can I do with it section below.
+5. Create a collection to test your installation and prepare it for
+ running the examples.
+
+ Type:
+ xindiceadmin ac -c /db -n root
+
+ If it worked successfully you should see
+
+ Created : /db/root
+
+ This just created a collection named "root" in the default database instance.
+
+6. Skip to the what can I do with it section below.
-How to build: (Use this process if you want to build from source)
+How to build: (Use this process only if you want to build the server from source)
Note: these instructions are for UNIX if you are building on windows
see README.windows
@@ -67,7 +79,19 @@
7. The Xindice server should now be running.
-8. Skip to the what can I do with it section below.
+8. Create a collection to test your installation and prepare it for
+ running the examples.
+
+ Type:
+ xindiceadmin ac -c /db -n root
+
+ If it worked successfully you should see
+
+ Created : /db/root
+
+ This just created a collection named "root" in the default database instance.
+
+9. Skip to the what can I do with it section below.
What can I do with it:
1.2 +29 -5 xml-xindice/docs/INSTALL.windows
Index: INSTALL.windows
===================================================================
RCS file: /home/cvs/xml-xindice/docs/INSTALL.windows,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- INSTALL.windows 6 Dec 2001 19:33:45 -0000 1.1
+++ INSTALL.windows 15 Jan 2002 14:39:42 -0000 1.2
@@ -35,13 +35,25 @@
encountered any problems double check all the steps especially the setting
of the environment variables.
-9. Run the API example (optional)
+9. Create a collection to test your installation and prepare it for
+ running the examples.
+
+ Type:
+ xindiceadmin ac -c /db -n root
+
+ If it worked successfully you should see
+
+ Created : /db/root
+
+ This just created a collection named "root" in the default database instance.
+
+10. Run the API example (optional)
Type
cd %XINDICE_HOME\java\examples\api
run org.Xindice.examples.APIExample
-10. The server and documentation can be accessed using a web browser pointed to
+11. The server and documentation can be accessed using a web browser pointed to
http://localhost:4080/
@@ -96,7 +108,19 @@
of the environment variables. The server can be accessed using a web browser
pointed to http://localhost:4080/
-11. Build the examples. (optional)
+11. Create a collection to test your installation and prepare it for
+ running the examples.
+
+ Type:
+ xindiceadmin ac -c /db -n root
+
+ If it worked successfully you should see
+
+ Created : /db/root
+
+ This just created a collection named "root" in the default database instance.
+
+12. Build the examples. (optional)
Type
cd %XINDICE_HOME%
@@ -104,13 +128,13 @@
Each example directory has a README file that explains how to run it.
-12. Run the API example (optional)
+13. Run the API example (optional)
Type
cd %XINDICE_HOME%\java\examples\api
run org.apache.xindice.examples.APIExample
-13. The server and documentation can be accessed using a web browser pointed to
+14. The server and documentation can be accessed using a web browser pointed to
http://localhost:4080/
Note to developers: This process is a little too complicated and not very
1.2 +3 -3 xml-xindice/docs/src/AdministratorsGuide.xml
Index: AdministratorsGuide.xml
===================================================================
RCS file: /home/cvs/xml-xindice/docs/src/AdministratorsGuide.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- AdministratorsGuide.xml 6 Dec 2001 19:33:46 -0000 1.1
+++ AdministratorsGuide.xml 15 Jan 2002 14:39:42 -0000 1.2
@@ -5,7 +5,7 @@
<book id="admin-guide">
<bookinfo>
- <title>Xindice Administration 0.5</title>
+ <title>Xindice Administration 0.6</title>
<author>
<surname>Staken</surname>
<firstname>Kimbro</firstname>
@@ -16,7 +16,7 @@
<year>2001</year>
<holder>The Apache Software Foundation</holder>
</copyright>
- <pubdate><![CDATA[$Id: AdministratorsGuide.xml,v 1.1 2001/12/06 19:33:46 bradford Exp $]]></pubdate>
+ <pubdate><![CDATA[$Id: AdministratorsGuide.xml,v 1.2 2002/01/15 14:39:42 kstaken Exp $]]></pubdate>
<legalnotice>
<para>
This documentation is a work in progress. Links to the most current
@@ -24,7 +24,7 @@
url="http://www.dbxml.org/docs/">http://www.dbxml.org/docs/</ulink>
</para>
<para>
- This version of the document covers Xindice 1.0b3.
+ This version of the document covers Xindice 1.0rc1.
</para>
</legalnotice>
</bookinfo>
1.2 +3 -3 xml-xindice/docs/src/DevelopersGuide.xml
Index: DevelopersGuide.xml
===================================================================
RCS file: /home/cvs/xml-xindice/docs/src/DevelopersGuide.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DevelopersGuide.xml 6 Dec 2001 19:33:47 -0000 1.1
+++ DevelopersGuide.xml 15 Jan 2002 14:39:42 -0000 1.2
@@ -7,7 +7,7 @@
<book id="developers-guide">
<bookinfo>
- <title>Xindice Developers Guide 0.6</title>
+ <title>Xindice Developers Guide 0.7</title>
<author>
<surname>Staken</surname>
<firstname>Kimbro</firstname>
@@ -18,7 +18,7 @@
<year>2001</year>
<holder>The Apache Software Foundation</holder>
</copyright>
- <pubdate><![CDATA[$Id: DevelopersGuide.xml,v 1.1 2001/12/06 19:33:47 bradford Exp $]]></pubdate>
+ <pubdate><![CDATA[$Id: DevelopersGuide.xml,v 1.2 2002/01/15 14:39:42 kstaken Exp $]]></pubdate>
<legalnotice>
<para>
This documentation is a work in progress. Links to the most current
@@ -26,7 +26,7 @@
url="http://www.dbxml.org/docs/">http://www.dbxml.org/docs/</ulink>
</para>
<para>
- This version of the document covers Xindice 1.0b3.
+ This version of the document covers Xindice 1.0rc1.
</para>
</legalnotice>
</bookinfo>
1.2 +1 -70 xml-xindice/docs/src/ToolsReference.xml
Index: ToolsReference.xml
===================================================================
RCS file: /home/cvs/xml-xindice/docs/src/ToolsReference.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ToolsReference.xml 6 Dec 2001 19:33:47 -0000 1.1
+++ ToolsReference.xml 15 Jan 2002 14:39:42 -0000 1.2
@@ -20,7 +20,7 @@
<year>2001</year>
<holder>The Apache Software Foundation</holder>
</copyright>
- <pubdate><![CDATA[$Id: ToolsReference.xml,v 1.1 2001/12/06 19:33:47 bradford Exp $]]></pubdate>
+ <pubdate><![CDATA[$Id: ToolsReference.xml,v 1.2 2002/01/15 14:39:42 kstaken Exp $]]></pubdate>
<legalnotice>
<para>
This documentation is a work in progress. Links to the most current
@@ -77,10 +77,6 @@
<member>
<command>-v</command> Show verbose output
</member>
- <member>
- <command>-u</command> The URI for the Xindice host to use.
- http://host:[port]
- </member>
</simplelist>
<bridgehead renderas="sect2">Examples:</bridgehead>
@@ -139,11 +135,6 @@
<member>
<command>-v</command> Show verbose output
</member>
- <member>
- <command>-u</command> The URI for the Xindice host to use.
- http://host:[port]
- </member>
-
</simplelist>
<bridgehead renderas="sect2">Examples:</bridgehead>
@@ -194,10 +185,6 @@
<member>
<command>-v</command> Show verbose output
</member>
- <member>
- <command>-u</command> The URI for the Xindice host to use.
- http://host:[port]
- </member>
</simplelist>
<bridgehead renderas="sect2">Examples:</bridgehead>
@@ -264,10 +251,6 @@
<member>
<command>-v</command> Show verbose output
</member>
- <member>
- <command>-u</command> The URI for the Xindice host to use.
- http://host:[port]
- </member>
</simplelist>
<bridgehead renderas="sect2">Examples:</bridgehead>
@@ -328,10 +311,6 @@
<member>
<command>-v</command> Show verbose output
</member>
- <member>
- <command>-u</command> The URI for the Xindice host to use.
- http://host:[port]
- </member>
</simplelist>
<bridgehead renderas="sect2">Examples:</bridgehead>
@@ -384,10 +363,6 @@
<member>
<command>-v</command> Show verbose output
</member>
- <member>
- <command>-u</command> The URI for the Xindice host to use.
- http://host:[port]
- </member>
</simplelist>
<bridgehead renderas="sect2">Examples:</bridgehead>
@@ -499,10 +474,6 @@
<member>
<command>-v</command> Show verbose output
</member>
- <member>
- <command>-u</command> The URI for the Xindice host to use.
- http://host:[port]
- </member>
</simplelist>
<bridgehead renderas="sect2">Examples:</bridgehead>
@@ -557,10 +528,6 @@
<member>
<command>-v</command> Show verbose output
</member>
- <member>
- <command>-u</command> The URI for the Xindice host to use.
- http://host:[port]
- </member>
</simplelist>
<bridgehead renderas="sect2">Examples:</bridgehead>
@@ -622,10 +589,6 @@
<member>
<command>-v</command> Show verbose output
</member>
- <member>
- <command>-u</command> The URI for the Xindice host to use.
- http://host:[port]
- </member>
</simplelist>
<bridgehead renderas="sect2">Examples:</bridgehead>
@@ -679,10 +642,6 @@
<member>
<command>-v</command> Show verbose output
</member>
- <member>
- <command>-u</command> The URI for the Xindice host to use.
- http://host:[port]
- </member>
</simplelist>
<bridgehead renderas="sect2">Examples:</bridgehead>
@@ -733,10 +692,6 @@
<member>
<command>-v</command> Show verbose output
</member>
- <member>
- <command>-u</command> The URI for the Xindice host to use.
- http://host:[port]
- </member>
</simplelist>
<bridgehead renderas="sect2">Examples:</bridgehead>
@@ -793,10 +748,6 @@
<member>
<command>-v</command> Show verbose output
</member>
- <member>
- <command>-u</command> The URI for the Xindice host to use.
- http://host:[port]
- </member>
</simplelist>
<bridgehead renderas="sect2">Examples:</bridgehead>
@@ -888,10 +839,6 @@
<member>
<command>-v</command> Show verbose output
</member>
- <member>
- <command>-u</command> The URI for the Xindice host to use.
- http://host:[port]
- </member>
</simplelist>
<bridgehead renderas="sect2">Examples:</bridgehead>
@@ -945,10 +892,6 @@
<member>
<command>-v</command> Show verbose output
</member>
- <member>
- <command>-u</command> The URI for the Xindice host to use.
- http://host:[port]
- </member>
</simplelist>
<bridgehead renderas="sect2">Examples:</bridgehead>
@@ -992,10 +935,6 @@
<member>
<command>-v</command> Show verbose output
</member>
- <member>
- <command>-u</command> The URI for the Xindice host to use.
- http://host:[port]
- </member>
</simplelist>
<bridgehead renderas="sect2">Examples:</bridgehead>
@@ -1049,10 +988,6 @@
<member>
<command>-v</command> Show verbose output
</member>
- <member>
- <command>-u</command> The URI for the Xindice host to use.
- http://host:[port]
- </member>
</simplelist>
<bridgehead renderas="sect2">Examples:</bridgehead>
@@ -1099,10 +1034,6 @@
<simplelist>
<member>
<command>-v</command> Show verbose output
- </member>
- <member>
- <command>-u</command> The URI for the Xindice host to use.
- http://host:[port]
</member>
</simplelist>
1.2 +3 -3 xml-xindice/docs/src/UsersGuide.xml
Index: UsersGuide.xml
===================================================================
RCS file: /home/cvs/xml-xindice/docs/src/UsersGuide.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- UsersGuide.xml 6 Dec 2001 19:33:48 -0000 1.1
+++ UsersGuide.xml 15 Jan 2002 14:39:42 -0000 1.2
@@ -5,7 +5,7 @@
<book id="users-guide">
<bookinfo>
- <title>Xindice Users Guide 0.6</title>
+ <title>Xindice Users Guide 0.7</title>
<author>
<surname>Staken</surname>
<firstname>Kimbro</firstname>
@@ -16,7 +16,7 @@
<year>2001</year>
<holder>The Apache Software Foundation</holder>
</copyright>
- <pubdate><![CDATA[$Id: UsersGuide.xml,v 1.1 2001/12/06 19:33:48 bradford Exp $]]></pubdate>
+ <pubdate><![CDATA[$Id: UsersGuide.xml,v 1.2 2002/01/15 14:39:42 kstaken Exp $]]></pubdate>
<legalnotice>
<para>
This documentation is a work in progress. Links to the most current
@@ -24,7 +24,7 @@
url="http://www.dbxml.org/docs/">http://www.dbxml.org/docs/</ulink>
</para>
<para>
- This version of the document covers Xindice Core 1.0b3.
+ This version of the document covers Xindice 1.0rc1.
</para>
</legalnotice>
</bookinfo>