db-torque-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tfisc...@apache.org
Subject svn commit: r915703 - /db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/templates/index.xml
Date Wed, 24 Feb 2010 07:09:14 GMT
Author: tfischer
Date: Wed Feb 24 07:09:14 2010
New Revision: 915703

URL: http://svn.apache.org/viewvc?rev=915703&view=rev
Log:
update template docs:
- update module names and ids
- add info which source files are processed

Modified:
    db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/templates/index.xml

Modified: db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/templates/index.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/templates/index.xml?rev=915703&r1=915702&r2=915703&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/templates/index.xml
(original)
+++ db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/templates/index.xml
Wed Feb 24 07:09:14 2010
@@ -27,34 +27,34 @@
  <body>
   <section name="Introduction">
     <p>
-      The torque-gf templates are a set of templates for the torque-gf 
-      code generator to produce code and sql for a given data model.
-      The data model needs to follow the torque dtd.<br/>
+      The torque templates are a set of templates for the torque
+      generator to produce code and sql for a given data model.
+      The data model needs to follow the torque dtd (TODO: link to dtd).<br/>
       In the templates, the different generation goals (om classes, sql, doc...)
       are organized in different packages. For each generation goal,
       the correct package needs to be accessed. This is described in detail
       in the following sections.<br/>
-      In the following, it is assumed that the maven 2 torque-gf plugin is
-      used to process the templates.
+      In the following, it is assumed that the maven 2 torque-generator plugin
+      is used to process the templates.
     </p>
     <subsection name="preparation">
       <p>
-        For adding the maven 2 torque-gf plugin to your build, add the following
-        to your pom.xml:
+        For adding the maven 2 torque-generator plugin to your build,
+        add the following to your pom.xml:
       </p>
       <source><![CDATA[
       <plugin>
         <groupId>org.apache.torque</groupId>
-        <artifactId>maven-torque-gf-plugin</artifactId>
-        <version>0.2-SNAPSHOT</version>
+        <artifactId>maven-torque-generator-plugin</artifactId>
+        <version>4.0-alpha1-SNAPSHOT</version>
         <executions>
            ...(see below)
         </executions
         <dependencies>
           <dependency>
             <groupId>org.apache.torque</groupId>
-            <artifactId>templates-4-0</artifactId>
-            <version>0.2-SNAPSHOT</version>
+            <artifactId>torque-templates</artifactId>
+            <version>4.0-alpha1-SNAPSHOT</version>
           </dependency>
         </dependencies>
       </plugin>
@@ -63,7 +63,7 @@
     <subsection name="Generation of om classes">
       <p>
         For generating the OM classes, add the following execution to the
-        executions list of the maven torque-gf plugin:
+        executions list of the torque-generator plugin:
       </p>
       <source><![CDATA[
           <execution>
@@ -84,15 +84,17 @@
           </execution>
       ]]></source>
       <p>
-        Replace ${torque.target.database} with the target databsase type 
+        Replace ${torque.target.database} with the target database type 
         (e.g. mysql, oracle). Replace ${torque.schema.source.dir} 
         with the directory where you put your database schemata 
         (e.g. /src/main/schema). Replace ${torque.target.package} 
         with the base package for your generation, e.g. org.apache.torque.test.
       </p>
       <p>
-        This will generate the om code in the directories 
-        target/generated-sources and src/main/generated-sources.
+        This will generate the om code for all source files in the schema
+        directory ending on -schema.xml, but excluding id-table-schema.xml. 
+        The output will be produced in the directories 
+        target/generated-sources and src/main/generated-java.
       </p>
     </subsection> 
     <subsection name="Generation of ddl sql">
@@ -122,13 +124,14 @@
           </execution>
       ]]></source>
       <p>
-        Replace ${torque.target.database} with the target databsase type 
+        Replace ${torque.target.database} with the target database type 
         (e.g. mysql, oracle). Replace ${torque.schema.source.dir} 
         with the directory where you put your database schemata 
         (e.g. /src/main/schema). 
       </p>
       <p>
-        This will generate the sql code in the directory 
+        This will generate the sql code for all source files in the schema
+        directory ending on -schema.xml; the output goes to the directory 
         target/generated-sql.
       </p>
     </subsection> 
@@ -160,21 +163,23 @@
           </execution>
       ]]></source>
       <p>
-        Replace ${torque.target.database} with the target databsase type 
+        Replace ${torque.target.database} with the target database type 
         (e.g. mysql, oracle). Replace ${torque.schema.source.dir} 
         with the directory where you put your database schemata 
         (e.g. /src/main/schema). Replace ${torque.target.package} 
         with the base package for your generation, e.g. org.apache.torque.test.
       </p>
       <p>
-        This will generate the html documentation in the directory 
-        target/generated-docs.
+        This will generate the html documentation for all source files
+        in the schema directory ending on -schema.xml.
+        The output will be produced in the directory target/generated-docs.
       </p>
     </subsection> 
     <subsection name="Generation of xdoc documentation">
       <p>
-        For generating xdoc documentation for the tables (to be included),
-        into your maven site, add the following execution to the executions list
+        For generating xdoc documentation for the tables 
+        (to be included into your maven site),
+        add the following execution to the executions list
         of the maven torque-gf plugin:
       </p>
       <source><![CDATA[
@@ -198,16 +203,18 @@
           </execution>
       ]]></source>
       <p>
-        Replace ${torque.target.database} with the target databsase type 
+        Replace ${torque.target.database} with the target database type 
         (e.g. mysql, oracle). Replace ${torque.schema.source.dir} 
         with the directory where you put your database schemata 
         (e.g. /src/main/schema). Replace ${torque.target.package} 
         with the base package for your generation, e.g. org.apache.torque.test.
       </p>
       <p>
-        This will generate the xdoc documentation in the directory 
-        target/generated-xdocs. You may then want to add the following
-        configuration to your pom to include this directory in your site:
+        This will generate the xdoc documentation
+        for all source files in the schema directory ending on -schema.xml.
+        The output is produced in the directory target/generated-xdocs.
+        You may then want to add the following configuration to your pom
+        to include this directory in your site:
       </p>
       <source><![CDATA[
       <plugin>



---------------------------------------------------------------------
To unsubscribe, e-mail: torque-dev-unsubscribe@db.apache.org
For additional commands, e-mail: torque-dev-help@db.apache.org


Mime
View raw message