Author: tfischer
Date: Sat Jan 21 03:45:15 2006
New Revision: 371015
URL: http://svn.apache.org/viewcvs?rev=371015&view=rev
Log:
- added project info and project reporst sections (pointing to maven-generated
reports)
- reorganized the navigation
- rewritten the texts on the Torque front page
- updated the links to the changelog on the status page
- added codestyle page pointing to Turbine codestyle (was voted on some time
ago)
- added contributions page on how to submit contributions
- moved most svn stuff from the developers guide to the svn page
- removed the part about the runtime classes from the developer guide (will be
added to runtime classes reference in runtime docs)
Added:
db/torque/site/xdocs/developer-info/codestyle.xml
db/torque/site/xdocs/developer-info/contributions.xml
db/torque/site/xdocs/developer-info/index.xml
db/torque/site/xdocs/documentation/
db/torque/site/xdocs/documentation/index.xml
db/torque/site/xdocs/project-info.xml
db/torque/site/xdocs/project-reports.xml
db/torque/site/xdocs/tutorial/
db/torque/site/xdocs/tutorial/index.xml
Modified:
db/torque/site/project.properties
db/torque/site/xdocs/developer-info/developer-guide.xml
db/torque/site/xdocs/developer-info/historic-changes.xml
db/torque/site/xdocs/developer-info/references.xml
db/torque/site/xdocs/developer-info/subversion.xml
db/torque/site/xdocs/index.xml
db/torque/site/xdocs/navigation.xml
db/torque/site/xdocs/status.xml
Modified: db/torque/site/project.properties
URL:
http://svn.apache.org/viewcvs/db/torque/site/project.properties?rev=371015&r1=371014&r2=371015&view=diff
==============================================================================
--- db/torque/site/project.properties (original)
+++ db/torque/site/project.properties Sat Jan 21 03:45:15 2006
@@ -15,3 +15,5 @@
maven.xdoc.date = left
maven.xdoc.locale.default = en
maven.xdoc.version = $Revision$
+
+maven.changes.issue.template = %URL%/issues/id/%ISSUE%
Added: db/torque/site/xdocs/developer-info/codestyle.xml
URL:
http://svn.apache.org/viewcvs/db/torque/site/xdocs/developer-info/codestyle.xml?rev=371015&view=auto
==============================================================================
--- db/torque/site/xdocs/developer-info/codestyle.xml (added)
+++ db/torque/site/xdocs/developer-info/codestyle.xml Sat Jan 21 03:45:15 2006
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2001-2005 The Apache Software Foundation.
+
+ Licensed 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>Code style</title>
+ <author email="[EMAIL PROTECTED]">Thomas Fischer</author>
+ </properties>
+
+ <body>
+ <section name="Code style">
+ <p>
+ The Torque development team follows the
+ <a
href="http://jakarta.apache.org/turbine/common/code-standards.html";>Turbine
code style</a>.
+ Please use this code style if you submit patches and extensions to
Torque.
+ </p>
+ </section>
+ </body>
+</document>
Added: db/torque/site/xdocs/developer-info/contributions.xml
URL:
http://svn.apache.org/viewcvs/db/torque/site/xdocs/developer-info/contributions.xml?rev=371015&view=auto
==============================================================================
--- db/torque/site/xdocs/developer-info/contributions.xml (added)
+++ db/torque/site/xdocs/developer-info/contributions.xml Sat Jan 21 03:45:15
2006
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2001-2005 The Apache Software Foundation.
+
+ Licensed 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>Contributions</title>
+ <author email="[EMAIL PROTECTED]">Thomas Fischer</author>
+ </properties>
+
+ <body>
+ <section name="Contributions">
+ <p>
+ You can submit patches and enhancements either via the
+ <a href="mailto:[email protected]";>Torque development mailing
list</a>
+ or via the
+ <a href="http://issues.apache.org/scarab/issues";>issue tracker</a>.
+ Submissions via the issue tracker are preferred (mailing lists tend
+ to have a short memory).
+ </p>
+ </section>
+ </body>
+</document>
Modified: db/torque/site/xdocs/developer-info/developer-guide.xml
URL:
http://svn.apache.org/viewcvs/db/torque/site/xdocs/developer-info/developer-guide.xml?rev=371015&r1=371014&r2=371015&view=diff
==============================================================================
--- db/torque/site/xdocs/developer-info/developer-guide.xml (original)
+++ db/torque/site/xdocs/developer-info/developer-guide.xml Sat Jan 21 03:45:15
2006
@@ -18,7 +18,7 @@
<document>
<properties>
- <title>Torque Developer's Guide</title>
+ <title>Developer's Guide</title>
<author email="[EMAIL PROTECTED]">Jason van Zyl</author>
<author email="[EMAIL PROTECTED]">John McNally</author>
<author email="[EMAIL PROTECTED]">Martin Poeschl</author>
@@ -27,203 +27,49 @@
<body>
- <section name="Torque Directory Structure">
-
- <p>
- Here is what the Torque directory structure looks like in SVN:
- </p>
-
- <source><![CDATA[
- db-torque/
- profile/ <--- testing profiles
- src/ <--- sources
- conf/ <--- runtime configuration
- generator/ <--- home of torque-gen
- src/ <--- sources
- conf/ <--- generator configuration and ant buildfile
- dtd/ <--- DTD for schema.xml files
- java/ <--- java sources for generator
- schema/ <--- needed schema files (IDBroker)
- templates/ <--- templates for sql- and om- generation
- test/ <--- junit tests
- xdocs/ <--- docs for generator in anakia xml format
- java/ <--- java sources for runtime
- maven-plugin <--- home of maven-plugin
- xdocs/ <--- docs for maven-plugin in anakia xml format
- rttest/ <--- sources for the runtime tests
- test/ <--- junit tests
- xdocs/ <--- docs for runtime in anakia xml format
- ]]></source>
- </section>
<section name="Building from SVN">
<p>
The Torque build process uses
- <a href="http://maven.apache.org";>Maven</a>. Before you begin, you'll
- need to check out the <code>db-torque</code> SVN repository (if you are
- not familiar with the Apache SVN repositories, please refer to the
- <a
href="http://www.apache.org/dev/version-control.html";>documentation</a>).
- Specific information for Torque is available on the
- <a href="cvs-usage.html">Source Repository</a> page.
+ <a href="http://maven.apache.org/maven1";>Maven 1</a>. The recommended
+ Maven version is Maven 1.0.2. Maven2 is not supported.
+ </p>
+ <p>
+ Before you begin, you'll need to check out the <code>trunks</code>
+ part of the <code>db/torque</code> SVN repository.
+ Please read the <a href="subversion.html">Torque Subversion</a> page
+ for more information.
</p>
<p>
To build the Torque generator jar, first execute
<code>maven jar:install</code> in the
- <code>src/generator/src/templates</code> directory to install a copy
+ <code>templates</code> directory to install a copy
of the templates jar in your local Maven repository. Note that
- <code>maven jar:jar</code> does not suffice here because the
+ <code>maven jar:jar</code> does not suffice because the
main generator jar depends upon the template jar.
- Afterwards, execute <code>maven jar:jar</code> in the src/generator
+ Afterwards, execute <code>maven jar:jar</code> in the generator
directory to build the generator jar (<code>maven jar:install</code>
to install a copy of the jar in your local Maven repository).
</p>
<p>
- To build and install the Torque maven-plugin execute <code>maven
- plugin:install</code> in the <code>src/maven-plugin</code> directory.
+ To build and install the Torque maven-plugin, execute <code>maven
+ plugin:install</code> in the <code>maven-plugin</code> directory.
+ You need to have the generator installed in your local repository
+ to do that (see paragraph above).
</p>
<p>
To build the Torque runtime jar execute <code>maven jar:jar</code> in
- the root directory of the project (<code>maven jar:install</code> to
- install a copy of the jar in your local Maven repository).
+ the <code>runtime</code> directory
+ (<code>maven jar:install</code> to install a copy of the jar
+ in your local Maven repository).
</p>
</section>
<section name="Testing">
- <p>
- You must define a profile in your <code>${user.home}/build.properties
- </code> file
- </p>
-
- <source><![CDATA[
- torque.testProfile=profile/oracle.profile
- ]]></source>
-
- <p>
- Edit the profile to match your database settings. To start the runtime
- tests simply type:
- </p>
-
- <source><![CDATA[
- maven runtime:test
- ]]></source>
-
- <p>
- Please report any problems to the
- <a href="mailto:[email protected]";>torque-dev</a> mailing list.
+ <p>
+ Torque is tested by running the test project. Please refer to the
+ <a href="test-project.html">Test Project docs</a> for information.
</p>
-
- </section>
-
- <section name="Initialisation of the Torque Runtime">
- <p>
- This section is meant to to provide some insight into the
initialisation procedure
- of Torque.
- On initialisation, Torque needs to provide the following resources to
work properly
- <ul>
- <li>
- The name of the default database, configured by the key
- torque.database.default
- </li>
- <li>
- The adapters, configured by the keys
- torque.database.<databaseName>.adapter
- </li>
- <li>
- The DataSourceFactories, configured by the keys
- torque.dsfactory.<databaseName>.<property>.
- For some DataSourceFactories, default values can be defined under
- torque.defaults.<property>.
- </li>
- <li>
- The Database maps. Each peer class registers its Map builder with
the Torque
- runtime when the Base Peer Class is loaded (Usually, a peer class
is loaded
- if one of the constants for a column name is accessed, or a method
- is called). If Torque is already initialized when the Peer class
is loaded
- (this is usually the case) the Map Builder builds the database map
instantly
- and makes it avaliable to Torque. If Torque is not yet initialized,
- the Peer class stores the Map Builder with Torque, which builds
the database
- Map when Torque is initialized.
- </li>
- <li>
- The managers. These are not used in most setups.
- </li>
- </ul>
- </p>
-
- </section>
-
- <section name="Internal resources used by the Torque Runtime">
-
- <subsection name="Default database name">
- <p>
- Torque can be used with several databases at once. The resources for
each
- database are usually kept in Maps where the key is the name of the
database.
- To make things easier for people who use only one database, Torque
supports
- the notion of a default database. This allows it to provide
convenience
- methods like Torque.getConnection() where no database name must be
specified.
- These methods refer to the default database, in contrast to e.g.
- Torque.getConnection(String) where the name of the database must be
supplied
- explicitly.
- </p>
- </subsection>
-
- <subsection name="Adapters">
- <p>
- Although all databases supported by Torque understand SQL, there are
- differences in the behaviour of the databases which the Torque
runtime
- needs to know about. For example, the standard (String) format of a
date
- object in an oracle9i database is different from a postgresql
database.
- The adapter for a database provides the necessary methods to hide
such
- differences from the user.
- For example, the adapter provides a method to create a String in the
- database's preferred format from a Date object.
- </p>
-
- <p>
- Adapters are subclasses of the org.apache.torque.adapter.DB class.
- The adapters are stored in the private map
TorqueInstance.apdapterMap;
- the key of the map is the name of the database (e.g. "bookstore"),
and the
- value of the map is the adapter. The adapter for a given key
- can be retrieved via the method Torque.getDB(key).
- </p>
- </subsection>
-
- <subsection name="DataSourceFactories">
- <p>
- To access a database, a connection must be made to the database.
- A DataSource is an object which can provide Connections to the
database.
- A DataSourceFactory is used to configure and provide one DataSource.
- </p>
-
- <p>
- DataSourceFactories must implement the interface
- org.apache.torque.dsfactory.DataSourceFactory.
- The DataSourceFactories are stored in the private map
- TorqueInstance.dsFactoryMap; the key of the map is the
- name of the database (e.g. "bookstore"), and the
- value of the map is the DataSourceFactory.
- The DataSourceFactory for a given key
- can not be retrieved by a public method; however, a connection
- from the DataSource for the DataSourceFactory for a given key
- can be obtained by Torque.getConnection(key);
- </p>
- </subsection>
-
- <subsection name="Database maps">
- <p>
- Torque sometimes needs to know internals about the structure of the
- database, e.g. which table contains which columns etc.
- This knowledge is kept in the database maps.
- </p>
-
- <p>
- Database Maps are instances of the class
org.apache.torque.map.DatabaseMap.
- They are kept in the instance variable TorqueInstance.dbMaps. The Map
- for the database with the name key can be retrieved by the method
- Torque.getDatabaseMap(key).
- </p>
- </subsection>
-
</section>
</body>
Modified: db/torque/site/xdocs/developer-info/historic-changes.xml
URL:
http://svn.apache.org/viewcvs/db/torque/site/xdocs/developer-info/historic-changes.xml?rev=371015&r1=371014&r2=371015&view=diff
==============================================================================
--- db/torque/site/xdocs/developer-info/historic-changes.xml (original)
+++ db/torque/site/xdocs/developer-info/historic-changes.xml Sat Jan 21
03:45:15 2006
@@ -28,7 +28,7 @@
<section name="Newer Changes">
<p>
Starting with the Torque 3.0-B3 release, we keep our changes in the
- <a href="changes-report.html">Maven Changes file</a>.
+ <a href="../changes-report.html">Maven Changes file</a>.
</p>
</section>
<section name="Changes">
Added: db/torque/site/xdocs/developer-info/index.xml
URL:
http://svn.apache.org/viewcvs/db/torque/site/xdocs/developer-info/index.xml?rev=371015&view=auto
==============================================================================
--- db/torque/site/xdocs/developer-info/index.xml (added)
+++ db/torque/site/xdocs/developer-info/index.xml Sat Jan 21 03:45:15 2006
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2001-2005 The Apache Software Foundation.
+
+ Licensed 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 Developer information</title>
+ <author email="[EMAIL PROTECTED]">Thomas Fischer</author>
+ </properties>
+
+ <body>
+ <section name="Torque developer information">
+ <p>
+ This section contains information and guidelines for the developers
+ of Torque and people who wish to contribute to Torque. It does not
+ contain information of how to use Torque.
+ </p>
+ </section>
+ </body>
+</document>
Modified: db/torque/site/xdocs/developer-info/references.xml
URL:
http://svn.apache.org/viewcvs/db/torque/site/xdocs/developer-info/references.xml?rev=371015&r1=371014&r2=371015&view=diff
==============================================================================
--- db/torque/site/xdocs/developer-info/references.xml (original)
+++ db/torque/site/xdocs/developer-info/references.xml Sat Jan 21 03:45:15 2006
@@ -18,7 +18,7 @@
<document>
<properties>
- <title>Torque</title>
+ <title>References</title>
<author email="[EMAIL PROTECTED]">Jason van Zyl</author>
</properties>
Modified: db/torque/site/xdocs/developer-info/subversion.xml
URL:
http://svn.apache.org/viewcvs/db/torque/site/xdocs/developer-info/subversion.xml?rev=371015&r1=371014&r2=371015&view=diff
==============================================================================
--- db/torque/site/xdocs/developer-info/subversion.xml (original)
+++ db/torque/site/xdocs/developer-info/subversion.xml Sat Jan 21 03:45:15 2006
@@ -53,12 +53,37 @@
some "gotchas", so be warned.
</p>
- <subsection name="Torque Modules">
+ <subsection name="Torque Repository Structure">
+
+ <p>
+ Here is what the Torque directory structure looks like in SVN:
+ </p>
+
+ <source><![CDATA[
+ db/torque/
+ common <--- contains files common to all components.
+ Referenced by svn:externals
+ runtime <--- contains the runtime component
+ generator <--- contains the generator component
+ templates <--- contains the generator templates component
+ maven-plugin <--- contains the maven plugin component
+ test <--- contains the test component
+ trunks <--- contains references to the trunks of all
+ component (via svn:externals)
+ site <--- contains the unversioned part of the sources of the
+ homepage ("unversioned" means "no tags,
+ no branches")
+ branches <--- old branches (pre-3.2)
+ tags <--- old tags (pre-3.2)
+ ]]></source>
+ </subsection>
+
+ <subsection name="Torque Components">
<p>
- Torque contains the following modules:
+ Torque contains the following components:
<table>
- <tr><th>Module</th><th>Subversion repository</th></tr>
+ <tr><th>Component</th><th>Trunk repository location</th></tr>
<tr><td>Runtime</td> <td><a
href="http://svn.apache.org/viewcvs/db/torque/runtime/trunk/";>http://svn.apache.org/repos/asf/db/torque/runtime/trunk</a></td></tr>
<tr><td>Generator</td> <td><a
href="http://svn.apache.org/viewcvs/db/torque/generator/trunk/";>http://svn.apache.org/repos/asf/db/torque/generator/trunk/</a></td></tr>
@@ -75,10 +100,11 @@
<p>
These modules make up the main torque distribution. They
are released in regular intervals and are available as binary
- and source distributions from <a href="/download.html">the
+ and source distributions from <a href="../download.html">the
Torque download page</a>. Each of these modules is developed
on its own Subversion trunk; Tags and Branches are located in
- the respective <code>.../tags</code> and <code>.../branches</code>
subdirectories.
+ the respective <code>.../tags</code> and <code>.../branches</code>
+ subdirectories.
</p>
</subsection>
@@ -97,8 +123,8 @@
<subsection name="Test project">
<p>
The test project is used by Torque developers to test the functionality
- of Torque. See the <a href="tests.html">test guide</a> for an explanation
- of how to run the tests.
+ of Torque. See the <a href="test-project.html">test guide</a>
+ for an explanation of how to run the tests.
</p>
</subsection>
<subsection name="Site">
@@ -118,8 +144,14 @@
in the module specific branches/ and tags/ directories.
<ul>
- <li><a href="http://svn.apache.org/viewcvs/db/torque/tags/";>Old CVS
Tags</a> -- http://svn.apache.org/repos/asf/db/torque/tags/</li>
- <li><a href="http://svn.apache.org/viewcvs/db/torque/branches/";>Old CVS
Branches</a> -- http://svn.apache.org/repos/asf/db/torque/branches/</li>
+ <li>
+ <a href="http://svn.apache.org/viewcvs/db/torque/tags/";>Old CVS
Tags</a>
+ -- http://svn.apache.org/repos/asf/db/torque/tags/
+ </li>
+ <li>
+ <a href="http://svn.apache.org/viewcvs/db/torque/branches/";>Old CVS
Branches</a>
+ -- http://svn.apache.org/repos/asf/db/torque/branches/
+ </li>
</ul>
</p>
</section>
@@ -150,9 +182,16 @@
the following goals inside the resulting directory:
<ul>
- <li>build -- Builds all parts of Torque</li>
- <li>install - Builds all parts of Torque and installs the resulting jars
and plugins into your local maven repository</li>
- <li>site -- Builds the documentation sites for all parts of Torque</li>
+ <li>
+ build -- Builds all parts of Torque
+ </li>
+ <li>
+ install - Builds all parts of Torque and installs the resulting jars
+ and plugins into your local maven repository
+ </li>
+ <li>
+ site -- Builds the documentation sites for all parts of Torque
+ </li>
</ul>
</p>
</section>
Added: db/torque/site/xdocs/documentation/index.xml
URL:
http://svn.apache.org/viewcvs/db/torque/site/xdocs/documentation/index.xml?rev=371015&view=auto
==============================================================================
--- db/torque/site/xdocs/documentation/index.xml (added)
+++ db/torque/site/xdocs/documentation/index.xml Sat Jan 21 03:45:15 2006
@@ -0,0 +1,90 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2001-2005 The Apache Software Foundation.
+
+ Licensed 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>Documentation for Torque</title>
+ <author email="[EMAIL PROTECTED]">Thomas Fischer</author>
+ </properties>
+
+ <body>
+
+ <section name="Documentation for Torque">
+
+ <p>
+ This contains the versioned documentation for Torque.
+ The documentation is separated into the different components of Torque
+ and the different releases of Torque.
+ </p>
+
+ <p>
+ To get information about generating the java classes using Maven,
+ see the Maven plugin documentation.
+ </p>
+
+ <p>
+ To learn about generating the java classes using Ant,
+ see the generator documentation.
+ </p>
+
+ <p>
+ The reference for using the generated classes in your project can
+ be found in the runtime documentation.
+ </p>
+
+ <p>
+ Information about peculiarities of some databases, and general howtos
+ spanning several of Torque's components can be found in
+ the "All components" part of the documentation.
+ </p>
+
+ <p>
+ Please choose the appropriate version and component:
+ </p>
+
+ <subsection name="Torque 3.2">
+ <p>
+ <ul>
+ <li>
+ <a href="../releases/torque-3.2/runtime/index.html">Runtime</a>
+ </li>
+ <li>
+ <a
href="../releases/torque-3.2/generator/index.html">Generator</a>
+ </li>
+ <li>
+ <a href="../releases/torque-3.2/maven-plugin/index.html">Maven
Plugin</a>
+ </li>
+ <li>
+ <a
href="../releases/torque-3.2/docs-all-components/index.html">All Components</a>
+ </li>
+ </ul>
+ </p>
+ </subsection>
+ <subsection name="Torque 3.1.1">
+ <p>
+ <a href="../releases/torque-3.1.1/index.html" target="_blank">Torque
3.1.1 Docs</a>
+ </p>
+ </subsection>
+ <subsection name="Torque 3.1">
+ <p>
+ <a href="../releases/torque-3.1/index.html" target="_blank">Torque
3.1 Docs</a>
+ </p>
+ </subsection>
+ </section>
+ </body>
+</document>
Modified: db/torque/site/xdocs/index.xml
URL:
http://svn.apache.org/viewcvs/db/torque/site/xdocs/index.xml?rev=371015&r1=371014&r2=371015&view=diff
==============================================================================
--- db/torque/site/xdocs/index.xml (original)
+++ db/torque/site/xdocs/index.xml Sat Jan 21 03:45:15 2006
@@ -22,15 +22,30 @@
<author email="[EMAIL PROTECTED]">Martin Poeschl</author>
<author email="[EMAIL PROTECTED]">Scott Eade</author>
<author email="[EMAIL PROTECTED]">Henning P. Schmiedehausen</author>
+ <author email="[EMAIL PROTECTED]">Thomas Fischer</author>
</properties>
<body>
<section name="What is Torque?">
<p>
- Torque is a persistence layer. It can generate an XML description
- of your database and then generate Java classes to access the
information
- in your database.
+ Torque is an object-relational mapper for java. In other words, Torque
+ lets you access and manipulate data in a relational database
+ using java objects.
+ Unlike most other object-relational mappers, Torque does not use
+ reflection to access user-provided classes, but it generates the
+ necessary classes (including the Data Objects) from an XML schema
+ describing the database layout (which can either be written by hand
+ or generated from an existing database).
+ The XML schema can also be used to generate and execute a SQL script
+ which creates all the tables in the database.
</p>
+
+ <p>
+ Usage of autogeneration eases the customization of the database layer,
+ as you can override the autogenerated methods and thus easily change
+ their behaviour.
+ </p>
+
<p>
Torque was developed as part of the
<a href="http://jakarta.apache.org/turbine/";>Turbine Framework</a>.
@@ -46,28 +61,34 @@
<dt>runtime</dt>
<dd>
The Torque runtime contains everything to allow an
- application to access the database. It is the only component of Torque
+ application to access the database. It is the only component of Torque
needed in your application and can be used standalone.
</dd>
<dt>generator</dt>
<dd>
- The generator contains ant tasks which generate e.g. XML schemata
from your
- database or building Java classes from the database description. The
generator
- is needed at development time to create the O/R peer classes that
allow your
- application to access the database.
+ The generator contains ant tasks which do all the work for the
+ Maven plugin. If you use the Maven plugin, you do not need to use
the
+ generator directly.
+ However, the generator can also be invoked directly using ant.
</dd>
<dt>maven-plugin</dt>
<dd>
- The generator creates the O/R peer and object classes that allow your
- application to access the database. It also generates SQL scripts to
- create the tables in your database.
+ The Maven plugin creates the O/R peer and object classes for accessing
+ and storing data from the database. It can also generate the XML
+ description of an existing database and (in reverse) create an SQL
+ script to create the tables in the database. Internally,
+ the Maven plugin uses the generator to accomplish these tasks.
</dd>
<dt>templates</dt>
<dd>
- Up to release 3.1.x, the templates were a part of the generator.
Starting with
- the 3.2 release of Torque, the templates have been separated into
their own
- jar archive. The templates are the building blocks for generating SQL
and Java
- files which are used to create, manipulate and access your database.
+ The templates contain the building blocks used by the generator
+ to create the O/R peer and object classes, SQL scripts and the like.
+ You can change the templates if you want to customize the output
+ of the generator (this is only necessary in very special
+ circumstances).
+ Up to release 3.1.x, the templates were a part of the generator.
+ Starting with the 3.2 release of Torque, the templates have been
+ separated into their own jar archive.
</dd>
</dl>
</p>
@@ -76,8 +97,12 @@
<section name="Releases">
<p>
<ul>
- <li>Most recent <i>production</i> release of Torque is <a
href="releases/torque-3.2/">Torque 3.2</a></li>
- <!--li>Most recent <i>development</i> release of Torque is <a
href="releases/torque-3.2-rc3/">Torque 3.2-rc3</a></li-->
+ <li>
+ Most recent <i>production</i> release of Torque is Torque 3.2
+ </li>
+ <!--li>
+ Most recent <i>development</i> release of Torque is Torque 3.2-rc3
+ </li-->
</ul>
</p>
</section>
Modified: db/torque/site/xdocs/navigation.xml
URL:
http://svn.apache.org/viewcvs/db/torque/site/xdocs/navigation.xml?rev=371015&r1=371014&r2=371015&view=diff
==============================================================================
--- db/torque/site/xdocs/navigation.xml (original)
+++ db/torque/site/xdocs/navigation.xml Sat Jan 21 03:45:15 2006
@@ -19,35 +19,41 @@
<title>Torque</title>
<body>
- <links>
- <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="Torque">
<item name="Overview" href="/index.html"/>
<item name="News and Status" href="/status.html"/>
<item name="Downloads" href="/download.html"/>
- <item name="Subversion / CVS" href="/subversion.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="Subversion / CVS"
href="/developer-info/subversion.html"/>
+ <item name="Test project"
href="/developer-info/test-project.html"/>
+ <item name="Code style"
href="/developer-info/codestyle.html"/>
+ <item name="Developer Guide"
href="/developer-info/developer-guide.html"/>
+ <item name="Contributions"
href="/developer-info/contributions.html"/>
+ <item name="References"
href="/developer-info/references.html"/>
+ <item name="Historic changes"
href="/developer-info/historic-changes.html"/>
+ </item>
</menu>
- <menu name="Development">
- <item name="Runtime" href="/runtime/"/>
- <item name="Generator" href="/generator/"/>
- <item name="Templates" href="/templates"/>
- <item name="Maven-Plugin" href="/maven-plugin/"/>
- <item name="Test project" href="/tests.html"/>
+ <menu name="Documentation">
+ <item name="Documentation" href="/documentation/index.html"
collapse="true">
+ </item>
+ <item name="Tutorial" href="/tutorial/index.html"
collapse="true">
+ </item>
</menu>
- <menu name="Releases">
- <item name="Torque 3.2" href="/releases/torque-3.2/runtime/"/>
- <item name="Torque 3.1.1" href="/releases/torque-3.1.1/"/>
- <item name="Torque 3.1" href="/releases/torque-3.1/"/>
+ <menu name="Project documentation">
+ <item name="Project info" href="/project-info.html"
collapse="true">
+ <item name="Development Team" href="/team-list.html"/>
+ <item name="Project License" href="/license.html"/>
+ </item>
+ <item name="Project Reports" href="/project-reports.html"
collapse="true">
+ <item name="Linkcheck" href="/linkcheck.html"/>
+ <item name="Change Log" href="/changelog-report.html"/>
+ </item>
</menu>
</body>
</project>
Added: db/torque/site/xdocs/project-info.xml
URL:
http://svn.apache.org/viewcvs/db/torque/site/xdocs/project-info.xml?rev=371015&view=auto
==============================================================================
--- db/torque/site/xdocs/project-info.xml (added)
+++ db/torque/site/xdocs/project-info.xml Sat Jan 21 03:45:15 2006
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2001-2005 The Apache Software Foundation.
+
+ Licensed 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>Project info</title>
+ <author email="[EMAIL PROTECTED]">Thomas Fischer</author>
+ </properties>
+
+ <body>
+ <section name="Project info">
+ <p>
+ This section contains informations about the Torque project.
+ </p>
+ </section>
+ </body>
+</document>
Added: db/torque/site/xdocs/project-reports.xml
URL:
http://svn.apache.org/viewcvs/db/torque/site/xdocs/project-reports.xml?rev=371015&view=auto
==============================================================================
--- db/torque/site/xdocs/project-reports.xml (added)
+++ db/torque/site/xdocs/project-reports.xml Sat Jan 21 03:45:15 2006
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2001-2005 The Apache Software Foundation.
+
+ Licensed 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>Project reports</title>
+ <author email="[EMAIL PROTECTED]">Thomas Fischer</author>
+ </properties>
+
+ <body>
+ <section name="Project reports">
+ <p>
+ This section contains reports for the Torque site module only.
+ For reports for the different components of Torque, use the
+ <a href="documentation/index.html">component documentation</a>.
+ </p>
+ </section>
+ </body>
+</document>
Modified: db/torque/site/xdocs/status.xml
URL:
http://svn.apache.org/viewcvs/db/torque/site/xdocs/status.xml?rev=371015&r1=371014&r2=371015&view=diff
==============================================================================
--- db/torque/site/xdocs/status.xml (original)
+++ db/torque/site/xdocs/status.xml Sat Jan 21 03:45:15 2006
@@ -71,7 +71,7 @@
repository</a>.<br/>
This is the renamed rc3.
Please refer to
- <a href="releases/torque-3.2/runtime/changes-report.html">
+ <a href="changes-report.html">
the Changes report</a> for a full list of changes and fixed bugs.
</p>
</subsection>
@@ -85,7 +85,7 @@
repository</a>.<br/>
The focus of this release candidate was fixing bugs in 3.2-rc2.
Please refer to
- <a href="releases/torque-3.2/runtime/changes-report.html">
+ <a href="changes-report.html">
the Changes report</a> for a full list of changes and fixed bugs.
</p>
</subsection>
@@ -98,7 +98,7 @@
href="http://ibiblio.org/maven/torque/";>ibiblio maven
repository</a>.<br/>
Please refer to <a
- href="releases/torque-3.2/runtime/changes-report.html">the Changes
report</a> for a full
+ href="changes-report.html">the Changes report</a> for a full
list of changes.
</p>
</subsection>
@@ -135,7 +135,7 @@
page</a> or from the <a
href="http://ibiblio.org/maven/torque/";>ibiblio maven
repository</a>. Please refer for the full changes to the
- changes reports at <a
href="releases/torque-3.2/runtime/changes-report.html">Changes Report</a>.
+ changes reports at <a href="changes-report.html">Changes Report</a>.
</p>
</subsection>
@@ -147,9 +147,9 @@
href="http://ibiblio.org/maven/torque/";>ibiblio maven
repository</a>.<br/>
This is a bugfix release. The docs including a full list of changes
are available
- <a href="/releases/torque-3.1.1/">here</a>
+ <a href="/releases/torque-3.1.1/index.html">here</a>
Please refer to <a
- href="/releases/torque-3.1.1/changes-report.html">the Changes
report</a> for a full
+ href="changes-report.html">the Changes report</a> for a full
list of changes.
</p>
</subsection>
@@ -196,7 +196,7 @@
href="http://ibiblio.org/maven/torque/";>ibiblio maven
repository</a>.<br/>
The docs including a full list of changes are available
- <a href="/releases/torque-3.1/">here</a>
+ <a href="/releases/torque-3.1/index.html">here</a>
Downloads are available <a
href="http://db.apache.org/builds/torque/release/3.1/";>
here</a>.
</p>
@@ -227,8 +227,8 @@
<p>
Downloads are available <a
href="http://db.apache.org/builds/torque/release/3.0.2/";>
here</a>. <br/>
- This is a bugfix release. The docs including a full list of changes
are available
- <a href="/releases/torque-3.0.2/">here</a>
+ This is a bugfix release. The full list of changes is available
+ <a href="changes-report.html">here</a>
</p>
</subsection>
@@ -236,8 +236,8 @@
<p>
Downloads are available <a
href="http://db.apache.org/builds/torque/release/3.0.1/";>
here</a>. <br/>
- This is a bugfix release. The docs including a full list of changes
is available
- <a href="/releases/torque-3.0.1/">here</a>
+ This is a bugfix release. The full list of changes is available
+ <a href="changes-report.html">here</a>
</p>
</subsection>
Added: db/torque/site/xdocs/tutorial/index.xml
URL:
http://svn.apache.org/viewcvs/db/torque/site/xdocs/tutorial/index.xml?rev=371015&view=auto
==============================================================================
--- db/torque/site/xdocs/tutorial/index.xml (added)
+++ db/torque/site/xdocs/tutorial/index.xml Sat Jan 21 03:45:15 2006
@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2001-2005 The Apache Software Foundation.
+
+ Licensed 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 tutorial</title>
+ <author email="[EMAIL PROTECTED]">Thomas Fischer</author>
+ </properties>
+
+ <body>
+
+ <section name="Torque tutorial">
+
+ <p>
+ This section contains the versioned tutorial for Torque.
+ </p>
+
+ <p>
+ Please choose the appropriate version:
+ </p>
+
+ <p>
+ <ul>
+ <li>
+ <a href="../releases/torque-3.2/tutorial/index.html">Tutorial for
Torque 3.2</a>
+ </li>
+ </ul>
+ </p>
+
+ </section>
+ </body>
+</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
