db-torque-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Andreas Mohr <a...@rhlx01.fht-esslingen.de>
Subject [PATCH] Tutorial fixes etc.
Date Sat, 10 May 2003 20:02:23 GMT
Hello all,

- add warning to tutorial to NOT use the CVS tree
  (this one cost me a heck of a LOT of time!)
- fix several broken links
- fix many spelling errors

This patch is against current CVS.

I'd appreciate some feedback in case of problems with it.

Thank you,

Andreas Mohr

Index: notes/sybase-status.txt
===================================================================
RCS file: /home/cvspublic/db-torque/notes/sybase-status.txt,v
retrieving revision 1.1
diff -u -r1.1 sybase-status.txt
--- notes/sybase-status.txt	14 Dec 2001 22:14:06 -0000	1.1
+++ notes/sybase-status.txt	10 May 2003 19:21:20 -0000
@@ -8,8 +8,8 @@
   not supported so the JDBCToXMLSchema tasks will not generate the schema
   properly at this time.
 
-o TorqueDataDumpTask will need to know about contraints.  On databases
-  without constrains, the load generated sql will work, but with constraints,
+o TorqueDataDumpTask will need to know about constraints.  On databases
+  without constraints, the load generated sql will work, but with constraints,
   the insert statements need to be in the correct order or they will fail
-  with constaint violations.
+  with constant violations.
 
Index: src/generator/src/java/org/apache/torque/engine/database/transform/DTDResolver.java
===================================================================
RCS file: /home/cvspublic/db-torque/src/generator/src/java/org/apache/torque/engine/database/transform/DTDResolver.java,v
retrieving revision 1.3
diff -u -r1.3 DTDResolver.java
--- src/generator/src/java/org/apache/torque/engine/database/transform/DTDResolver.java	30
Apr 2003 22:27:25 -0000	1.3
+++ src/generator/src/java/org/apache/torque/engine/database/transform/DTDResolver.java	10
May 2003 19:21:21 -0000
@@ -103,7 +103,7 @@
             }
             else
             {
-                log.warn("Could not located the database.dtd");
+                log.warn("Could not locate the database.dtd");
             }
         }
         catch (Exception ex)
