db-torque-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From quint...@apache.org
Subject cvs commit: db-torque/src/generator/src/maven-plugin/xdocs goals.xml index.xml
Date Fri, 21 Feb 2003 18:13:55 GMT
quintonm    2003/02/21 10:13:54

  Modified:    src/generator/src/maven-plugin/xdocs index.xml
  Added:       src/generator/src/maven-plugin/xdocs goals.xml
  Log:
  - Updated the index to better describe the maven plugin.
  - Created a new goals document for documenting the goals.
  
  Revision  Changes    Path
  1.2       +16 -3     db-torque/src/generator/src/maven-plugin/xdocs/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/db-torque/src/generator/src/maven-plugin/xdocs/index.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- index.xml	10 Feb 2003 13:29:33 -0000	1.1
  +++ index.xml	21 Feb 2003 18:13:54 -0000	1.2
  @@ -4,14 +4,27 @@
     <properties>
       <title>Maven Torque Plugin</title>
       <author email="stephenh@chase3000.com">Stephen Haberman</author>
  +    <author email="quintonm@bellsouth.net">Quinton McCombs</author>
     </properties>
   
     <body>
       <section name="Maven Torque Plugin">
         <p>
  -        This plugin simply delegates to the <code>build-torque.xml</code> file
  -        shipped with the plugin and will read the Torque templates from the
  -        classpath instead of relying on copies of templates in your source tree.
  +        This plugin provides easy intergration with 
  +        <a href="/torque/">Torque</a> for your project.  This replaces using
  +        the build-torque.xml ant script that previously provided the same
  +        functionality.
  +      </p>
  +      <p>
  +      	By default, the templates used for code generation are found in
  +      	the torque-gen jar file.  You can override this behavior by
  +      	setting the appropriate <a href="properties.html">property</a>.
  +      </p>
  +      <p>
  +        For more information on the functionality provided by this plugin
  +        see the <a href="goals.html">Goals</a> document.  The various 
  +        properties used to configure the plugin are documented in the
  +        <a href="properties.html">Properties</a> document.
         </p>
       </section>
    </body>
  
  
  
  1.1                  db-torque/src/generator/src/maven-plugin/xdocs/goals.xml
  
  Index: goals.xml
  ===================================================================
  <?xml version="1.0"?>
  <document>
  
    <properties>
      <title>Maven Torque Plugin</title>
      <author email="quintonm@bellsouth.net">Quinton McCombs</author>
    </properties>
  
    <body>
      <section name="Goals">
        <table>
        	<tr>
        	  <td>Goal</td>
        	  <td>Description</td>
        	</tr>
        	
        	<tr>
        	  <td>torque</td>
        	  <td>
        	    Calls the torque:sql and torque:om goals
        	  </td>
        	</tr>
        	<tr>
        	  <td>torque:sql</td>
        	  <td>
        	    Generates the SQL for your project
        	  </td>
        	</tr>
        	<tr>
        	  <td>torque:om</td>
        	  <td>
        	    Generate the Peer-based object model from *-schema.xml files
        	  </td>
        	</tr>
        	<tr>
        	  <td>torque:datadtd</td>
        	  <td>
        	    Generates the DATA DTD for your project
        	  </td>
        	</tr>
        	<tr>
        	  <td>torque:datadump</td>
        	  <td>
        	    Dump data from database into xml file
        	  </td>
        	</tr>
        	<tr>
        	  <td>torque:datasql</td>
        	  <td>
        	    Generates sql from data xml  
        	  </td>
        	</tr>
        	<tr>
        	  <td>torque:create-db</td>
        	  <td>
        	    Creates your database from you XMl schema file.  Warning:  This 
        	    goal will drop all tables and recreate them.  Any existing data
        	    will be lost!
        	  </td>
        	</tr>
        	<tr>
        	  <td>torque:doc</td>
        	  <td>
        	    Generates an HTML document from your XMl schema file.
        	  </td>
        	</tr>
        	<tr>
        	  <td>torque:jdbc</td>
        	  <td>
        	    Creates an XML schema file by reverse engineering your database.
        	  </td>
        	</tr>
        	<tr>
        	  <td>torque:insert-sql</td>
        	  <td>
        	    Inserts the generated sql
        	  </td>
        	</tr>
        	<tr>
        	  <td>torque:id-table-init-sql</td>
        	  <td>
        	    Generates initialization sql for ID Broker
        	  </td>
        	</tr>
        	<tr>
        	  <td>torque:om-zip</td>
        	  <td>
        	    Moves source om files to separate jar and out of 
        	    the source tree
        	  </td>
        	</tr>
        	<tr>
        	  <td>torque:sql2xml</td>
        	  <td>
        	    Create an xml schema from an sql schema
        	  </td>
        	</tr>
        	<tr>
        	  <td>torque:ojb</td>
        	  <td>
        	    Generates the repository and om for ojb (experimental)
        	  </td>
        	</tr>
        </table>
        
      </section>
   </body>
  </document>
  
  
  

Mime
View raw message