You are viewing a plain text version of this content. The canonical link for it is here.
Posted to torque-dev@db.apache.org by tf...@apache.org on 2010/08/25 10:07:35 UTC

svn commit: r988857 - in /db/torque/torque4/trunk/torque-site: ./ src/site/ src/site/xdoc/documentation/modules/ant-tasks/ src/site/xdoc/documentation/modules/ant-tasks/reference/ src/site/xdoc/documentation/modules/ant-tasks/reports/ src/site/xdoc/doc...

Author: tfischer
Date: Wed Aug 25 08:07:34 2010
New Revision: 988857

URL: http://svn.apache.org/viewvc?rev=988857&view=rev
Log:
- added ant tasks to modules directory of site
- added orm tutorial pages to site menu

Added:
    db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/
    db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/dependencies.xml
    db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/index.xml
    db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reference/
    db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reference/generator-task.xml
    db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reference/index.xml
    db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/
    db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/checkstyle.xml
    db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/cpd.xml
    db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/findbugs.xml
    db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/index.xml
    db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/jdepend-report.xml
    db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/pmd.xml
    db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/surefire-report.xml
    db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/taglist.xml
    db/torque/torque4/trunk/torque-site/src/site/xdoc/tutorial/orm/index.xml
Modified:
    db/torque/torque4/trunk/torque-site/pom.xml
    db/torque/torque4/trunk/torque-site/src/site/site.xml
    db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/generator/reference/concepts.xml

Modified: db/torque/torque4/trunk/torque-site/pom.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/pom.xml?rev=988857&r1=988856&r2=988857&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-site/pom.xml (original)
+++ db/torque/torque4/trunk/torque-site/pom.xml Wed Aug 25 08:07:34 2010
@@ -77,6 +77,7 @@
                 <mkdir dir="${basedir}/target/generator-site" />
                 <mkdir dir="${basedir}/target/templates-site" />
                 <mkdir dir="${basedir}/target/maven2-plugin-site" />
+                <mkdir dir="${basedir}/target/ant-tasks-site" />
                 <copy todir="${basedir}/target/runtime-site">
                   <fileset dir="${basedir}/../torque-runtime/target/site">
                     <include name="*.html"/>
@@ -101,6 +102,12 @@
                   </fileset>
                   <mapper type="glob" from="*.html" to="*.xml"/>
                 </copy>
