Cleaning up some rough edges in the TDK getting started guide.
Index: getting-started-tdk.xml
===================================================================
RCS file: /home/cvspublic/jakarta-turbine/xdocs/getting-started-tdk.xml,v
retrieving revision 1.2
diff -u -r1.2 getting-started-tdk.xml
--- getting-started-tdk.xml 2001/05/10 03:39:49 1.2
+++ getting-started-tdk.xml 2001/05/11 07:09:15
@@ -25,7 +25,7 @@
the TDK quickly and with a general knowledge of how it works. As usual, please
be sure that you have scoured the entire website for information before asking
questions on the mailing list. Also, it is suggested that you read this entire
-page before attemping to install the TDK.
+guide before attemping to install the TDK.
</p>
</section>
@@ -51,8 +51,8 @@
</p>
<p>
-Simply download this driver to a directory right now where you can remember
-where it is. We will make use of it later.
+Simply download these drivers to any directory for now. We will make use
+of them later.
</p>
</section>
@@ -70,8 +70,7 @@
]]></source>
<p>
-should to the trick. This is all that you have to do to install the TDK, but
-now a sample app needs to be created in order to see what it can do.
+should to the trick. This is all that you have to do to install the TDK.
</p>
</section>
@@ -119,18 +118,18 @@
]]></source>
<p>
-from your root TDK directory. This will create many of the files necessary for
+from your root TDK directory. This will create most of the files necessary for
running your turbine app.
</p>
<p>
-4. Once this initial set of classes has been created, you will need to go into
-the directory "/TDKROOT/webapps/APPNAME/WEB-INF/build/project" in order to edit
-your "APPNAME.properties" file. In this file you will need to specify things
-such as the type of database you are using and its connection info. This
-information is used to create the database you will be using and the classes
-used to access it. At this time you should also copy your JDBC drivers
-(renaming .zip files to .jar files, if necessary) into the
+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
+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.
@@ -139,7 +138,7 @@
<p>
5. Go to the directory "/TDKROOT/webapps/APPNAME/WEB-INF/build" and run the
command "./build.sh init" This command MUST BE RUN before attempting to use
-Turbine. It creates the database tables and OM classes for accessing them.
+the TDK. It creates the database tables and OM classes for accessing them.
</p>
<p>
@@ -189,8 +188,8 @@
into the layout template above. Edit the file "DefaultBottom.vm", save your
changes back, and reload your page. By doing this you should see whatever
changes you have made to the file appear at the bottom of your layout. This
-change will also occur in all of the other pages on your site. Change to a
-different page to confirm this.
+change will also occur in all of the other pages on your site. Navigate to a
+different page in order to confirm this behavior.
</p>
<p>
@@ -204,7 +203,8 @@
The Index.vm page also includes a number of functions that begin with #, such as
"#entryCell(...)" These functions are replaced with HTML fragments at runtime,
as defined in the "webapps/APPNAME/templates/GlobalMacros.vm" file. Look at
-this file to get an idea of what each of these methods do.
+this file to get an idea of what each of these methods do. This file can be
+edited in order to add your own velocity macros to the system as well.
</p>
<p>
@@ -217,9 +217,9 @@
database in the "getEntries" method into it. In the case of the Index.vm page,
this corresponds to all of the entries from our example database. The
"context.put("entries", getEntries())" method places the data and the associated
-handle for it into our session context so that it can be accessed from our .vm
-pages. You would edit this file to change the behavior of a given page. More
-information on building sites with Velocity is available
+handle for it into our session context so that it can be accessed from our
+Index.vm page. You would edit this file to change the behavior of a given
+page. More information on building sites with Velocity is available
<a href="velocity-site.html">here.</a>
</p>
@@ -246,15 +246,16 @@
<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 "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
+"webapps/APPNAME/WEB-INF/build/project" 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
-data in the existing database, do not run if you have data in your database
-that you need.) This will update existing databases and their objects with
-new fields and create the databases defined in the .xml file, along with
+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
their associated java classes. The java classes that Turbine uses to access
your database are located in the directory
"webapps/APPNAME/WEB-INF/src/java/PACKAGE/om" Look at them to get an idea of
@@ -277,12 +278,13 @@
<section name="Conclusion">
<p>
-You now have your first Turbine application up and running. You can now begin
-changing the Java and vm files to begin building the real application that you
-have in mind. In order to recompile a Java file you change, run
-"webapps/APPNAME/WEB-INF/build.sh 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
+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".
+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>
</p>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