Index: src/java/org/apache/torque/Torque.java
===================================================================
RCS file: /home/cvspublic/db-torque/src/java/org/apache/torque/Torque.java,v
retrieving revision 1.80
diff -u -r1.80 Torque.java
--- src/java/org/apache/torque/Torque.java	21 Mar 2003 20:30:31 -0000	1.80
+++ src/java/org/apache/torque/Torque.java	10 May 2003 19:21:22 -0000
@@ -215,7 +215,7 @@
         if (configuration == null || configuration.isEmpty())
         {
             // If there are no properties in the "torque" namespace
-            // than try the "services.DatabaseService" namespace. This
+            // then try the "services.DatabaseService" namespace. This
             // will soon be deprecated.
             configuration = originalConf.subset("services.DatabaseService");
             if (configuration != null && !configuration.isEmpty())
Index: src/java/org/apache/torque/adapter/DBInterbase.java
===================================================================
RCS file: /home/cvspublic/db-torque/src/java/org/apache/torque/adapter/DBInterbase.java,v
retrieving revision 1.6
diff -u -r1.6 DBInterbase.java
--- src/java/org/apache/torque/adapter/DBInterbase.java	24 Jun 2002 18:12:19 -0000	1.6
+++ src/java/org/apache/torque/adapter/DBInterbase.java	10 May 2003 19:21:22 -0000
@@ -105,7 +105,7 @@
     /**
      * Gets the string delimiter (usually '\'').
      *
-     * @return The delimeter.
+     * @return The delimiter.
      */
     public char getStringDelimiter()
     {
Index: xdocs/index.xml
===================================================================
RCS file: /home/cvspublic/db-torque/xdocs/index.xml,v
retrieving revision 1.21
diff -u -r1.21 index.xml
--- xdocs/index.xml	26 Mar 2003 19:39:01 -0000	1.21
+++ xdocs/index.xml	10 May 2003 19:21:22 -0000
@@ -98,7 +98,7 @@
           <td></td>
         </tr>
         <tr>
-          <td>Mysql</td>
+          <td>MySQL</td>
           <td>org.gjt.mm.mysql.Driver</td>
           <td>no known problems</td>
           <td><a href="mailto:mpoeschl@marmot.at">Martin Poeschl</a></td>
Index: xdocs/mssql-howto.xml
===================================================================
RCS file: /home/cvspublic/db-torque/xdocs/mssql-howto.xml,v
retrieving revision 1.5
diff -u -r1.5 mssql-howto.xml
--- xdocs/mssql-howto.xml	2 Oct 2002 14:41:19 -0000	1.5
+++ xdocs/mssql-howto.xml	10 May 2003 19:21:22 -0000
@@ -65,7 +65,7 @@
 </p>
 
 </section>
-<section name="Edit properity files">
+<section name="Edit property files">
 <p>
 In the ...\WEB-INF\build\build.properties file make sure that;
 </p>
Index: xdocs/properties-reference.xml
===================================================================
RCS file: /home/cvspublic/db-torque/xdocs/properties-reference.xml,v
retrieving revision 1.7
diff -u -r1.7 properties-reference.xml
--- xdocs/properties-reference.xml	15 Nov 2002 12:10:46 -0000	1.7
+++ xdocs/properties-reference.xml	10 May 2003 19:21:22 -0000
@@ -152,7 +152,7 @@
   <td><code> torque.database.buildUrl </code></td>
   <td><code> N/A </code></td>
   <td>
-    The JDBC URL that will be used to access yourdatabase. Torque can use
+    The JDBC URL that will be used to access your database. Torque can use
     this to create your tables if instructed to do so.  This value should
     reflect the database name specified in the database schema file
     (described in the next section).
@@ -273,7 +273,7 @@
   <td><code> torque.addTimeStamp </code></td>
   <td><code> true </code></td>
   <td>
-    If true, Torque true puts time stamps in generated om files.
+    If true, Torque puts time stamps in generated om files.
   </td>
 </tr>
 <tr>
@@ -288,7 +288,7 @@
   <td><code> true </code></td>
   <td>
     If true, Torque generates data objects with collection support and
-    methods to easily retreive foreign key relationships.
+    methods to easily retrieve foreign key relationships.
   </td>
 </tr>
 <tr>
Index: xdocs/schema-reference.xml
===================================================================
RCS file: /home/cvspublic/db-torque/xdocs/schema-reference.xml,v
retrieving revision 1.6
diff -u -r1.6 schema-reference.xml
--- xdocs/schema-reference.xml	7 Apr 2003 20:50:22 -0000	1.6
+++ xdocs/schema-reference.xml	10 May 2003 19:21:23 -0000
@@ -14,8 +14,8 @@
     <p>
       The Torque Database Schema Reference attempts to explain what the
       different elements and attributes are when defining your own database
-      schema. In addition I will attempt to explain what attributes mean what
-      in the different databases currently supported.
+      schema. In addition I will attempt to explain which attributes mean what
+      in the different databases that are currently supported.
     </p>
    </section>
 
@@ -175,7 +175,7 @@
        <p>
          The base peer to use when generating the Object Model Peers.
          Unlike baseClass, basePeer should extend BasePeer at some point in the
-         chain, i.e it needs to be the superclass.
+         chain, i.e. it needs to be the superclass.
        </p>
      </subsection>
      <subsection name="Element: table">
Index: xdocs/status.xml
===================================================================
RCS file: /home/cvspublic/db-torque/xdocs/status.xml,v
retrieving revision 1.5
diff -u -r1.5 status.xml
--- xdocs/status.xml	18 Apr 2003 07:42:42 -0000	1.5
+++ xdocs/status.xml	10 May 2003 19:21:23 -0000
@@ -12,7 +12,7 @@
     <section name="News and Status">
       <p>
         This document contains the latest news and status regarding the
-        Torque project.  It is here you'll find announcements related to
+        Torque project.  It is here that you'll find announcements related to
         Torque.
       </p>
       <p>
Index: xdocs/tutorial.xml
===================================================================
RCS file: /home/cvspublic/db-torque/xdocs/tutorial.xml,v
retrieving revision 1.10
diff -u -r1.10 tutorial.xml
--- xdocs/tutorial.xml	31 Jan 2003 16:53:27 -0000	1.10
+++ xdocs/tutorial.xml	10 May 2003 19:21:24 -0000
@@ -50,6 +50,12 @@
   not been released; however, there is a beta version
   <a href="http://jakarta.apache.org/builds/jakarta-turbine/torque/release/">
   available</a>.
+  Note that for this tutorial, you should NOT use the CVS version
+  of db-torque instead of the normal release version, since the
+  Torque CVS tree has a differing directory layout; thus it's unsuitable
+  for this example (at least if you're a newbie who doesn't know how to
+  configure the CVS version properly, which is probably true
+  for most people that are reading this tutorial).
 </p>
 
 <p>
@@ -112,7 +118,7 @@
   bare minimum to get your first Torque application up
   and running.  However, the <em>build.properties</em>
   file is thoroughly commented, so please refer to it
-  if you have a question regarding part of the file
+  if you have a question regarding a part of the file
   that is not covered here.  Make the following
   changes and edit appropriately for your environment.
   The properties are described in the table following
@@ -174,7 +180,7 @@
   format of <em>name-schema.xml</em> where
   <em>name</em> was the same as the <em>project</em>
   property defined in <em>build.properties</em>;
-  otherwise, Torque was not be able to find your
+  otherwise, Torque was not able to find your
   database schema file.  This is no longer the case,
   <em>name</em> is no longer restricted to the project
   name. However, it must end with
@@ -432,7 +438,7 @@
   for the database schema.  In addition, you must
   include the XML declaration and DTD specification in
   your database schema file.  Failure to do so can
-  result it errors.
+  result in errors.
 </p>
 
 <p>
@@ -529,7 +535,7 @@
 log4j.appender.default.file = ./torque.log
 log4j.appender.default.layout = org.apache.log4j.SimpleLayout
 
-torque.database.default=bookstore
+torque.database.default = bookstore
 torque.database.bookstore.driver = org.gjt.mm.mysql.Driver
 torque.database.bookstore.url = jdbc:mysql://127.0.0.1/bookstore
 torque.database.bookstore.username = user
@@ -1010,7 +1016,7 @@
   table defines a static method called
   <em>doSelect</em> which is used to pull data out of
   the table.  The argument to <em>doSelect</em> is a
-  <em>Critieria</em> object.  It is this object that
+  <em>Criteria</em> object.  It is this object that
   specifies the criteria to be used when selecting
   data from the database.  As a result of the query,
   <em>doSelect</em> returns a vector of Data Objects
@@ -1149,7 +1155,7 @@
   that represents the row by invoking one or more
   mutators and then calling its <em>save</em> method.
   When a mutator is called, the Data Object sets an
-  internal flag to indicate that its been modified.
+  internal flag to indicate that it's been modified.
   This flag is checked when <em>save</em> is invoked
   to determine if the Peer's <em>doInsert</em> or
   <em>doUpdate</em> is called to perform the database
Index: xdocs/tutorial/step1.xml
===================================================================
RCS file: /home/cvspublic/db-torque/xdocs/tutorial/step1.xml,v
retrieving revision 1.2
diff -u -r1.2 step1.xml
--- xdocs/tutorial/step1.xml	6 Dec 2002 17:35:20 -0000	1.2
+++ xdocs/tutorial/step1.xml	10 May 2003 19:21:24 -0000
@@ -13,6 +13,12 @@
   First, you need to obtain the Torque
   <a href="http://jakarta.apache.org/builds/jakarta-turbine/torque/release/">
   distribution</a>.
+  Note that for this tutorial, you should NOT use the CVS version
+  of db-torque instead of the normal release version, since the
+  Torque CVS tree has a differing directory layout; thus it's unsuitable
+  for this example (at least if you're a newbie who doesn't know how to
+  configure the CVS version properly, which is probably true
+  for most people that are reading this tutorial).
 </p>
 
 <p>
Index: xdocs/tutorial/step2.xml
===================================================================
RCS file: /home/cvspublic/db-torque/xdocs/tutorial/step2.xml,v
retrieving revision 1.2
diff -u -r1.2 step2.xml
--- xdocs/tutorial/step2.xml	31 Jan 2003 16:53:28 -0000	1.2
+++ xdocs/tutorial/step2.xml	10 May 2003 19:21:25 -0000
@@ -49,7 +49,7 @@
   bare minimum to get your first Torque application up
   and running.  However, the <em>build.properties</em>
   file is thoroughly commented, so please refer to it
-  if you have a question regarding part of the file
+  if you have a question regarding a part of the file
   that is not covered here.  Make the following
   changes and edit appropriately for your environment.
   The properties are described in the table following
@@ -72,7 +72,7 @@
 
 <p>
   For a reference as to what each property, and others, controls, please
-  see the <a href="properties-reference.html">properties reference</a>.
+  see the <a href="../properties-reference.html">properties reference</a>.
 </p>
 
 <p>
@@ -111,7 +111,7 @@
   format of <em>name-schema.xml</em> where
   <em>name</em> was the same as the <em>project</em>
   property defined in <em>build.properties</em>;
-  otherwise, Torque was not be able to find your
+  otherwise, Torque was not able to find your
   database schema file.  This is no longer the case,
   <em>name</em> is no longer restricted to the project
   name. However, it must end with
@@ -369,7 +369,7 @@
   for the database schema.  In addition, you must
   include the XML declaration and DTD specification in
   your database schema file.  Failure to do so can
-  result it errors.
+  result in errors.
 </p>
 
 <p>
@@ -466,7 +466,7 @@
 log4j.appender.default.file = ./torque.log
 log4j.appender.default.layout = org.apache.log4j.SimpleLayout
 
-torque.database.default=bookstore
+torque.database.default = bookstore
 torque.database.bookstore.driver = org.gjt.mm.mysql.Driver
 torque.database.bookstore.url = jdbc:mysql://127.0.0.1/bookstore
 torque.database.bookstore.username = user
@@ -572,4 +572,4 @@
 </p>
 
   </body>
-</document>
\ No newline at end of file
+</document>
Index: xdocs/tutorial/step3.xml
===================================================================
RCS file: /home/cvspublic/db-torque/xdocs/tutorial/step3.xml,v
retrieving revision 1.1
diff -u -r1.1 step3.xml
--- xdocs/tutorial/step3.xml	28 Sep 2002 01:21:41 -0000	1.1
+++ xdocs/tutorial/step3.xml	10 May 2003 19:21:25 -0000
@@ -89,7 +89,7 @@
   than likely a formatting error of your database
   schema file.  Check the format of the file and make
   sure it conforms to the
-  <a href="/turbine/torque/schema-reference.html">
+  <a href="../schema-reference.html">
   Torque Schema Reference</a>.
 </p>
 
Index: xdocs/tutorial/step4.xml
===================================================================
RCS file: /home/cvspublic/db-torque/xdocs/tutorial/step4.xml,v
retrieving revision 1.2
diff -u -r1.2 step4.xml
--- xdocs/tutorial/step4.xml	12 Oct 2002 08:26:52 -0000	1.2
+++ xdocs/tutorial/step4.xml	10 May 2003 19:21:26 -0000
@@ -213,7 +213,7 @@
   table defines a static method called
   <em>doSelect</em> which is used to pull data out of
   the table.  The argument to <em>doSelect</em> is a
-  <em>Critieria</em> object.  It is this object that
+  <em>Criteria</em> object.  It is this object that
   specifies the criteria to be used when selecting
   data from the database.  As a result of the query,
   <em>doSelect</em> returns a vector of Data Objects
@@ -352,7 +352,7 @@
   that represents the row by invoking one or more
   mutators and then calling its <em>save</em> method.
   When a mutator is called, the Data Object sets an
-  internal flag to indicate that its been modified.
+  internal flag to indicate that it's been modified.
   This flag is checked when <em>save</em> is invoked
   to determine if the Peer's <em>doInsert</em> or
   <em>doUpdate</em> is called to perform the database


-- 
Andreas Mohr                        Stauferstr. 6, D-71272 Renningen, Germany

Mime
View raw message