jvanzyl 01/05/28 07:22:07
Modified: xdocs/howto tdk-howto.xml
Log:
- updating the tdk howto to reflect the standard use of build.xml and
build.properties everywhere.
Revision Changes Path
1.13 +24 -19 jakarta-turbine/xdocs/howto/tdk-howto.xml
Index: tdk-howto.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine/xdocs/howto/tdk-howto.xml,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- tdk-howto.xml 2001/05/21 22:41:40 1.12
+++ tdk-howto.xml 2001/05/28 14:22:06 1.13
@@ -49,13 +49,17 @@
<p>
In order to do anything interesting with the TDK, you are also going to need a
database that is compatable with the JDBC standard. The TDK currently comes
-with drivers for MySQL and Postgres. Other drivers can be downloaded from the
-vendor's websites located here:
+with drivers for Hypersonic, InstantDB, MySQL, Postgres and SAPDB. Other drivers
can be
+downloaded from the vendor's websites located here:
</p>
<ul>
-<li><a
href="http://technet.oracle.com/software/tech/java/sqlj_jdbc/software_index.htm";>Oracle
JDBC Drivers</a>.</li>
-<li><a href="http://instantdb.enhydra.org/";>InstantDB JDBC Drivers</a>.</li>
+ <li>
+ <a
href="http://technet.oracle.com/software/tech/java/sqlj_jdbc/software_index.htm";>Oracle
JDBC Drivers</a>.
+ </li>
+ <li>
+ <a href="http://www.sybase.com/products/eaimiddleware/jconnectforjdbc/";>Sybase
JDBC Drivers</a>.
+ </li>
</ul>
<p>
@@ -133,7 +137,7 @@
</p>
<source><![CDATA[
-tar -xvzf tdk1-1a14.tar.gz
+tar -xvzf tdk-2.1.tar.gz
]]></source>
<p>
@@ -155,7 +159,7 @@
property "target.package" to the name of the package that you would like your
java files to live in and the property "target.directory" to the directory that
you would like your classes to be created in. These two values are usually a
-mirror of one another. Finally, change the property "turbine.app.name" to the
+mirror of one another. Finally, change the property "turbine.app" to the
name of the application that you would like to create. Usually this is the same
as the identifier specified at the end of your target.package.
</p>
@@ -188,20 +192,20 @@
<p>
4. Once the initial set of files has been created, you will need to go into
-the directory "/TDKROOT/webapps/APPNAME/WEB-INF/build/project" and edit
-your "APPNAME.properties" file. This file is used to specify properties
+the directory "/TDKROOT/webapps/APPNAME/WEB-INF/build" and edit
+your "build.properties" file. This file is used to specify properties
such as the type of database you are using and your DB connection info. This
information is used to create the tables Turbine will be using and the classes
used to access them. At this time you should also copy your JDBC drivers
(renaming .zip files to .jar files) into the
-"webapps/APPNAME/WEB-INF/lib" directory if you are using a database other than
-MySQL or Postgres. These files will be important when creating the database
-tables in the next step.
+"webapps/APPNAME/WEB-INF/lib" directory if you are using a database for which
+the TDK does not provide JDBC drivers. These files will be important when
+creating the database tables in the next step.
</p>
<p>
5. Go to the directory "/TDKROOT/webapps/APPNAME/WEB-INF/build" and run the
-command "./build.sh init" This command <strong>must be run</strong> before
+command "ant init" This command <strong>must be run</strong> before
attempting to use the TDK. It creates the database tables and OM
classes for accessing them.
</p>
@@ -211,15 +215,16 @@
<br/>
For Oracle and Sybase users it is often common that the database
has already been created: if this is the case then by setting the
-<strong>database.manual.creation</strong> property in your project
-properties file you can force the 'create-database' target to
+<strong>database.manual.creation</strong> property in your "build.properties"
+file you can force the 'create-database' target to
be skipped.
</p>
<p>
6. Your first Turbine app has now been created! go back to the root directory
-of your TDK installation and type in "./bin/startup.sh" This will start the
-Tomcat servlet engine and make your application available.
+of your TDK installation and type in "./bin/catalina.sh run" if you want to
+see console output or "./bin/catalina.sh start" if you want the servlet
+container process to run in the background.
</p>
<p>
@@ -345,13 +350,13 @@
<p>
Now that we know about actions, we should change our database to something more
useful. In order to do this, move to the directory
-"webapps/APPNAME/WEB-INF/build/project" and open up the file
+"webapps/APPNAME/WEB-INF/conf" and open up the file
"APPNAME-schema.xml". This file contains our database schema in XML. This
file should be rather self explainatory. Within it you can create new tables
and new fields within existing tables. Add some more rows to the example
table and save the file back. Now go to the directory
"webapps/APPNAME/WEB-INF/build" and run the command
-"./build.sh init" again. (WARNING: If this is done you will lose all of your
+"ant init" again. (WARNING: If this is done you will lose all of your
data in the existing tables, do not run if you have data in your tables
that you want to save.) This will update existing databases and their objects
with new fields and create the databases defined in the .xml file, along with
@@ -380,7 +385,7 @@
You now have your first Turbine application up and running and you now know
how to edit the Java and .vm files in the TDK in order to begin building a
specific application. In order to recompile any Java files that you change
-or create in the TDK, run "webapps/APPNAME/WEB-INF/build.sh compile".
+or create in the TDK, move to "webapps/APPNAME/WEB-INF/build" and run "ant compile".
This will recompile all of the Java files that have changed in your project.
You may also wish to join the Turbine Users mailing list. Instructions for
doing so can be found <a href="http://jakarta.apache.org/site/mail.html";>here.</a>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
