Author: tfischer
Date: Wed Jul 4 20:50:21 2012
New Revision: 1357400
URL: http://svn.apache.org/viewvc?rev=1357400&view=rev
Log:
- create changes report from jira in site
- create special features page for templates
- remove old chnages.xml (was already renamed as old-changes.xml)
- convert subsections to sections in templates introduction
Added:
db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/templates/specialFeatures.xml
Removed:
db/torque/torque4/trunk/torque-site/src/site/xdoc/changes.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/templates/index.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=1357400&r1=1357399&r2=1357400&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-site/pom.xml (original)
+++ db/torque/torque4/trunk/torque-site/pom.xml Wed Jul 4 20:50:21 2012
@@ -49,16 +49,27 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-changes-plugin</artifactId>
- <version>2.3</version>
+ <version>2.7.1</version>
<reportSets>
<reportSet>
<reports>
+ <report>jira-report</report>
+ </reports>
+ </reportSet>
+ <reportSet>
+ <reports>
<report>changes-report</report>
</reports>
+ <configuration>
+ <xmlPath>src/changes/old-changes.xml</xmlPath>
+ </configuration>
</reportSet>
</reportSets>
<configuration>
- <xmlPath>src/changes/old-changes.xml</xmlPath>
+ <onlyCurrentVersion>true</onlyCurrentVersion>
+ <statusIds>Resolved,Closed</statusIds>
+ <sortColumnNames>Created DESC,Fix Version DESC</sortColumnNames>
+ <maxEntries>300</maxEntries>
</configuration>
</plugin>
</plugins>
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=1357400&r1=1357399&r2=1357400&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-site/src/site/site.xml (original)
+++ db/torque/torque4/trunk/torque-site/src/site/site.xml Wed Jul 4 20:50:21
2012
@@ -33,7 +33,7 @@
<item name="News and Status" href="/status.html"/>
<item name="Downloads" href="/download.html"/>
<item name="Addons" href="/addons.html"/>
- <item name="Changes" href="/changes.html"/>
+ <item name="Changes" href="/jira-report.html"/>
<item name="Old Changes" href="/changes-report.html"/>
<item name="Wiki"
href="http://wiki.apache.org/db-torque/"/>
<item name="Issue tracker" href="/issue-tracking.html"/>
@@ -87,6 +87,7 @@
<item name="Source XSD (strict)"
href="/documentation/modules/templates/database-4-0-strict.xsd"/>
<item name="Customizing the output"
href="/documentation/modules/templates/customizing.html"/>
<item name="Database independence"
href="/documentation/modules/templates/database-independence.html"/>
+ <item name="Special Features"
href="/documentation/modules/templates/specialFeatures.html"/>
<item name="Dependencies"
href="/documentation/modules/templates/dependencies.html"/>
<item name="Project Reports"
href="/documentation/modules/templates/reports/index.html" collapse="true">
<item name="Metrics"
href="/documentation/modules/templates/reports/jdepend-report.html"/>
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=1357400&r1=1357399&r2=1357400&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 Jul 4 20:50:21 2012
@@ -39,244 +39,243 @@
is used to process the templates. For using the Torque Ant tasks,
modify the instructions according to the
<a href="../ant-tasks/reference/index.html">Torque Ant tasks
documentation</a>,
-
</p>
- <subsection name="Preparation">
- <p>
- For adding the Torque Maven plugin to your build,
- add the following to your pom.xml:
- </p>
- <source><![CDATA[
- <plugin>
- <groupId>org.apache.torque</groupId>
- <artifactId>torque-maven-plugin</artifactId>
- <version>4.0-alpha1-SNAPSHOT</version>
- <executions>
- ...(see below)
- </executions
- <dependencies>
- <dependency>
- <groupId>org.apache.torque</groupId>
- <artifactId>torque-templates</artifactId>
- <version>4.0-alpha1-SNAPSHOT</version>
- </dependency>
- </dependencies>
- </plugin>
- ]]></source>
- </subsection>
- <subsection name="Generation of om classes">
- <p>
- For generating the OM classes, add the following execution to the
- executions list of the torque-generator plugin:
- </p>
- <source><![CDATA[
- <execution>
- <id>generate-sources</id>
- <phase>generate-sources</phase>
- <goals>
- <goal>generate</goal>
- </goals>
- <configuration>
- <packaging>classpath</packaging>
- <configPackage>org.apache.torque.templates.om</configPackage>
- <sourceDir>${torque.schema.source.dir}</sourceDir>
- <options>
- <torque.om.package>${torque.target.package}</torque.om.package>
- </options>
- </configuration>
- </execution>
- ]]></source>
- <p>
- 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>
- You can add additional options to the configuration inside the options
- tag. The available options are described below.
- </p>
- <p>
- This execution 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>
- <p>
- See the <a href="customizing.html">Customizing</a> page for a
- documentation of available options which can be used to customize
- the generated output.
- </p>
- </subsection>
- <subsection name="Generation of ddl sql">
- <p>
- For generating the data description language(ddl) sql for the tables,
- add the following execution to the executions list
- of the Torque Maven plugin:
- </p>
- <source><![CDATA[
- <execution>
- <id>generate-sql</id>
- <phase>generate-sources</phase>
- <goals>
- <goal>generate</goal>
- </goals>
- <configuration>
- <packaging>classpath</packaging>
- <configPackage>org.apache.torque.templates.sql</configPackage>
- <sourceDir>${torque.schema.source.dir}</sourceDir>
- <newFileTargetDir>target/generated-sql</newFileTargetDir>
- <compileNewFileTargetDir>false</compileNewFileTargetDir>
-
<compileModifiedFileTargetDir>false</compileModifiedFileTargetDir>
- <options>
- <torque.database>${torque.target.database}</torque.database>
- </options>
- </configuration>
- </execution>
- ]]></source>
- <p>
- 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 for all source files in the schema
- directory ending on -schema.xml; the output goes to the directory
- target/generated-sql.
- </p>
- </subsection>
- <subsection name="Generation of html documentation">
- <p>
- For generating html documentation for the tables,
- add the following execution to the executions list
- of the Torque Maven plugin:
- </p>
- <source><![CDATA[
- <execution>
- <id>generate-html-doc</id>
- <phase>generate-sources</phase>
- <goals>
- <goal>generate</goal>
- </goals>
- <configuration>
- <packaging>classpath</packaging>
-
<configPackage>org.apache.torque.templates.doc.html</configPackage>
- <sourceDir>${torque.schema.source.dir}</sourceDir>
- <newFileTargetDir>target/generated-docs</newFileTargetDir>
- <compileNewFileTargetDir>false</compileNewFileTargetDir>
-
<compileModifiedFileTargetDir>false</compileModifiedFileTargetDir>
- <options>
- <torque.om.package>${torque.target.package}</torque.om.package>
- <torque.database>${torque.target.database}</torque.database>
- </options>
- </configuration>
- </execution>
- ]]></source>
- <p>
- 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 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
- of the Torque Maven plugin:
- </p>
- <source><![CDATA[
- <execution>
- <id>generate-xdoc</id>
- <phase>pre-site</phase>
- <goals>
- <goal>generate</goal>
- </goals>
- <configuration>
- <packaging>classpath</packaging>
-
<configPackage>org.apache.torque.templates.doc.xdoc</configPackage>
- <sourceDir>${torque.schema.source.dir}</sourceDir>
- <newFileTargetDir>target/generated-xdocs</newFileTargetDir>
- <compileNewFileTargetDir>false</compileNewFileTargetDir>
- <options>
- <torque.om.package>${torque.target.package}</torque.om.package>
- <torque.database>${torque.target.database}</torque.database>
- </options>
- </configuration>
- </execution>
- ]]></source>
- <p>
- 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
- 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>
- <artifactId>maven-site-plugin</artifactId>
- <groupId>org.apache.maven.plugins</groupId>
- <configuration>
- <xdocDirectory>target/generated-xdocs</xdocDirectory>
- </configuration>
- </plugin>
- ]]></source>
- </subsection>
- <subsection name="Generation of XML schema from an existing database">
- <p>
- For extracting the structure of an existing database into
- a schema file,
- add the following execution to the executions list
- of the Torque Maven plugin:
- </p>
- <source><![CDATA[
- <execution>
- <id>generate-schema-from-jdbc</id>
- <phase>generate-test-sources</phase>
- <goals>
- <goal>generate</goal>
- </goals>
- <configuration>
- <packaging>classpath</packaging>
-
<configPackage>org.apache.torque.templates.jdbc2schema</configPackage>
- <newFileTargetDir>target/generated-schema</newFileTargetDir>
- <newFileTargetDirUsage>none</newFileTargetDirUsage>
- <options>
-
<torque.jdbc2schema.driver>${torque.driver}</torque.jdbc2schema.driver>
-
<torque.jdbc2schema.url>${torque.database.url}</torque.jdbc2schema.url>
-
<torque.jdbc2schema.user>${torque.database.user}</torque.jdbc2schema.user>
-
<torque.jdbc2schema.password>${torque.database.password}</torque.jdbc2schema.password>
-
<torque.jdbc2schema.schema>${torque.database.schema}</torque.jdbc2schema.schema>
- </options>
- </configuration>
- </execution>
- ]]></source>
- <p>
- Replace ${torque.driver} with the fully qualified class name of the
- database driver. Replace ${torque.database.url}
- with the url to connect to the database.
- Replace ${torque.database.user} and ${torque.database.password}
- with the database username and the corresponding password.
- You may want to replace ${torque.database.schema} with the database
- schema to read, if not please remove the line containing it.
- </p>
- </subsection>
</section>
+ <section name="Preparation">
+ <p>
+ For adding the Torque Maven plugin to your build,
+ add the following to your pom.xml:
+ </p>
+ <source><![CDATA[
+ <plugin>
+ <groupId>org.apache.torque</groupId>
+ <artifactId>torque-maven-plugin</artifactId>
+ <version>4.0-alpha1-SNAPSHOT</version>
+ <executions>
+ ...(see below)
+ </executions
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.torque</groupId>
+ <artifactId>torque-templates</artifactId>
+ <version>4.0-alpha1-SNAPSHOT</version>
+ </dependency>
+ </dependencies>
+ </plugin>
+ ]]></source>
+ </section>
+ <section name="Generation of om classes">
+ <p>
+ For generating the OM classes, add the following execution to the
+ executions list of the torque-generator plugin:
+ </p>
+ <source><![CDATA[
+ <execution>
+ <id>generate-sources</id>
+ <phase>generate-sources</phase>
+ <goals>
+ <goal>generate</goal>
+ </goals>
+ <configuration>
+ <packaging>classpath</packaging>
+ <configPackage>org.apache.torque.templates.om</configPackage>
+ <sourceDir>${torque.schema.source.dir}</sourceDir>
+ <options>
+ <torque.om.package>${torque.target.package}</torque.om.package>
+ </options>
+ </configuration>
+ </execution>
+ ]]></source>
+ <p>
+ 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>
+ You can add additional options to the configuration inside the options
+ tag. The available options are described below.
+ </p>
+ <p>
+ This execution 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>
+ <p>
+ See the <a href="customizing.html">Customizing</a> page for a
+ documentation of available options which can be used to customize
+ the generated output.
+ </p>
+ </section>
+ <section name="Generation of ddl sql">
+ <p>
+ For generating the data description language(ddl) sql for the tables,
+ add the following execution to the executions list
+ of the Torque Maven plugin:
+ </p>
+ <source><![CDATA[
+ <execution>
+ <id>generate-sql</id>
+ <phase>generate-sources</phase>
+ <goals>
+ <goal>generate</goal>
+ </goals>
+ <configuration>
+ <packaging>classpath</packaging>
+ <configPackage>org.apache.torque.templates.sql</configPackage>
+ <sourceDir>${torque.schema.source.dir}</sourceDir>
+ <newFileTargetDir>target/generated-sql</newFileTargetDir>
+ <compileNewFileTargetDir>false</compileNewFileTargetDir>
+ <compileModifiedFileTargetDir>false</compileModifiedFileTargetDir>
+ <options>
+ <torque.database>${torque.target.database}</torque.database>
+ </options>
+ </configuration>
+ </execution>
+ ]]></source>
+ <p>
+ 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 for all source files in the schema
+ directory ending on -schema.xml; the output goes to the directory
+ target/generated-sql.
+ </p>
+ </section>
+ <section name="Generation of html documentation">
+ <p>
+ For generating html documentation for the tables,
+ add the following execution to the executions list
+ of the Torque Maven plugin:
+ </p>
+ <source><![CDATA[
+ <execution>
+ <id>generate-html-doc</id>
+ <phase>generate-sources</phase>
+ <goals>
+ <goal>generate</goal>
+ </goals>
+ <configuration>
+ <packaging>classpath</packaging>
+ <configPackage>org.apache.torque.templates.doc.html</configPackage>
+ <sourceDir>${torque.schema.source.dir}</sourceDir>
+ <newFileTargetDir>target/generated-docs</newFileTargetDir>
+ <compileNewFileTargetDir>false</compileNewFileTargetDir>
+ <compileModifiedFileTargetDir>false</compileModifiedFileTargetDir>
+ <options>
+ <torque.om.package>${torque.target.package}</torque.om.package>
+ <torque.database>${torque.target.database}</torque.database>
+ </options>
+ </configuration>
+ </execution>
+ ]]></source>
+ <p>
+ 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 for all source files
+ in the schema directory ending on -schema.xml.
+ The output will be produced in the directory target/generated-docs.
+ </p>
+ </section>
+ <section 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
+ of the Torque Maven plugin:
+ </p>
+ <source><![CDATA[
+ <execution>
+ <id>generate-xdoc</id>
+ <phase>pre-site</phase>
+ <goals>
+ <goal>generate</goal>
+ </goals>
+ <configuration>
+ <packaging>classpath</packaging>
+ <configPackage>org.apache.torque.templates.doc.xdoc</configPackage>
+ <sourceDir>${torque.schema.source.dir}</sourceDir>
+ <newFileTargetDir>target/generated-xdocs</newFileTargetDir>
+ <compileNewFileTargetDir>false</compileNewFileTargetDir>
+ <options>
+ <torque.om.package>${torque.target.package}</torque.om.package>
+ <torque.database>${torque.target.database}</torque.database>
+ </options>
+ </configuration>
+ </execution>
+ ]]></source>
+ <p>
+ 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
+ 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>
+ <artifactId>maven-site-plugin</artifactId>
+ <groupId>org.apache.maven.plugins</groupId>
+ <configuration>
+ <xdocDirectory>target/generated-xdocs</xdocDirectory>
+ </configuration>
+ </plugin>
+ ]]></source>
+ </section>
+ <section name="Generation of XML schema from an existing database">
+ <p>
+ For extracting the structure of an existing database into
+ a schema file,
+ add the following execution to the executions list
+ of the Torque Maven plugin:
+ </p>
+ <source><![CDATA[
+ <execution>
+ <id>generate-schema-from-jdbc</id>
+ <phase>generate-test-sources</phase>
+ <goals>
+ <goal>generate</goal>
+ </goals>
+ <configuration>
+ <packaging>classpath</packaging>
+
<configPackage>org.apache.torque.templates.jdbc2schema</configPackage>
+ <newFileTargetDir>target/generated-schema</newFileTargetDir>
+ <newFileTargetDirUsage>none</newFileTargetDirUsage>
+ <options>
+
<torque.jdbc2schema.driver>${torque.driver}</torque.jdbc2schema.driver>
+
<torque.jdbc2schema.url>${torque.database.url}</torque.jdbc2schema.url>
+
<torque.jdbc2schema.user>${torque.database.user}</torque.jdbc2schema.user>
+
<torque.jdbc2schema.password>${torque.database.password}</torque.jdbc2schema.password>
+
<torque.jdbc2schema.schema>${torque.database.schema}</torque.jdbc2schema.schema>
+ </options>
+ </configuration>
+ </execution>
+ ]]></source>
+ <p>
+ Replace ${torque.driver} with the fully qualified class name of the
+ database driver. Replace ${torque.database.url}
+ with the url to connect to the database.
+ Replace ${torque.database.user} and ${torque.database.password}
+ with the database username and the corresponding password.
+ You may want to replace ${torque.database.schema} with the database
+ schema to read, if not please remove the line containing it.
+ </p>
+ </section>
</body>
</document>
\ No newline at end of file
Added:
db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/templates/specialFeatures.xml
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/templates/specialFeatures.xml?rev=1357400&view=auto
==============================================================================
---
db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/templates/specialFeatures.xml
(added)
+++
db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/modules/templates/specialFeatures.xml
Wed Jul 4 20:50:21 2012
@@ -0,0 +1,62 @@
+<?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 templates - Special Features</title>
+ </properties>
+
+ <body>
+ <section name="Date Default values">
+ <p>
+ One can use CURRENT_DATE, CURRENT_TIME and CURRENT_TIMESTAMP
+ as default for Date fields.
+ Setting the attribute useDatabaseDefaultValue to false
+ or not setting it makes Torque use the current java time
+ as initial field value when constructing the object
+ and saving it to the database, not considering the database default.
+ Setting the attribute useDatabaseDefaultValue to true
+ makes Torque setting the initial field value to null
+ and using the database default when the object is first
+ saved to the database.
+ </p>
+ </section>
+ <section name="MySQL table generation options">
+ <p>
+ The following table create options can be set for MySQL using the
+ option element inside the table element:
+ ENGINE, AVG_ROW_LENGTH, CHARACTER SET, DEFAULT CHARACTER SET, CHECKSUM,
+ COLLATE, DEFAULT COLLATE, CONNECTION, DATA DIRECTORY, DELAY_KEY_WRITE,
+ INDEX DIRECTORY, INSERT_METHOD, KEY_BLOCK_SIZE, MAX_ROWS, MIN_ROWS,
+ PACK_KEYS, PASSWORD, ROW_FORMAT, TABLESPACE, UNION, PARTITION BY
+ </p>
+ <p>
+ Example:
+ </p>
+ <source><![CDATA[
+<table name="book">
+ <option key="ENGINE" value="InnoDB"/>
+ ...
+</table>
+ ]]></source>
+ </section>
+ </body>
+</document>
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
