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/02/02 02:22:20 UTC
cvs commit: xml-xindice/java/examples/guide README
kstaken 02/02/01 17:22:20
Modified: . build.xml
docs INSTALL INSTALL.windows README
java/examples/Addressbook README
java/examples/api README
java/examples/guide README
Removed: java/examples/api/src/org/apache/xindice/examples
APIExample.java
Log:
Doc and script corrections for accuracy.
Revision Changes Path
1.6 +11 -5 xml-xindice/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/xml-xindice/build.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- build.xml 2 Feb 2002 00:07:42 -0000 1.5
+++ build.xml 2 Feb 2002 01:22:20 -0000 1.6
@@ -14,7 +14,7 @@
cd xml-xindice ; bin/ant
- $Id: build.xml,v 1.5 2002/02/02 00:07:42 kstaken Exp $
+ $Id: build.xml,v 1.6 2002/02/02 01:22:20 kstaken Exp $
-->
@@ -310,7 +310,7 @@
-->
<target name="dist-archive" depends="init">
<property name="distrib.file" value="../dist/${distrib.name}"/>
-
+
<mkdir dir="${distrib.file}"/>
<!-- Remove any existing versions -->
@@ -331,9 +331,15 @@
<chmod file="${distrib.file}/bin/.cmdwrapper" perm="+x"/>
<chmod file="${distrib.file}/bin/xindice" perm="+x"/>
<chmod file="${distrib.file}/bin/xindiceadmin" perm="+x"/>
+ <chmod file="${distrib.file}/java/examples/guide/run" perm="+x"/>
+ <chmod file="${distrib.file}/java/examples/api/run" perm="+x"/>
- <tar tarfile="../${distrib.name}.tar">
- <!-- We also need to tell tar to keep the execute perms -->
+ <!-- This isn't working for some reason. For now we'll just
+ need to create the archives manually. The problem is
+ It won't create the archives while keeping execute
+ perms on the scripts -->
+
+ <!--tar tarfile="../${distrib.name}.tar" basedir="../dist">
<tarfileset dir="${distrib.file}/.." mode="755">
<include name="${distrib.file}/start"/>
<include name="${distrib.file}/xindice.server"/>
@@ -357,7 +363,7 @@
</tar>
<gzip zipfile="../${distrib.name}.tar.gz" src="../${distrib.name}.tar"/>
<delete file="../${distrib.name}.tar"/>
- <zip zipfile="../${distrib.name}.zip" basedir="../dist"/>
+ <zip zipfile="../${distrib.name}.zip" basedir="../dist"/-->
</target>
</project>
1.5 +30 -46 xml-xindice/docs/INSTALL
Index: INSTALL
===================================================================
RCS file: /home/cvs/xml-xindice/docs/INSTALL,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- INSTALL 1 Feb 2002 19:29:03 -0000 1.4
+++ INSTALL 2 Feb 2002 01:22:20 -0000 1.5
@@ -4,9 +4,7 @@
Xindice Version 1.0 UNIX installation.
Before anything, you're going to need Sun's Java SDK version 1.3 or
-higher. The last time we tested it, IBM's JDK 1.3.0 for Linux was known
-to break with a SIG11 on insertion of documents. This may have changed
-in more recent releases.
+higher.
How to install: (Use this process if you downloaded a binary distribution)
@@ -18,12 +16,12 @@
would set JAVA_HOME=/usr/local/java
2. Set the XINDICE_HOME environment variable to the location where you extracted
- the Xindice distribution. For instance if you extracted to /usr/local then you
- would set XINDICE_HOME=/usr/local/Xindice
+ the Xindice distribution. For instance if you extracted to /usr/local then
+ you would set XINDICE_HOME=/usr/local/Xindice
3. Add the $XINDICE_HOME/bin directory to your PATH environment variable. This
- will enable you to run the xindice and xindiceadmin command line tools without
- specifying the full path.
+ will enable you to run the xindice and xindiceadmin command line tools
+ without specifying the full path.
4. Start the Xindice server.
@@ -31,8 +29,7 @@
cd $XINDICE_HOME
./start
-5. The Xindice server should now be running on and can be accessed through
- a web browser at http://localhost:4080/
+5. The Xindice server should now be running.
6. Create a collection to test your installation and prepare it for
running the examples.
@@ -44,13 +41,29 @@
Created : /db/addressbook
- This just created a collection named "addressbook" in the default database instance.
+ This just created a collection named "addressbook" in the default database
+ instance.
-7. Skip to the what can I do with it section below.
+7. If everything worked Xindice is installed and running.
+
+ The place to start from here is to take a look at the documentation. This
+ can be accessed by pointing your browser to http://localhost:4080/. The
+ Users Guide is probably a good place to start.
+
+ Also in the Xindice/java/examples directory are some simple example
+ programs that show you the basics of working with the server.
+
+ If you ran into any problems you should join the Xindice users mailing
+ list and ask your questions there. You can find instructions for joining
+ the list on http://xml.apache.org, just follow the Xindice link.
-How to build: (Use this process only if you want to build the server from source)
+
+Building from source: (NOTE: this section is aimed at developers who want to
+ build a custom version of the server. If you just want to run Xindice you
+ can ignore the rest of this file.)
+
Note: these instructions are for UNIX if you are building on windows
see README.windows
@@ -61,12 +74,12 @@
would set JAVA_HOME=/usr/local/java
3. Set the XINDICE_HOME environment variable to the location where you extracted
- the Xindice distribution. For instance if you extracted to /usr/local then you
- would set XINDICE_HOME=/usr/local/Xindice
+ the Xindice distribution. For instance if you extracted to /usr/local then
+ you would set XINDICE_HOME=/usr/local/Xindice
4. Add the $XINDICE_HOME/bin directory to your PATH environment variable. This
- will enable you to run the xindice and xindiceadmin command line tools without
- specifying the full path.
+ will enable you to run the xindice and xindiceadmin command line tools
+ without specifying the full path.
5. You are now prepared to build.
@@ -79,33 +92,4 @@
Type
ant javadoc
-7. Start the Xindice server.
-
- Type:
- cd $XINDICE_HOME
- ./start
-
-8. The Xindice server should now be running.
-
-9. Create a collection to test your installation and prepare it for
- running the examples.
-
- Type:
- xindiceadmin ac -c /db -n addressbook
-
- If it worked successfully you should see
-
- Created : /db/addressbook
-
- This just created a collection named "addressbook" in the default database instance.
-
-10. Skip to the what can I do with it section below.
-
-What can I do with it:
-
-The place to start from here is to take a look at the documentation. This can be
-accessed by pointing your browser to http://localhost:4080/. The Users Guide is
-probably a good place to start.
-
-Also in the Xindice/java/examples directory are some simple example programs
-that show you the basics of working with the server.
+7. If everything worked you should have a freshly rebuilt version of Xindice
\ No newline at end of file
1.5 +4 -15 xml-xindice/docs/INSTALL.windows
Index: INSTALL.windows
===================================================================
RCS file: /home/cvs/xml-xindice/docs/INSTALL.windows,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- INSTALL.windows 1 Feb 2002 21:20:33 -0000 1.4
+++ INSTALL.windows 2 Feb 2002 01:22:20 -0000 1.5
@@ -45,15 +45,10 @@
Created : /db/addressbook
- This just created a collection named "addressbook" in the default database instance.
-
-10. Run the API example (optional)
-
- Type
- cd %XINDICE_HOME\java\examples\api
- run org.Xindice.examples.APIExample
+ This just created a collection named "addressbook" in the default database
+ instance.
-11. The server and documentation can be accessed using a web browser pointed to
+10. The server and documentation can be accessed using a web browser pointed to
http://localhost:4080/
@@ -128,13 +123,7 @@
Each example directory has a README file that explains how to run it.
-13. Run the API example (optional)
-
- Type
- cd %XINDICE_HOME%\java\examples\api
- run org.apache.xindice.examples.APIExample
-
-14. The server and documentation can be accessed using a web browser pointed to
+13. 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 +18 -6 xml-xindice/docs/README
Index: README
===================================================================
RCS file: /home/cvs/xml-xindice/docs/README,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- README 6 Dec 2001 19:33:46 -0000 1.1
+++ README 2 Feb 2002 01:22:20 -0000 1.2
@@ -51,18 +51,30 @@
- Name changes. There have been a lot of changes in package, class,
documentation, and identifier naming throughout the project as a
- result of the migration to the Apache project.
+ result of the migration to the Apache project. The most important
+ are summarized here.
-- XML Namespace changes. XML namespaces that were defined by
- dbXML have been renamed. The "http://www.dbxml.org/" portion
- of those namespaces has been changed to
- "http://xml.apache.org/xindice/"
+ - XML:DB URI changes. All XML:DB API uri should now be of the form
+ xmldb:xindice: instead of xmldb:dbxml:
+
+ - Source package changes. If you have any code that imported any
+ org.dbxml.* source code it will need to be changed to import the
+ proper packages from org.apache.xindice.*.
+
+ - XML Namespace changes. XML namespaces that were defined by
+ dbXML have been renamed. The "http://www.dbxml.org/" portion
+ of those namespaces has been changed to
+ "http://xml.apache.org/xindice/"
- The Collection configuration system now uses the Database's
system collection instead of the system.xml file. The
system.xml file is now read-only, and is used for configuring
the server framework. Collection management is read/write and
- uses the Xindice native file system to maintain configuration.
+ uses the Xindice native file system to maintain configuration.
+
+- As installed the server no longer has any default collections
+ that can store documents. You must create a collection manually
+ before attempting to store any documents in the server.
- Complete JAXP bootstrapping. Xindice will bootstrap with
whichever JAXP-capable XML parser the Java VM will resolve.
1.2 +4 -4 xml-xindice/java/examples/Addressbook/README
Index: README
===================================================================
RCS file: /home/cvs/xml-xindice/java/examples/Addressbook/README,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- README 6 Dec 2001 19:33:51 -0000 1.1
+++ README 2 Feb 2002 01:22:20 -0000 1.2
@@ -21,10 +21,10 @@
file resides. If not, type.
(on UNIX)
- cd $XINDICE_HOME/java/examples/addressbook
+ cd $XINDICE_HOME/java/examples/Addressbook
(on Windows)
- cd %XINDICE_HOME%\java\examples\addressbook
+ cd %XINDICE_HOME%\java\examples\Addressbook
2. Build the Addressbook.war. The file is built by the ant script
@@ -66,10 +66,10 @@
file resides. If not, type.
(on UNIX)
- cd $XINDICE_HOME/java/examples/addressbook
+ cd $XINDICE_HOME/java/examples/Addressbook
(on Windows)
- cd %XINDICE_HOME%\java\examples\addressbook
+ cd %XINDICE_HOME%\java\examples\Addressbook
2. Build the Addressbook.war. The war is built by the ant script
1.2 +3 -11 xml-xindice/java/examples/api/README
Index: README
===================================================================
RCS file: /home/cvs/xml-xindice/java/examples/api/README,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- README 6 Dec 2001 19:33:52 -0000 1.1
+++ README 2 Feb 2002 01:22:20 -0000 1.2
@@ -1,22 +1,14 @@
-The api examples show some basic ways to use the Xindice apis. There are two
-example clients APIExample and CorbaAPIExample.
-
-APIExample uses the org.apache.xindice.client library to provide simpler access
-to the Xindice server. This library is just a lightweight wrapper around the
-CORBA API but makes working with the server much simpler from Java. If you are
-working in java you should probably use the org.apache.xindice.client library
-rather then using the CORBA APIs directly.
-
CorbaAPIExample shows the basics of using the CORBA APIs to access the Xindice
server. The CORBA APIs enable access from other languages besides java. If you
are working in a language other then Java you can use this as a guide for how
the CORBA calls might look in your chosen language.
+Note: CORBA is slated to be replaced in later versions of Xindice. Because of
+ this it is not recommended that you develop to this API.
Run:
- Make sure the CORBA naming service and Xindice server is running.
+ Make sure the Xindice server is running.
- run org.apache.xindice.examples.APIExample or
run org.apache.xindice.examples.CorbaAPIExample
Example output:
1.2 +5 -2 xml-xindice/java/examples/guide/README
Index: README
===================================================================
RCS file: /home/cvs/xml-xindice/java/examples/guide/README,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- README 6 Dec 2001 19:33:52 -0000 1.1
+++ README 2 Feb 2002 01:22:20 -0000 1.2
@@ -3,7 +3,10 @@
Run:
Make sure the Xindice server is running.
- run org.apache.xindice.examples.Example#
+ ./run org.apache.xindice.examples.ExampleName
- Where # is replaced by the number of the example program you wish to run.
+ Where ExampleName is replaced by the name of the example program you
+ wish to run.
+ The run script just adds the appropriate jars to the CLASSPATH before
+ running the program.
\ No newline at end of file