Author: tfischer
Date: Sat Jan 21 04:11:16 2006
New Revision: 371019
URL: http://svn.apache.org/viewcvs?rev=371019&view=rev
Log:
- merged lots of content from the maven-howto in the runtime to the index site.
The maven-howto in the runtime will be removed.
- added the site skeleton navigation to the navigation
- updated some links
- added linkcheck excludes to svn.apache.org and ..
Modified:
db/torque/maven-plugin/trunk/project.properties
db/torque/maven-plugin/trunk/project.xml
db/torque/maven-plugin/trunk/xdocs/index.xml
db/torque/maven-plugin/trunk/xdocs/navigation.xml
Modified: db/torque/maven-plugin/trunk/project.properties
URL:
http://svn.apache.org/viewcvs/db/torque/maven-plugin/trunk/project.properties?rev=371019&r1=371018&r2=371019&view=diff
==============================================================================
--- db/torque/maven-plugin/trunk/project.properties (original)
+++ db/torque/maven-plugin/trunk/project.properties Sat Jan 21 04:11:16 2006
@@ -23,3 +23,5 @@
# multiproject build
maven.multiproject.type=plugin
+
+maven.linkcheck.exclude=http://svn.apache.org,..
\ No newline at end of file
Modified: db/torque/maven-plugin/trunk/project.xml
URL:
http://svn.apache.org/viewcvs/db/torque/maven-plugin/trunk/project.xml?rev=371019&r1=371018&r2=371019&view=diff
==============================================================================
--- db/torque/maven-plugin/trunk/project.xml (original)
+++ db/torque/maven-plugin/trunk/project.xml Sat Jan 21 04:11:16 2006
@@ -108,7 +108,7 @@
<artifactId>xercesImpl</artifactId>
<groupId>xerces</groupId>
<version>2.6.2</version>
- <url>http://xml.apache.org/xerces2-j/</url>
+ <url>http://xerces.apache.org/xerces2-j/</url>
</dependency>
<dependency>
Modified: db/torque/maven-plugin/trunk/xdocs/index.xml
URL:
http://svn.apache.org/viewcvs/db/torque/maven-plugin/trunk/xdocs/index.xml?rev=371019&r1=371018&r2=371019&view=diff
==============================================================================
--- db/torque/maven-plugin/trunk/xdocs/index.xml (original)
+++ db/torque/maven-plugin/trunk/xdocs/index.xml Sat Jan 21 04:11:16 2006
@@ -16,38 +16,165 @@
-->
<document>
- <properties>
- <title>Maven Torque Plugin</title>
- <author email="[EMAIL PROTECTED]">Stephen Haberman</author>
- <author email="[EMAIL PROTECTED]">Quinton McCombs</author>
- <author email="[EMAIL PROTECTED]">Scott Eade</author>
- </properties>
+ <properties>
+ <title>Maven Torque Plugin</title>
+ <author email="[EMAIL PROTECTED]">Stephen Haberman</author>
+ <author email="[EMAIL PROTECTED]">Quinton McCombs</author>
+ <author email="[EMAIL PROTECTED]">Scott Eade</author>
+ <author email="[EMAIL PROTECTED]">Thomas Fischer</author>
+ </properties>
+
+ <body>
+ <section name="Introduction">
+
+ <p>
+ Torque projects used to be built with all of the Torque elements
+ (templates, property files, <code>build-torque.xml</code>, etc.)
+ locally installed in each project's source tree.
+ </p>
+
+ <p>
+ The advent of Maven allows Torque to be used in a much simpler manner.
+ With the Maven plugin, absolutely no Torque-related resources
+ (except the Torque jar file itself) are required to be
+ locally installed in each project. Instead, the plugin will
+ automatically download any required resources for you.
+ </p>
+
+ <p>
+ At the moment, only Maven 1 is supported by the Torque Maven plugin.
+ The recommended version is Maven 1.0.2.
+ </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>
+
+ <section name="Installation">
+
+ <p>
+ The Torque Maven plugin is installed thus:
+ </p>
+
+<source><![CDATA[
+maven plugin:download -DartifactId=maven-torque-plugin -DgroupId=torque
-Dversion=3.2
+]]></source>
+
+ </section>
+
+ <section name="Configuration">
+
+ <p>
+ The Torque Maven plugin is configured via properties defined in your
+ project.properties file. See the
+ <a href="properties.html">properties reference</a> for
+ details on the various properties that can be configured.
+ </p>
+
+ <subsection name="project.properties">
- <body>
- <section name="Maven Torque Plugin">
- <p>
- This plugin provides easy intergration with
- <a href="../index.html">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>.
+ Instead of relying on the typical <code>build.properties</code>,
+ the Maven plugin uses the project-wide settings in the
+ <code>project.properties</code> file.
</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.
+ The Torque settings in <code>project.properties</code> follow the same
+ format as they would in the generator's <code>build.properties</code>
+ except the default directories are different to better fit a maven-ized
+ project.
</p>
+
<p>
- We are working on providing a release of the Torque maven-plugin
- fairly soon - in the mean time, please see the
- <a href="../maven-howto.html">Maven Howto</a> for installation and
- configuration instructions.
+ Here is a sample <code>project.properties</code>:
</p>
- </section>
+
+<source><![CDATA[
+... other project settings...
+
+# -------------------------------------------------------------------
+#
+# T O R Q U E S E T T I N G S
+#
+# -------------------------------------------------------------------
+
+torque.project = yourproject
+torque.database = mysql
+
+torque.database.createUrl = jdbc:mysql://localhost:3306/
+torque.database.buildUrl = jdbc:mysql://localhost:3306/yourprojectdb
+torque.database.url = jdbc:mysql://localhost:3306/yourprojectdb
+torque.database.driver = org.gjt.mm.mysql.Driver
+torque.database.user = user
+torque.database.password = password
+torque.database.host = localhost
+
+]]></source>
+
+ </subsection>
+
+ </section>
+
+ <section name="Cutomization of templates">
+
+ <p>
+ Internally, the Torque Maven plugin uses the
+ <a href="../generator/index.html">Torque generator</a>
+ to execute its tasks. The generator in turn uses the Torque generator
+ templates to build the java classes and SQL scripts.
+ If you want to customize the generated classes or SQL beyond the
+ possibilities offeret by the
+ <a href="properties.html">project properties</a>, you can use your
+ own templates either by uploading your own
+ <code>torque-gen-templates.jar</code> into the maven repository, or
+ you can tell the maven plugin to use an external templates directory,
+ see the <a href="properties.html">property reference</a>.
+ </p>
+
+ </section>
+
+ <section name="Building from Source">
+
+ <p>
+ Building the maven plugin from source is relatively easy -
+ you might want to do this if there are fixes or enhancements in SVN
+ that you want to make use of. Another reason you might want
+ to do this is if you wish to make your own copy of the plugin
+ that includes a set of customized generator templates
+ to modify the object model class files that will be produced.
+ </p>
+
+ <p>
+ The first thing to do is to check out Torque from SVN; see the
+ <a href="../../../../developer-info/subversion.html">Subversion Guide</a>
+ for more information. First build and install the generator templates,
+ then build and install the generator. Finally, run <code>maven
+ plugin:install</code> in the <code>maven-plugin</code> directory.
+ This will jar together the various plugin files and copy the jar
+ into your <code>${maven.home}/plugins</code> directory.
+ </p>
+
+ </section>
+
+ <section name="Other Tips">
+
+ <p>
+ If you run into problems, try the following tips:
+ <ul>
+ <li>
+ Don't place your <code>project-schema.xml</code> file in a directory
+ with other files. This can lead to various DTD errors.
+ </li>
+ </ul>
+ </p>
+
+ </section>
+
</body>
</document>
Modified: db/torque/maven-plugin/trunk/xdocs/navigation.xml
URL:
http://svn.apache.org/viewcvs/db/torque/maven-plugin/trunk/xdocs/navigation.xml?rev=371019&r1=371018&r2=371019&view=diff
==============================================================================
--- db/torque/maven-plugin/trunk/xdocs/navigation.xml (original)
+++ db/torque/maven-plugin/trunk/xdocs/navigation.xml Sat Jan 21 04:11:16 2006
@@ -19,17 +19,48 @@
<title>Maven Torque Plugin</title>
<body>
- <links>
- <item name="overview" href="http://db.apache.org/torque/"/>
- <item name="runtime" href="../runtime"/>
- <item name="generator" href="../generator/"/>
- <item name="templates" href="../templates"/>
- <item name="maven-plugin" href="../maven-plugin/"/>
- </links>
- <menu name="Overview">
- <item name="Goals" href="/goals.html"/>
- <item name="Properties" href="/properties.html"/>
+ <menu name="Torque">
+ <item name="Overview" href="../../../index.html"/>
+ <item name="News and Status" href="../../../status.html"/>
+ <item name="Downloads" href="../../../download.html"/>
+ <item name="Changes" href="../../../changes-report.html"/>
+ <item name="Wiki"
href="http://wiki.apache.org/db-torque/"/>
+ <item name="Issue tracker" href="../../../issue-tracking.html"/>
+ <item name="Mailing lists" href="../../../mail-lists.html"/>
+ <item name="Developer Information"
href="../../../developer-info/index.html" collapse="true">
+ <item name="dummy" href="/dummy.html" />
+ </item>
+ </menu>
+
+ <menu name="Documentation">
+ <item name="Documentation"
href="../../../documentation/index.html">
+ <item name="Torque 3.2 Maven Plugin" href="/index.html">
+
+ <item name="Overview" href="/index.html"/>
+ <item name="Goals" href="/goals.html"/>
+ <item name="Properties" href="/properties.html"/>
+ <item name="Dependencies" href="/dependencies.html"/>
+ <item name="Project Reports" href="/maven-reports.html"
collapse="true">
+ <item name="Change Log" href="/changelog-report.html"/>
+ <item name="File Activity" href="/file-activity-report.html"/>
+ <item name="Developer Activity"
href="/developer-activity-report.html"/>
+ <item name="Project License" href="/license.html"/>
+ <item name="Link Check Report" href="/linkcheck.html"/>
+ </item>
+ </item>
+ </item>
+
+ <item name="Tutorial" href="../../../tutorial/index.html"/>
+ </menu>
+
+ <menu name="Project documentation">
+ <item name="Project info" href="../../../project-info.html"
collapse="true">
+ <item name="dummy" href="/dummy.html"/>
+ </item>
+ <item name="Project Reports" href="../../../project-reports.html"
collapse="true">
+ <item name="dummy" href="/dummy.html"/>
+ </item>
</menu>
</body>
</project>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