+                <copy todir="${basedir}/target/ant-tasks-site">
+                  <fileset dir="${basedir}/../torque-ant-tasks/target/site">
+                    <include name="*.html"/>
+                  </fileset>
+                  <mapper type="glob" from="*.html" to="*.xml"/>
+                </copy>
                 <!-- replace doctype headers because these cannot be resolved -->
                 <replace dir="${basedir}/target/runtime-site">
                   <replacetoken><![CDATA[<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">]]></replacetoken>
@@ -114,6 +121,9 @@
                 <replace dir="${basedir}/target/maven2-plugin-site">
                   <replacetoken><![CDATA[<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">]]></replacetoken>
                 </replace>
+                <replace dir="${basedir}/target/ant-tasks-site">
+                  <replacetoken><![CDATA[<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">]]></replacetoken>
+                </replace>
                 <!-- fix broken xhtml in cpd report -->
                 <replace file="${basedir}/target/runtime-site/cpd.xml">
                   <replacetoken><![CDATA[<table class="bodyTable"></p>]]></replacetoken>
@@ -131,6 +141,10 @@
                   <replacetoken><![CDATA[<table class="bodyTable"></p>]]></replacetoken>
                   <replacevalue><![CDATA[</table></p>]]></replacevalue>
                 </replace>
+                <replace file="${basedir}/target/ant-tasks-site/cpd.xml">
+                  <replacetoken><![CDATA[<table class="bodyTable"></p>]]></replacetoken>
+                  <replacevalue><![CDATA[</table></p>]]></replacevalue>
+                </replace>
                 <!-- replace && in javascript in surefire -->
                 <replace file="${basedir}/target/runtime-site/surefire-report.xml">
                   <replacetoken><![CDATA[elm &&]]></replacetoken>
@@ -148,6 +162,10 @@
                   <replacetoken><![CDATA[elm &&]]></replacetoken>
                   <replacevalue><![CDATA[!elm) return; if(]]></replacevalue>
                 </replace>
+                <replace file="${basedir}/target/ant-tasks-site/surefire-report.xml">
+                  <replacetoken><![CDATA[elm &&]]></replacetoken>
+                  <replacevalue><![CDATA[!elm) return; if(]]></replacevalue>
+                </replace>
               </tasks>
             </configuration>
             <goals>
@@ -365,6 +383,56 @@
                   <replacetoken>@MERGEPOINT_BODY_CONTENT@</replacetoken>
                 </replace>
 
+                <!-- ant tasks reports -->
+                <loadfile property="ant-tasks.dependencies"
+                    srcFile="${basedir}/target/ant-tasks-site-content/dependencies.xml"/>
+                <replace value="${ant-tasks.dependencies}"
+                    file="${basedir}/target/site/documentation/modules/ant-tasks/dependencies.html">
+                  <replacetoken>@MERGEPOINT_BODY_CONTENT@</replacetoken>
+                </replace>
+                <loadfile property="ant-tasks.jdepend"
+                    srcFile="${basedir}/target/ant-tasks-site-content/jdepend-report.xml"/>
+                <replace value="${ant-tasks.jdepend}"
+                    file="${basedir}/target/site/documentation/modules/ant-tasks/reports/jdepend-report.html">
+                  <replacetoken>@MERGEPOINT_BODY_CONTENT@</replacetoken>
+                </replace>
+                <loadfile property="ant-tasks.checkstyle"
+                    srcFile="${basedir}/target/ant-tasks-site-content/checkstyle.xml"/>
+                <replace value="${ant-tasks.checkstyle}"
+                    file="${basedir}/target/site/documentation/modules/ant-tasks/reports/checkstyle.html">
+                  <replacetoken>@MERGEPOINT_BODY_CONTENT@</replacetoken>
+                </replace>
+                <loadfile property="ant-tasks.surefire"
+                    srcFile="${basedir}/target/ant-tasks-site-content/surefire-report.xml"/>
+                <replace value="${ant-tasks.surefire}"
+                    file="${basedir}/target/site/documentation/modules/ant-tasks/reports/surefire-report.html">
+                  <replacetoken>@MERGEPOINT_BODY_CONTENT@</replacetoken>
+                </replace>
+                <loadfile property="ant-tasks.taglist"
+                    srcFile="${basedir}/target/ant-tasks-site-content/taglist.xml"/>
+                <replace value="${ant-tasks.taglist}"
+                    file="${basedir}/target/site/documentation/modules/ant-tasks/reports/taglist.html">
+                  <replacetoken>@MERGEPOINT_BODY_CONTENT@</replacetoken>
+                </replace>
+                <loadfile property="ant-tasks.findbugs"
+                    srcFile="${basedir}/target/ant-tasks-site-content/findbugs.xml"/>
+                <replace value="${ant-tasks.findbugs}"
+                    file="${basedir}/target/site/documentation/modules/ant-tasks/reports/findbugs.html">
+                  <replacetoken>@MERGEPOINT_BODY_CONTENT@</replacetoken>
+                </replace>
+                <loadfile property="ant-tasks.cpd"
+                    srcFile="${basedir}/target/ant-tasks-site-content/cpd.xml"/>
+                <replace value="${ant-tasks.cpd}"
+                    file="${basedir}/target/site/documentation/modules/ant-tasks/reports/cpd.html">
+                  <replacetoken>@MERGEPOINT_BODY_CONTENT@</replacetoken>
+                </replace>
+                <loadfile property="ant-tasks.pmd"
+                    srcFile="${basedir}/target/ant-tasks-site-content/pmd.xml"/>
+                <replace value="${ant-tasks.pmd}"
+                    file="${basedir}/target/site/documentation/modules/ant-tasks/reports/pmd.html">
+                  <replacetoken>@MERGEPOINT_BODY_CONTENT@</replacetoken>
+                </replace>
+
                 <!-- runtime extra report pages -->
                 <copy todir="${basedir}/target/site/documentation/modules/runtime/cobertura">
                   <fileset dir="${basedir}/../torque-runtime/target/site/cobertura" />
@@ -432,6 +500,23 @@
                 <copy todir="${basedir}/target/site/documentation/modules/maven2-plugin/xref-test">
                   <fileset dir="${basedir}/../maven-torque-generator-plugin/target/site/xref-test" />
                 </copy>
+
+                <!-- ant tasks extra report pages -->
+                <copy todir="${basedir}/target/site/documentation/modules/ant-tasks/cobertura">
+                  <fileset dir="${basedir}/../torque-ant-tasks/target/site/cobertura" />
+                </copy>
+                <copy todir="${basedir}/target/site/documentation/modules/ant-tasks/apidocs">
+                  <fileset dir="${basedir}/../torque-ant-tasks/target/site/apidocs" />
+                </copy>
+                <copy todir="${basedir}/target/site/documentation/modules/ant-tasks/testapidocs">
+                  <fileset dir="${basedir}/../torque-ant-tasks/target/site/testapidocs" />
+                </copy>
+                <copy todir="${basedir}/target/site/documentation/modules/ant-tasks/xref">
+                  <fileset dir="${basedir}/../torque-ant-tasks/target/site/xref" />
+                </copy>
+                <copy todir="${basedir}/target/site/documentation/modules/ant-tasks/xref-test">
+                  <fileset dir="${basedir}/../torque-ant-tasks/target/site/xref-test" />
+                </copy>
               </tasks>
             </configuration>
             <goals>
@@ -473,6 +558,11 @@
               <stylesheet>src/site/xslt/body-content.xsl</stylesheet>
               <outputDir>target/maven2-plugin-site-content</outputDir>
             </transformationSet>
+            <transformationSet>
+              <dir>target/ant-tasks-site</dir>
+              <stylesheet>src/site/xslt/body-content.xsl</stylesheet>
+              <outputDir>target/ant-tasks-site-content</outputDir>
+            </transformationSet>
           </transformationSets>
         </configuration>
       </plugin>

Modified: db/torque/torque4/trunk/torque-site/src/site/site.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/site.xml?rev=988857&r1=988856&r2=988857&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-site/src/site/site.xml (original)
+++ db/torque/torque4/trunk/torque-site/src/site/site.xml Wed Aug 25 08:07:34 2010
@@ -41,7 +41,7 @@
             <item name="Concepts"        href="/documentation/modules/generator/reference/concepts.html"/>
             <item name="Configuration"   href="/documentation/modules/generator/reference/configuration.html"/>
             <item name="Internals"       href="/documentation/modules/generator/reference/internals.html" collapse="true">
-              <item name="Generator Types" href="/documentation/modules/generator/reference/internals/generatorTypes.html"/>
+              <item name="Outlet Types" href="/documentation/modules/generator/reference/internals/outletTypes.html"/>
             </item>
           </item>
           <item name="Dependencies"      href="/documentation/modules/generator/dependencies.html"/>
@@ -97,6 +97,26 @@
             <item name="Test Coverage"   href="/documentation/modules/maven2-plugin/cobertura/index.html" target="_blank"/>
           </item>
         </item>
+        <item name="Ant Tasks"           href="/documentation/modules/ant-tasks/index.html" collapse="true">
+          <item name="Reference"         href="/documentation/modules/ant-tasks/reference/index.html" collapse="true">
+            <item name="Generator Task"  href="/documentation/modules/ant-tasks/reference/generator-task.html"/>
+          </item>
+          <item name="Dependencies"      href="/documentation/modules/ant-tasks/dependencies.html"/>
+          <item name="Project Reports"   href="/documentation/modules/ant-tasks/reports/index.html" collapse="true">
+            <item name="Metrics"         href="/documentation/modules/ant-tasks/reports/jdepend-report.html"/>
+            <item name="JavaDocs"        href="/documentation/modules/ant-tasks/apidocs/index.html" target="_blank" />
+            <item name="Test JavaDocs"   href="/documentation/modules/ant-tasks/testapidocs/index.html" target="_blank" />
+            <item name="Source Xref"     href="/documentation/modules/ant-tasks/xref/index.html" target="_blank" />
+            <item name="Test Xref"       href="/documentation/modules/ant-tasks/xref-test/index.html" target="_blank" />
+            <item name="Tag List"        href="/documentation/modules/ant-tasks/reports/taglist.html"/>
+            <item name="Checkstyle"      href="/documentation/modules/ant-tasks/reports/checkstyle.html"/>
+            <item name="Copy-Paste"      href="/documentation/modules/ant-tasks/reports/cpd.html"/>
+            <item name="PMD"             href="/documentation/modules/ant-tasks/reports/pmd.html"/>
+            <item name="FindBugs"        href="/documentation/modules/ant-tasks/reports/findbugs.html"/>
+            <item name="Unit Tests"      href="/documentation/modules/ant-tasks/reports/surefire-report.html"/>
+            <item name="Test Coverage"   href="/documentation/modules/ant-tasks/cobertura/index.html" target="_blank"/>
+          </item>
+        </item>
         <item name="Runtime"             href="/documentation/modules/runtime/index.html" collapse="true">
           <item name="Reference"         href="/documentation/modules/runtime/reference/index.html" collapse="true">
             <item name="Initialisation"  href="/documentation/modules/runtime/reference/initialisation-configuration.html"/>
@@ -127,6 +147,17 @@
         </item>
       </item>
       <item name="Tutorial"              href="/tutorial/index.html" collapse="true">
+        <item name="ORM"                 href="/tutorial/orm/index.html" collapse="true">
+          <item name="step1-ant"         href="/tutorial/orm/step1-ant.html"/>
+          <item name="step1-maven"       href="/tutorial/orm/step1-maven.html"/>
+          <item name="step2"             href="/tutorial/orm/step2.html"/>
+          <item name="step3-ant"         href="/tutorial/orm/step3-ant.html"/>
+          <item name="step3-maven"       href="/tutorial/orm/step3-maven.html"/>
+          <item name="step4"             href="/tutorial/orm/step4.html"/>
+          <item name="step5"             href="/tutorial/orm/step5.html"/>
+          <item name="step6-ant"         href="/tutorial/orm/step6-ant.html"/>
+          <item name="step6-maven"       href="/tutorial/orm/step6-maven.html"/>
+        </item>
       </item>
     </menu>
 

Added: db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/dependencies.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/dependencies.xml?rev=988857&view=auto
==============================================================================
--- db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/dependencies.xml (added)
+++ db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/dependencies.xml Wed Aug 25 08:07:34 2010
@@ -0,0 +1,29 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied.  See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<document>
+ <properties>
+  <title>Torque Ant Tasks - Dependencies</title>
+ </properties>
+
+ <body>
+  @MERGEPOINT_BODY_CONTENT@
+ </body>
+</document>

Added: db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/index.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/index.xml?rev=988857&view=auto
==============================================================================
--- db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/index.xml (added)
+++ db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/index.xml Wed Aug 25 08:07:34 2010
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied.  See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<document>
+
+ <properties>
+  <title>Torque Ant Tasks</title>
+ </properties>
+
+ <body>
+  <section name="Introduction">
+    <p>
+      The Torque ant tasks project can currently be used to
+      run the Torque generator from within ant. For more information, see the 
+      <a href="reference/index.html">tasks reference</a>.
+    </p>
+  </section>
+ </body>
+</document>
\ No newline at end of file

Added: db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reference/generator-task.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reference/generator-task.xml?rev=988857&view=auto
==============================================================================
--- db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reference/generator-task.xml (added)
+++ db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reference/generator-task.xml Wed Aug 25 08:07:34 2010
@@ -0,0 +1,132 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied.  See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<document>
+ <properties>
+  <title>Torque Ant Tasks - Generator Task</title>
+ </properties>
+
+ <body>
+  <section name="Generator Task">
+    <p>
+      The generator task is defined as follows in the build file:
+    </p>
+    <source><![CDATA[
+  <taskdef
+    name="torque-generator"
+    classpathref="ant-classpath"
+    classname="org.apache.torque.ant.task.TorqueGeneratorTask"/>
+    ]]></source>
+    <p>
+      The generator task has the following configuration parameters:
+    </p>
+    <subsection name="Attributes">
+      <p>
+        Packaging attributes: They define where the generation unit
+        (also known as "templates") is located.
+      </p>
+      <ul>
+        <li>
+          packaging: The packaging type of the generation unit,
+          either "directory" , "jar" or "classpath". Default is "directory".
+        </li>
+        <li>
+          configDir: The configuration directory of the torque generator.
+          Has no effect if packaging is "classpath".
+        </li>
+        <li>
+          configPackage: The configuration package of the generation unit.
+          Has only effect if packaging is "classpath".
+        </li>
+        <li>
+          jarFile: The filename of the jar file of the generation unit.
+          Has only effect if packaging is "jar".
+        </li>
+        <li>
+          overrideConfigDir: The config directory of the project
+          overriding the defined generation unit.
+          If set, the settings of this directory are used as child
+          and the "normal" settings are used as parent.
+          See the
+          <a href="../../generator/reference/concepts.html#Overriding">generator reference</a>
+          for details.
+        </li>
+        <li>
+          projectRootDir: The root directory of the project.
+          Has no effect if packaging is "classpath".
+          Default is ".".
+        </li>
+      </ul>
+      <p>
+        Source attributes: They define which sources are read.
+      </p>
+      <ul>
+        <li>
+          sourceDir: The directory where the source files reside.
+        </li>
+        <li>
+          sourceIncludes: Include patterns for the source files.
+          If set, the include and exclude patterns from the templates
+          are overridden.
+          If not set, then the include patterns from the templates are used.
+          The patterns are case sensitive, wildcards are * and ?.
+        </li>
+        <li>
+          sourceExcludes: Exclude patterns for the source files.
+          If set, the include and exclude patterns from the templates
+          are overridden.
+          If not set, then the include patterns from the templates are used.
+          The patterns are case sensitive, wildcards are * and ?.
+        </li>
+      </ul>
+      <p>
+        Target attributes: They define wher the target files are created.
+      </p>
+      <ul>
+        <li>
+          newFileTargetDir: The target directory for files
+          which are generated each time anew.
+          Default is "./generated-sources".
+        </li>
+        <li>
+          modifiedFileTargetDir: The target directory for files
+          which are not generated each time anew.
+          Default is "./src/main/generated-java".
+        </li>
+      </ul>
+      <p>
+        Other attributes:
+      </p>
+      <ul>
+        <li>
+          loglevel: The Loglevel to use in the generation process.
+          Must be one of trace, debug, info, warn or error.
+          If not set, the log level defined in the generation unit is used.
+        </li>
+        <li>
+          modifiedFileTargetDir: The target directory for files
+          which are not generated each time anew.
+          Default is "./src/main/generated-java".
+        </li>
+      </ul>
+    </subsection>
+   </section>
+ </body>
+</document>

Added: db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reference/index.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reference/index.xml?rev=988857&view=auto
==============================================================================
--- db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reference/index.xml (added)
+++ db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reference/index.xml Wed Aug 25 08:07:34 2010
@@ -0,0 +1,76 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied.  See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<document>
+
+ <properties>
+  <title>Torque Ant Tasks</title>
+ </properties>
+
+ <body>
+  <section name="Introduction">
+    <p>
+      The Torque ant tasks provide the ant integration of the
+      Torque generator.
+    </p>
+    <p>
+      The only task this plugin offers currently is the generator task, which
+      starts the Torque generator. It has to be defined as follows in the
+      buildfile before it can be used:
+    </p>
+    <source><![CDATA[
+  <taskdef
+    name="torque-generator"
+    classpathref="ant-classpath"
+    classname="org.apache.torque.ant.task.TorqueGeneratorTask"/>
+    ]]></source>
+    <p>
+      where ant-classpath points to a path which contains all jars from the
+      binary Torque ant tasks distribution.
+    </p>
+    <p>
+      A basic configuration for using pre-defined templates would be
+    </p>
+    <source><![CDATA[
+    <torque-generator 
+        packaging="classpath"
+        configPackage="${templates-config-package}"
+        sourceDir="${source-dir}">
+      <option key="${option-key}" value="${option-value}"/>
+      ...
+    </torque-generator>
+     ]]></source>   
+    <p>
+      The documentation of the template should give you to the values for
+      ${templates-config-package} and the necessary/possible options to set.
+      Set ${source-dir} to the directory where the source files for the
+      generation are located.
+      The templates jar must also be available in the ant-classpath path. 
+    </p>
+    <p>
+      See <a href="generator-task.html">the generator task documentation</a>
+      for the available configuration parameters.
+    </p> 
+    <p>
+      See <a href="../../../../tutorial/orm/step1-ant.html">the ORM tutorial</a>
+      for a complete build file example.
+    </p> 
+  </section>
+ </body>
+</document>
\ No newline at end of file

Added: db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/checkstyle.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/checkstyle.xml?rev=988857&view=auto
==============================================================================
--- db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/checkstyle.xml (added)
+++ db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/checkstyle.xml Wed Aug 25 08:07:34 2010
@@ -0,0 +1,29 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied.  See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<document>
+ <properties>
+  <title>Torque Ant Tasks - Checkstyle</title>
+ </properties>
+
+ <body>
+  @MERGEPOINT_BODY_CONTENT@
+ </body>
+</document>

Added: db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/cpd.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/cpd.xml?rev=988857&view=auto
==============================================================================
--- db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/cpd.xml (added)
+++ db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/cpd.xml Wed Aug 25 08:07:34 2010
@@ -0,0 +1,29 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied.  See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<document>
+ <properties>
+  <title>Torque Ant Tasks - CPD</title>
+ </properties>
+
+ <body>
+  @MERGEPOINT_BODY_CONTENT@
+ </body>
+</document>

Added: db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/findbugs.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/findbugs.xml?rev=988857&view=auto
==============================================================================
--- db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/findbugs.xml (added)
+++ db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/findbugs.xml Wed Aug 25 08:07:34 2010
@@ -0,0 +1,29 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied.  See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<document>
+ <properties>
+  <title>Torque Ant Tasks - Findbugs</title>
+ </properties>
+
+ <body>
+  @MERGEPOINT_BODY_CONTENT@
+ </body>
+</document>

Added: db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/index.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/index.xml?rev=988857&view=auto
==============================================================================
--- db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/index.xml (added)
+++ db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/index.xml Wed Aug 25 08:07:34 2010
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied.  See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<document>
+
+  <properties>
+    <title>Torque Ant Tasks - Reports</title>
+  </properties>
+
+  <body>
+
+    <section name="Torque Generator">
+      <p>
+        This folder contains various reports for the Torque generator module.
+      </p>      
+    </section>
+
+  </body>
+</document>

Added: db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/jdepend-report.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/jdepend-report.xml?rev=988857&view=auto
==============================================================================
--- db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/jdepend-report.xml (added)
+++ db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/jdepend-report.xml Wed Aug 25 08:07:34 2010
@@ -0,0 +1,29 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied.  See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<document>
+ <properties>
+  <title>Torque Ant Tasks - Metrics</title>
+ </properties>
+
+ <body>
+  @MERGEPOINT_BODY_CONTENT@
+ </body>
+</document>

Added: db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/pmd.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/pmd.xml?rev=988857&view=auto
==============================================================================
--- db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/pmd.xml (added)
+++ db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/pmd.xml Wed Aug 25 08:07:34 2010
@@ -0,0 +1,29 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied.  See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<document>
+ <properties>
+  <title>Torque Ant Tasks - PMD</title>
+ </properties>
+
+ <body>
+  @MERGEPOINT_BODY_CONTENT@
+ </body>
+</document>

Added: db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/surefire-report.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/surefire-report.xml?rev=988857&view=auto
==============================================================================
--- db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/surefire-report.xml (added)
+++ db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/surefire-report.xml Wed Aug 25 08:07:34 2010
@@ -0,0 +1,29 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied.  See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<document>
+ <properties>
+  <title>Torque Ant Tasks - Unit Tests</title>
+ </properties>
+
+ <body>
+  @MERGEPOINT_BODY_CONTENT@
+ </body>
+</document>

Added: db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/taglist.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/taglist.xml?rev=988857&view=auto
==============================================================================
--- db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/taglist.xml (added)
+++ db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/ant-tasks/reports/taglist.xml Wed Aug 25 08:07:34 2010
@@ -0,0 +1,29 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied.  See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<document>
+ <properties>
+  <title>Torque Ant Tasks - Tag List</title>
+ </properties>
+
+ <body>
+  @MERGEPOINT_BODY_CONTENT@
+ </body>
+</document>

Modified: db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/generator/reference/concepts.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/generator/reference/concepts.xml?rev=988857&r1=988856&r2=988857&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/generator/reference/concepts.xml (original)
+++ db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/generator/reference/concepts.xml Wed Aug 25 08:07:34 2010
@@ -57,6 +57,9 @@
       <li>
         <a href="#Namespaces">Namespaces</a>
       </li>
+      <li>
+        <a href="#Overriding">Overriding</a>
+      </li>
     </ul>
   </section>
   
@@ -260,5 +263,10 @@
     </p>
   </section>
 
+  <section name="Overriding">
+    <p>
+      TODO The Torque generator offers overriding via a parent-child mechanism. 
+    </p>
+  </section>
  </body>
 </document>
\ No newline at end of file

Added: db/torque/torque4/trunk/torque-site/src/site/xdoc/tutorial/orm/index.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/xdoc/tutorial/orm/index.xml?rev=988857&view=auto
==============================================================================
--- db/torque/torque4/trunk/torque-site/src/site/xdoc/tutorial/orm/index.xml (added)
+++ db/torque/torque4/trunk/torque-site/src/site/xdoc/tutorial/orm/index.xml Wed Aug 25 08:07:34 2010
@@ -0,0 +1,62 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied.  See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<document>
+  <properties>
+    <title>Torque ORM Tutorial</title>
+    <author email="fischer@seitenbau.de">Thomas Fischer</author>
+  </properties>
+  <body>
+
+<section name="Torque ORM Tutorial">
+
+<p>
+  The Torque ORM Tutorial consists of the following steps:
+</p>
+<ul>
+  <li>
+    Step 1: Configuring the Torque generation process
+    (for <a href="step1-ant.html">ant</a> or
+    <a href="step1-maven.html">maven</a>)
+  </li>
+  <li>
+    Step 2: <a href="step2.html">Defining the database schema</a>
+  </li>
+  <li>
+    Step 3: Invoking the Torque generator
+    (for <a href="step3-ant.html">ant</a> or
+    <a href="step3-maven.html">maven</a>)
+  </li>
+  <li>
+    Step 4: <a href="step4.html">Configuring the Torque Runtime</a>
+  </li>
+  <li>
+    Step 5: <a href="step5.html">Writing a Sample Application</a>
+  </li>
+  <li>
+    Step 6: Compiling and Running the Sample Application
+    (for <a href="step6-ant.html">ant</a> or
+    <a href="step6-maven.html">maven</a>)
+  </li>
+</ul>
+
+</section>
+  </body>
+</document>



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