You are viewing a plain text version of this content. The canonical link for it is here.
Posted to ojb-dev@db.apache.org by to...@apache.org on 2004/06/30 23:57:11 UTC
cvs commit: db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/guides platforms.xml deployment.xml
tomdz 2004/06/30 14:57:11
Modified: src/doc/forrest/src/documentation/content/xdocs site.xml
src/doc/forrest/src/documentation/content/xdocs/docu
getting-started.xml
src/doc/forrest/src/documentation/content/xdocs/docu/guides
platforms.xml deployment.xml
Log:
Updated documentation of optional libraries and external dependencies
Fixed little doc bug in the getting started section
Revision Changes Path
1.5 +9 -2 db-ojb/src/doc/forrest/src/documentation/content/xdocs/site.xml
Index: site.xml
===================================================================
RCS file: /home/cvs/db-ojb/src/doc/forrest/src/documentation/content/xdocs/site.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- site.xml 30 Jun 2004 15:36:50 -0000 1.4
+++ site.xml 30 Jun 2004 21:57:11 -0000 1.5
@@ -261,13 +261,15 @@
<commons-sql href="commons/sandbox/sql/"/>
<commons-pool href="commons/pool/"/>
<commons-dbcp href="commons/dbcp/"/>
- <jcs href="http://jakarta.apache.org/turbine/jcs/index.html"/>
+ <jcs href="turbine/jcs/index.html"/>
<jetspeed-2 href="http://portals.apache.org/jetspeed-2/"/>
+ <regexp href="regexp/index.html"/>
</jakarta>
<log4j href="http://logging.apache.org/log4j/">
<configuration href="docs/manual.html"/>
</log4j>
<ant href="http://ant.apache.org/"/>
+ <antlr href="http://www.antlr.org/"/>
<hsqldb href="http://hsqldb.sourceforge.net/"/>
<mysql href="http://dev.mysql.com/">
<driver href="downloads/connector/j/"/>
@@ -299,9 +301,14 @@
<jdo href="products/jdo/">
<javadoc href="javadocs/index.html"/>
</jdo>
+ <j2ee-sdk href="j2ee/1.3/download.html#sdk"/>
</sun>
<odmg-group href="http://www.odmg.org/"/>
<junit href="http://www.junit.org"/>
+ <xml-apache href="http://xml.apache.org/">
+ <xerces href="xerces-j/"/>
+ <xalan href="xalan-j/"/>
+ </xml-apache>
<tammi href="http://tammi.sourceforge.net/"/>
<ojbc href="http://ojbc.sourceforge.net/"/>
<intact href="http://www.ebi.ac.uk/intact/"/>
1.7 +10 -9 db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/getting-started.xml
Index: getting-started.xml
===================================================================
RCS file: /home/cvs/db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/getting-started.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- getting-started.xml 26 Jun 2004 23:45:15 -0000 1.6
+++ getting-started.xml 30 Jun 2004 21:57:11 -0000 1.7
@@ -658,8 +658,8 @@
protocol="jdbc"
subprotocol="mysql"
dbalias="//localhost/productmanager"
- username="root"
- password=""
+ username="steve"
+ password="secret"
eager-release="false"
batch-mode="false"
useAutoCommit="1"
@@ -732,17 +732,18 @@
]]></source>
<p>
Of course, you'll need to setup the <code>CLASSPATH</code> before running
- your application. You'll should add all jars except the ones for Torque
- (<code>torque-[version].jar</code>, <code>velocity-[version].jar</code>
- and <code>commons-collections-[version].jar</code>) and for the XDoclet OJB
- module (<code>xdoclet-[version].jar</code>, <code>xjavadoc-[version].jar</code>
- and <code>xdoclet-ojb-module-[version].jar</code>).
+ your application. You'll should add all jars from the <code>lib</code>
+ folder except the ones for Torque (<code>torque-[version].jar</code>,
+ <code>velocity-[version].jar</code> and <code>commons-collections-[version].jar</code>)
+ and for the XDoclet OJB module (<code>xdoclet-[version].jar</code>,
+ <code>xjavadoc-[version].jar</code> and <code>xdoclet-ojb-module-[version].jar</code>).
</p>
<p>
It is important to note that OJB per default assumes the <code>OJB.properties</code>
and <code>OJB-logging.properties</code> files in the directory where you're
starting the application. Hence, we changed to the <code>build/resources</code>
- directory.
+ directory before running the application. This of course requires the compiled
+ classes to be on the classpath, as well (directory <code>build/classes</code>).
</p>
<p>
Per default, the same applies to the other configuration files
1.2 +11 -1 db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/guides/platforms.xml
Index: platforms.xml
===================================================================
RCS file: /home/cvs/db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/guides/platforms.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- platforms.xml 20 Jun 2004 09:12:33 -0000 1.1
+++ platforms.xml 30 Jun 2004 21:57:11 -0000 1.2
@@ -41,6 +41,11 @@
This document explains basic concepts and shows how OJB can be
configured to run against a specific RDBMS.
</p>
+ <p>
+ If you not already have done so, then you also might want to have a
+ look at the <link href="site:getting-started">Getting Started</link>
+ section which presents a sample skeleton project.
+ </p>
</section>
<section>
<title>Basic Concepts</title>
@@ -183,6 +188,11 @@
<p>
The o/r mappings for these tables are contained in the file
<code>repository_internal.xml</code>.
+ </p>
+ <p>
+ If you want to have a look at how these files could be used,
+ have a look at the the <link href="site:getting-started">ojb-blank</link>
+ sample project which is already prepared to use these files.
</p>
</section>
1.2 +75 -47 db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/guides/deployment.xml
Index: deployment.xml
===================================================================
RCS file: /home/cvs/db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/guides/deployment.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- deployment.xml 20 Jun 2004 09:12:33 -0000 1.1
+++ deployment.xml 30 Jun 2004 21:57:11 -0000 1.2
@@ -95,61 +95,89 @@
<anchor id="additional-jars"/>
<section>
- <title>3. Additional jar archives</title>
+ <title>3. External dependencies that do not come with OJB</title>
<p>
- OJB depends on several other jar archives. These jar files are
- shipped in the
- <code>db-ojb-<version>/lib</code> directory.
- <link href="http://db.apache.org/ojb/dependencies.html">These jar files are listed here.</link>
+ Some components of OJB depend on external libraries and components that
+ cannot be shipped with OJB. You'll also need these if you want to compile
+ OJB from source. Here is a list of these dependencies:
</p>
+ <dl>
+ <dt><code>j2ee.jar</code></dt>
+ <dd>
+ This is the main archive of the <link href="ext:sun/j2ee-sdk">J2EE SDK</link>.
+ We recommend that you use the 1.3 version as the 1.4 is rather new and not
+ thoroughly tested yet with OJB.
+ </dd>
+ <dt><code>jdo.jar, jdori*.jar</code></dt>
+ <dd>
+ The <link href="ext:sun/jdo">JDO Reference implementation</link> is required
+ if you plan to use the JDO Api.
+ </dd>
+ </dl>
+ </section>
+
+ <anchor id="optional-jars"/>
+ <section>
+ <title>4. Optional jar archives that come with OJB</title>
<p>
- Some of these jar files are only used during build-time and need not to be
- be deployed in runtime environments.
+ Some of jar files in the <code>lib</code> folder are only used during build-time
+ or are only required by certain components of OJB, and so they might need not to
+ be needed in runtime environments.
<br/>
- Apart from wasting disk space they do no harm. If you don't care you just take all jars from
- <code>db-ojb-<version>/lib</code>.
+ Apart from wasting disk space they do no harm. If you don't care about disk space
+ you just take all jars from the <code>lib</code> folder.
<br/>
- If you do care, here is the list of jars you can omit during runtime:
+ If you do care, here is the list of jars you might omit during runtime:
</p>
- <ul>
- <li>
- <code>ant.jar</code>
- </li>
- <li>
- <code>antlr.debug.jar</code>
- </li>
- <li>
- <code>antlr_compiletime.jar</code>
- </li>
- <li>
- <code>junit.jar</code>
- </li>
- <li>
- <code>optional.jar</code>
- </li>
- <li>
- <code>xalan.jar</code>
- </li>
- <li>
- <code>ejb.jar</code>
- </li>
- <li>
- <code>servlet.jar</code>
- </li>
- <li>
- <code>jakarta-regexp-xxx.jar</code>
- </li>
- <li>
- <code>torque-xxx.jar</code>
- </li>
- <li>
- <code>velocity-xxx.jar</code>
- </li>
- </ul>
+ <dl>
+ <dt><code>ant-*.jar</code></dt>
+ <dd>
+ These are the <link href="ext:ant">Apache Ant 1.6</link> jars.
+ </dd>
+ <dt><code>antlr-[version].jar</code></dt>
+ <dd>
+ <link href="ext:antlr">ANTLR</link> is a parser generator which is
+ used in the ODMG component of OJB. If you only use the PB Api, then you
+ don't need this.
+ </dd>
+ <dt><code>junit.jar</code></dt>
+ <dd>
+ <link href="ext:junit">Junit</link> for running the unit tests. You'll need
+ this only if you're also writing unit tests for you app.
+ </dd>
+ <dt><code>xerces.jar, xml-apis.jar</code></dt>
+ <dd>
+ The <link href="ext:xml-apache/xerces">Xerces</link> XML parser. Since most newer
+ JDK's ship with an XML parser, it is likely that you do not need these files.
+ </dd>
+ <dt><code>xalan.jar</code></dt>
+ <dd>
+ <link href="ext:xml-apache/xalan">Xalan</link> is used to generate the unit test report,
+ so you'll probably don't need this.
+ </dd>
+ <dt><code>jakarta-regexp-[version].jar</code></dt>
+ <dd>
+ The <link href="ext:jakarta/regexp">Jakarta Regular Expression library</link> is
+ only used when building OJB from source.
+ </dd>
+ <dt><code>torque-xxx.jar, velocity-xxx.jar</code></dt>
+ <dd>
+ <link href="ext:torque">Torque</link> is used to generate concrete databases
+ from database-independent schema files. OJB uses it internally to setup databases
+ for the unit tests.
+ </dd>
+ <dt><code>xdoclet-[version].jar, xjavadoc-[version].jar, xdoclet-ojb-module-[version].jar, commons-collections-[version].jar</code></dt>
+ <dd>
+ The <link href="site:xdoclet-module">XDoclet OJB module</link> can be used
+ to generate the repository metadata and Torque schema files from Javadoc comments
+ in the Java source files. It is however not required at runtime, so you can safely
+ ignore these files then.
+ </dd>
+ </dl>
</section>
<section>
- <title>4. Don't forget the JDBC driver</title>
+ <title>5. Don't forget the JDBC driver</title>
<p>
The repository.xml defines JDBC Connections
to your runtime databases. To use the declared JDBC drivers the
---------------------------------------------------------------------
To unsubscribe, e-mail: ojb-dev-unsubscribe@db.apache.org
For additional commands, e-mail: ojb-dev-help@db.apache.org