cvs commit: jakarta-turbine-tdk/xdocs tdk-howto.xml

quintonm    2003/04/10 17:53:15

  Modified:    xdocs    tdk-howto.xml
  Log:
  Patch from Jeffery Painter [[email protected]]
  
  note to sybase and oracle users needed updating for torque manual
  creation
  
  section 1 was really part of section 3 and combined that info into new section 2.
  
  Revision  Changes    Path
  1.9       +24 -18    jakarta-turbine-tdk/xdocs/tdk-howto.xml
  
  Index: tdk-howto.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-tdk/xdocs/tdk-howto.xml,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- tdk-howto.xml	11 Apr 2003 00:12:30 -0000	1.8
  +++ tdk-howto.xml	11 Apr 2003 00:53:15 -0000	1.9
  @@ -36,7 +36,11 @@
   Before using the TDK, you are going to need to have a Java Software
   Development Kit supporting Java version 1.2 or later installed on your machine.
   Sun's Java SDK can be downloaded from their website located
  +<<<<<<< tdk-howto.xml
  +<a href="http://java.sun.com/j2se/1.4.1/">here.</a>
  +=======
   <a href="http://java.sun.com/j2se/downloads.html">here.</a>
  +>>>>>>> 1.8
   </p>
   
   <p>
  @@ -170,17 +174,7 @@
   </p>
   
   <p>
  -1.  Open up the file "build.properties" in the root TDK directory. Change the 
  -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 "tdk.project" 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>
  -
  -<p>
  -2.  Setup your local environment variables. You will need both JAVA_HOME and 
  +1.  Setup your local environment variables. You will need both JAVA_HOME and 
   ANT_HOME environment values for your system. On *nix/BSD using the Bash shell, 
   this can be done with. It may be smart to go ahead and add these to your startup 
   system login scripts if you have not already. Your CLASSPATH environment should 
  @@ -196,19 +190,31 @@
   ]]></source>
   
   <p>
  -3.  Change to the TDK_HOME directory and modify the <strong>build.properties</strong> file.  
  +2.  Change to the TDK_HOME directory and modify the <strong>build.properties</strong> file.  
   You will need to add an additional property called <strong>tdk.home</strong> which should be set 
   the same as your environment TDK_HOME.  If you wish to change the name of your 
   application, you would adjust the property <strong>tdk.project</strong> to the name you wish.
  +You can also adjust the package and directory structure that will be created at this point if you wish.
  +To change the default package to your own, eg. com.company.appname, change the value of <strong>target.package</strong>
  +and to change the directory you would set <strong>target.directory</strong> These two values
  +are usually a mirror of one another. Here follows an example of the initial <strong>build.properties</strong>
  +located in TDK_HOME
   </p>
   
   <source><![CDATA[
  +# -------------------------------------------------------------------------
  +# This is where you control the initial generation of the Turbine
  +# sample webapp.
  +# -------------------------------------------------------------------------
   tdk.home = /PATH/TO/TDK
  -tdk.project = newapp
  +tdk.turbineVersion = 2
  +tdk.project = newapp 
  +target.package = org.mycompany.newapp
  +target.directory = org/mycompany/newapp
   ]]></source>
   
   <p>
  -4.  Run Ant in the root directory of the TDK_HOME directory. The sample application 
  +3.  Run Ant in the root directory of the TDK_HOME directory. The sample application 
   will be generated with the default name of <strong>newapp</strong>.
   </p>
   
  @@ -221,8 +227,8 @@
   </p>
   
   <p>
  -5.  Once the initial set of files has been created, you will need to go into the 
  -directory <strong>/TDK_HOME/webapps/newapp/WEB-INF/build</strong> and edit your <strong>build.properties</strong> file. 
  +4.  Once the initial set of files has been created, you will need to go into the 
  +directory <strong>TDK_HOME/webapps/newapp/WEB-INF/build</strong> and edit your <strong>build.properties</strong> file. 
   This file is used to specify properties such as the type of database you are using and your DB 
   connection info.  The first adjustment you need to make is to add the <strong>tdk.home</strong>
   directive to the <strong>build.properties</strong> file.
  @@ -277,7 +283,7 @@
   ]]></source>
   
   <p>
  -6.  Go to the directory "/TDK_HOME/webapps/newapp/WEB-INF/build" and run the 
  +5.  Go to the directory "TDK_HOME/webapps/newapp/WEB-INF/build" and run the 
   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>
  @@ -287,7 +293,7 @@
   <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 "build.properties"
  +<strong>torque.database.manualCreation</strong> property in your "build.properties"
   file you can force the 'create-database' target to
   be skipped.
   </p>