You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by he...@apache.org on 2004/05/21 19:07:45 UTC
cvs commit: jakarta-turbine-2/extensions/maven-plugin/xdocs/images dirtree.png helloworld.png
henning 2004/05/21 10:07:45
Modified: extensions/maven-plugin/xdocs Tag: TURBINE_2_3_BRANCH
goals.xml index.xml navigation.xml properties.xml
Added: extensions/maven-plugin/xdocs Tag: TURBINE_2_3_BRANCH
config.xml getting_started.xml installation.xml
schema.xml tree.xml using_meta.xml
extensions/maven-plugin/xdocs/images Tag: TURBINE_2_3_BRANCH
dirtree.png helloworld.png
Log:
Huge brain dump about everything that I always wanted to tell about the
META plugin. I hope this will help a few peoples to get over the first
hurdles. Please read. All typos are mine.
Docs writing sucks. ;-)
Revision Changes Path
No revision
No revision
1.2.2.2 +140 -42 jakarta-turbine-2/extensions/maven-plugin/xdocs/goals.xml
Index: goals.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/extensions/maven-plugin/xdocs/goals.xml,v
retrieving revision 1.2.2.1
retrieving revision 1.2.2.2
diff -u -r1.2.2.1 -r1.2.2.2
--- goals.xml 19 May 2004 13:48:08 -0000 1.2.2.1
+++ goals.xml 21 May 2004 17:07:45 -0000 1.2.2.2
@@ -1,64 +1,162 @@
-<?xml version="1.0"?>
-<!--
-/*
- * Copyright 2001-2004 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>
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
<properties>
- <title>Maven Turbine Plug-in Goals</title>
+ <title>Maven Environment for Turbine Applications (META) Goals</title>
+ <author email="hps@intermeta.de">Henning P. Schmiedehausen</author>
</properties>
-
<body>
+ <section name="Public goals">
+ <p>These are the visible goals of the META plugin, that you can use for building and
+ deploying your application.
+ </p>
<goals>
<goal>
- <name>turbine:base</name>
+ <name>turbine:setup</name>
+ <description>Setup a new Turbine web application</description>
+ </goal>
+ <goal>
+ <name>turbine:deploy</name>
+ <description>Deploys the Application into a local web container for testing</description>
+ </goal>
+ <goal>
+ <name>turbine:sql</name>
+ <description>Build the SQL files necessary for the application</description>
+ </goal>
+ <goal>
+ <name>turbine:webapp</name>
+ <description>Generate a Turbine based Web application (war)</description>
+ </goal>
+ </goals>
+ </section>
+ <section name="Callback goals">
+ <p>These goals are called from the META-installed maven.xml file in your application. They
+ hook into other plugins and allow META to integrate with the regular maven build process.
+ </p>
+ <goals>
+ <goal>
+ <name>turbine:clean-clean</name>
<description>
- Setup the environment to start developing a Turbine base application
- from scratch.
- <p>
- You must specify the package that you want the code to be
- generated into, e.g.
- </p>
- <source>maven -Dpackage=com.mycompany.project genapp</source>
+<b>postGoal</b> When you run the clean:clean (or just clean) goal in your web
+application and you use inplace deployment, then the clean goal also
+removes your WEB-INF/lib and WEB-INF/classes directory. This ensures
+that no stale classes or libraries from previous compile-deploy-test
+cycles have been left behind.
</description>
</goal>
<goal>
- <name>turbine:sample</name>
+ <name>turbine:java-compile</name>
<description>
- Generate an simple application (like the TDK).
+<b>preGoal</b> Most Turbine applications generate some classes (the Torque peer
+classes) at compile time. This preGoal ensures that java tree from
+src/java gets copied into target/src and the auto-generated classes
+are mixed in correctly.<br/>
+Also runs the om generation goals if the peer classes are out of
+date.
</description>
</goal>
<goal>
- <name>turbine:inplace</name>
+ <name>turbine:torque-datadtd</name>
<description>
- Builds an inplace exploded WAR webapp. Run this the first time to
- setup your inplace development. Also runs the eclipse plugin to
- update your .project and .classpath files. This faciliates using Eclipse
- and Turbine baseds apps together.
+<b>preGoal</b> Ensures that the the data definition files and their dtds are copied into the build tree before running the goal.
</description>
- </goal>
+ </goal>
<goal>
- <name>turbine:inplace-clean</name>
+ <name>turbine:torque-datasql</name>
<description>
- Cleans an inplace exploded WAR webapp. Note, this deletes any
- files in the 'src/WEB-INF/classes' and 'src/WEB-INF/lib' directories!
+<b>preGoal</b> Ensures that the the data definition files and their dtds are copied into the build tree before running the goal.
</description>
- </goal>
+ </goal>
+ <goal>
+ <name>turbine:torque-init</name>
+ <description>
+<b>preGoal</b> Copies the schema files from src/schema into the build tree and
+replaces properties on the fly. As torque:init is run before every
+other torque task, this preGoal ensures that all torque tasks work on
+the latest schema file versions.
+ </description>
+ </goal>
+ <goal>
+ <name>turbine:torque-insert-sql</name>
+ <description>
+<b>preGoal</b> Makes sure that all SQL files are up-to-date before torque tries to
+insert them into your databases.
+ </description>
+ </goal>
+ <goal>
+ <name>turbine:war-webapp</name>
+ <description>
+<b>postGoal</b> Copies the Turbine specific parts of a web application (templates,
+scripts, styles, images and configuration) into the web application
+tree.
+ </description>
+ </goal>
+ </goals>
+ </section>
+ <section name="Private goals">
+ <p>There are a few more goals in this plugin which are for internal use and you should never
+ need to call them directly.<br/>
+ These goals might change from relase to release (or even between
+ releases). They're not public and their function outside the META plugin.jelly
+ file is undefined.
+ </p>
+ <goals>
+ <goal>
+ <name>turbine:check-runtime-environment</name>
+ <description>
+ </description>
+ </goal>
+ <goal>
+ <name>turbine:check-setup-environment</name>
+ <description>
+ </description>
+ </goal>
+ <goal>
+ <name>turbine:copy-app-om</name>
+ <description>
+ </description>
+ </goal>
+ <goal>
+ <name>turbine:copy-data-dtd</name>
+ <description>
+ </description>
+ </goal>
+ <goal>
+ <name>turbine:copy-id-table-om</name>
+ <description>
+ </description>
+ </goal>
+ <goal>
+ <name>turbine:copy-om</name>
+ <description>
+ </description>
+ </goal>
+ <goal>
+ <name>turbine:copy-security-om</name>
+ <description>
+ </description>
+ </goal>
+ <goal>
+ <name>turbine:init</name>
+ <description>
+ </description>
+ </goal>
+ <goal>
+ <name>turbine:om-check</name>
+ <description>
+ </description>
+ </goal>
+ <goal>
+ <name>turbine:security-datadtd</name>
+ <description>
+ </description>
+ </goal>
+ <goal>
+ <name>turbine:security-datasql</name>
+ <description>
+ </description>
+ </goal>
</goals>
+ </section>
</body>
</document>
1.2.2.2 +55 -13 jakarta-turbine-2/extensions/maven-plugin/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/extensions/maven-plugin/xdocs/index.xml,v
retrieving revision 1.2.2.1
retrieving revision 1.2.2.2
diff -u -r1.2.2.1 -r1.2.2.2
--- index.xml 19 May 2004 13:48:08 -0000 1.2.2.1
+++ index.xml 21 May 2004 17:07:45 -0000 1.2.2.2
@@ -18,22 +18,64 @@
-->
<document>
-
<properties>
- <title>Maven Turbine Plug-in</title>
+ <title>Maven Environment for Turbine Applications (META)</title>
+ <author email="hps@intermeta.de">Henning P. Schmiedehausen</author>
</properties>
<body>
- <section name="Maven Turbine Plug-in">
-
- <p>
- This plugin is for working with Turbine.
- </p>
- <p>
- It has goals to help you setup your base Turbine environment. Additionally it has
- goals to help you with inplace code/build/compile development.
- </p>
+<section name="Maven Environment for Turbine Applications (META)">
+<p>
+The Maven Environment for Turbine Application (META) is an easy way to
+get started with applications based on the Turbine Webapplication
+framework and also a collection of "best practices" and
+configuration information to get you started with writing code using
+the Turbine framework.
+</p>
+</section>
+
+<section name="How it works">
+<p>
+META builds an application skeleton from a set of prebuilt
+configuration files and some user supplied parameters. Most of the
+parameters have reasonable defaults, only the application name must be
+supplied by the developer.
+<br/>
+Parameters are supplied either on the command line (if you want to
+rapid prototype an application, you can do so by running a single
+maven command) or with a special properties file that will be read by
+the META task. Please see the <a href="getting_started.html">Getting Started</a>
+page for a reference on how to bootstrap your application.
+</p>
+</section>
+<section name="Maven Integration">
+<p>
+META is installed as a maven plugin and has goals and properties.
+</p>
+
+<subsection name="Goals">
+<p>
+All META goals are prefixed by "turbine" in the maven
+environment. While META is distinctive in the Turbine context, using
+meta:<xxx> proved confusing in the Maven context (is meta:<xxx> a
+maven meta-task or is it part of the META environment?). So the META
+environment uses the "turbine:" prefix.<br/>
- </section>
- </body>
+The available goals are listed on the <a href="goals.html">Goals</a> page.
+</p>
+</subsection>
+<subsection name="Properties">
+<p>
+To adjust the various plugin tasks to your application, you must set a few
+properties in your project.properties or build.properties file. Most of the
+properties have a reasonable default. You can find the complete list of properties
+on the <a href="properties.html">Properties</a> page.
+<br/>
+As META tries to integrate with the maven web application environment
+as seamlessly as possible, it requires a few properties from other
+plugins to be set.
+</p>
+</subsection>
+</section>
+</body>
</document>
1.2.2.2 +16 -27 jakarta-turbine-2/extensions/maven-plugin/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/extensions/maven-plugin/xdocs/navigation.xml,v
retrieving revision 1.2.2.1
retrieving revision 1.2.2.2
diff -u -r1.2.2.1 -r1.2.2.2
--- navigation.xml 19 May 2004 13:48:08 -0000 1.2.2.1
+++ navigation.xml 21 May 2004 17:07:45 -0000 1.2.2.2
@@ -1,35 +1,24 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
-<!--
-/*
- * Copyright 2001-2004 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.
- */
- -->
-
-<project name="Maven Turbine Plugin">
-
- <title>Maven Turbine Plugin</title>
+<?xml version="1.0" encoding="UTF-8"?>
+<project>
+ <title>
+ </title>
<body>
<links>
- <item name="Turbine" href="http://jakarta.apache.org/turbine/"/>
- <item name="Maven" href="http://maven.apache.org/"/>
+ <item href="http://jakarta.apache.org/turbine/" name="Turbine"/>
+ <item href="http://db.apache.org/torque/" name="Torque"/>
+ <item href="http://maven.apache.org/" name="Maven"/>
</links>
<menu name="Overview">
- <item name="Overview" href="/index.html" />
- <item name="Goals" href="/goals.html" />
- <item name="Properties" href="/properties.html" />
+ <item href="/index.html" name="Home"/>
+ <item href="/installation.html" name="Installation"/>
+ <item href="/getting_started.html" name="Getting Started"/>
+ <item href="/using_meta.html" name="Using META"/>
+ <item href="/tree.html" name="Directory tree reference"/>
+ <item href="/config.html" name="Configuration file reference"/>
+ <item href="/schema.html" name="Schema file reference"/>
+ <item href="/goals.html" name="Goals"/>
+ <item href="/properties.html" name="Properties"/>
</menu>
</body>
</project>
1.2.2.2 +212 -37 jakarta-turbine-2/extensions/maven-plugin/xdocs/properties.xml
Index: properties.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/extensions/maven-plugin/xdocs/properties.xml,v
retrieving revision 1.2.2.1
retrieving revision 1.2.2.2
diff -u -r1.2.2.1 -r1.2.2.2
--- properties.xml 19 May 2004 13:48:08 -0000 1.2.2.1
+++ properties.xml 21 May 2004 17:07:45 -0000 1.2.2.2
@@ -1,42 +1,217 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
-<!--
-/*
- * Copyright 2001-2004 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>
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
<properties>
- <title>Maven Turbine Plug-in Properties</title>
+ <title>Properties</title>
+ <author email="hps@intermeta.de">Henning P. Schmiedehausen</author>
</properties>
-
<body>
- <section name="Application Generation Settings">
- <table>
- <tr><th>Property</th><th>Optional?</th><th>Description</th><th>Default</th></tr>
- <tr>
- <td>package</td>
- <td>No</td>
- <td>
- Specifies the name of the Java package that code will be
- generated for.
- </td>
- <td/>
- </tr>
- </table>
- </section>
- </body>
+<section name="Setup Properties from the META plugin">
+ <p>
+META uses two sets of plugin properties to configure your Turbine
+application. The first set is called the "Setup Properties",
+because they're only read by the turbine:setup goal which is run when
+creating the skeleton of your application. These parameters are used
+in various places and transformed into your turbine specific
+configuration files. Once you've set up your application, these
+parameter are no longer used. If you change these, you must rerun the
+turbine:setup goal (which might result in losing other changes to your
+configuration files, so be careful!).
+</p>
+
+ <p>
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Optional?</th>
+ <th>Default value</th>
+ <th>Description</th>
+ </tr>
+
+<tr>
+<td>turbine.app.name</td>
+<td>No</td>
+<td><b>no default value</b></td>
+<td>Name of the new application.<font color="red">Must be set for turbine:setup, else the task fails!</font></td>
+</tr>
+
+<tr>
+<td>turbine.app.package</td>
+<td>Yes</td>
+<td>org.apache.turbine.app.${turbine.app.name}</td>
+<td>The Java package of the new application.</td>
+</tr>
+
+<tr>
+<td>turbine.app.om.name</td>
+<td>Yes</td>
+<td>${turbine.app.name}</td>
+<td>Name of the Torque datasource for application data.</td>
+</tr>
+
+<tr>
+<td>turbine.app.om.package</td>
+<td>Yes</td>
+<td>${turbine.app.package}.om</td>
+<td>Package for the OM classes to be used for application data.</td>
+</tr>
+
+<tr>
+<td>turbine.app.om.security.name</td>
+<td>Yes</td>
+<td>${turbine.app.om.name}</td>
+<td>Name of the Torque datasource which
+ contains the Turbine security tables (users, groups, roles, permissions)</td>
+</tr>
+
+<tr>
+<td>turbine.app.om.security.package</td>
+<td>Yes</td>
+<td>${turbine.app.om.package}</td>
+<td>Package for the OM classes to be used for security information.</td>
+</tr>
+
+<tr>
+<td>turbine.app.subdir</td>
+<td>Yes</td>
+<td>true</td>
+<td><ul>
+ <li>true: Create the skeleton for the new application in a subdirectory. Name of the subdirectory is ${turbine.app.name}.</li>
+ <li>false: Create the skeleton in the current directory.</li>
+ </ul></td>
+</tr>
+
+ </table>
+</p>
+</section>
+
+<section name="Setup Properties from other plugins">
+ <p>
+ <table>
+ <tr>
+ <th>Plugin</th>
+ <th>Property</th>
+ <th>Optional?</th>
+ <th>Default value</th>
+ <th>Description</th>
+ </tr>
+
+<tr>
+<td>appserver</td>
+<td>maven.appserver.name</td>
+<td>Yes</td>
+<td>tomcat</td>
+<td>Type of the application server used for testing and/or deploying of the application</td>
+</tr>
+
+<tr>
+<td>torque</td>
+<td>torque.database</td>
+<td>Yes</td>
+<td>postgresql</td>
+<td>Sets the database type that this application will use</td>
+</tr>
+
+<tr>
+<td>torque</td>
+<td>torque.database.driver</td>
+<td>Yes</td>
+<td>not set</td>
+<td>Set the database driver class</td>
+</tr>
+
+<tr>
+<td>torque</td>
+<td>torque.database.user</td>
+<td>Yes</td>
+<td>not set</td>
+<td>Set the database user for connecting</td>
+</tr>
+
+<tr>
+<td>torque</td>
+<td>torque.database.password</td>
+<td>Yes</td>
+<td>not set</td>
+<td>Set the database password for connecting</td>
+</tr>
+
+<tr>
+<td>torque</td>
+<td>torque.database.buildUrl</td>
+<td>Yes</td>
+<td>not set</td>
+<td>JDBC-URI which can be used for creating tables
+ and inserting data into the database</td>
+</tr>
+
+<tr>
+<td>torque</td>
+<td>torque.database.createUrl</td>
+<td>Yes</td>
+<td>not set</td>
+<td>JDBC-URI which can be used by the Torque plugin
+ to connect to the database engine to create the
+ requested database.</td>
+</tr>
+ </table>
+ </p>
+</section>
+
+<section name="Properties from the META plugin">
+ <p>
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Optional?</th>
+ <th>Default value</th>
+ <th>Description</th>
+ </tr>
+<tr>
+<td>turbine.app.inplace</td>
+<td>Yes</td>
+<td>false</td>
+<td>Defines whether a web application should be
+ treated as an inplace application (the source tree
+ is located in the web application) or it should be
+ copied into the application tree.
+</td>
+</tr>
+<tr>
+<td>turbine.app.inplace.dir</td>
+<td>Yes</td>
+<td>src/webapp</td>
+<td>Location of the deployment directory inside an application. This
+ property is only used when inplace deployment is
+ selected (turbine.app.inplace is true).
+</td>
+</tr>
+ </table>
+ </p>
+</section>
+
+<section name="Properties from other plugins">
+ <p>
+ <table>
+ <tr>
+ <th>Plugin</th>
+ <th>Property</th>
+ <th>Optional?</th>
+ <th>Default value</th>
+ <th>Description</th>
+ </tr>
+<tr>
+<td>appserver</td>
+<td>maven.appserver.home</td>
+<td>Yes</td>
+<td>not set</td>
+<td>Defines the root directory of your application server used for
+ testing and/or deploying of the application if you use container
+ deployment (turbine.app.inplace is true).
+</td>
+</tr>
+ </table>
+ </p>
+</section>
+</body>
</document>
No revision
Index: properties.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/extensions/maven-plugin/xdocs/properties.xml,v
retrieving revision 1.2.2.1
retrieving revision 1.2.2.2
diff -u -r1.2.2.1 -r1.2.2.2
--- properties.xml 19 May 2004 13:48:08 -0000 1.2.2.1
+++ properties.xml 21 May 2004 17:07:45 -0000 1.2.2.2
@@ -1,42 +1,217 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
-<!--
-/*
- * Copyright 2001-2004 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>
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
<properties>
- <title>Maven Turbine Plug-in Properties</title>
+ <title>Properties</title>
+ <author email="hps@intermeta.de">Henning P. Schmiedehausen</author>
</properties>
-
<body>
- <section name="Application Generation Settings">
- <table>
- <tr><th>Property</th><th>Optional?</th><th>Description</th><th>Default</th></tr>
- <tr>
- <td>package</td>
- <td>No</td>
- <td>
- Specifies the name of the Java package that code will be
- generated for.
- </td>
- <td/>
- </tr>
- </table>
- </section>
- </body>
+<section name="Setup Properties from the META plugin">
+ <p>
+META uses two sets of plugin properties to configure your Turbine
+application. The first set is called the "Setup Properties",
+because they're only read by the turbine:setup goal which is run when
+creating the skeleton of your application. These parameters are used
+in various places and transformed into your turbine specific
+configuration files. Once you've set up your application, these
+parameter are no longer used. If you change these, you must rerun the
+turbine:setup goal (which might result in losing other changes to your
+configuration files, so be careful!).
+</p>
+
+ <p>
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Optional?</th>
+ <th>Default value</th>
+ <th>Description</th>
+ </tr>
+
+<tr>
+<td>turbine.app.name</td>
+<td>No</td>
+<td><b>no default value</b></td>
+<td>Name of the new application.<font color="red">Must be set for turbine:setup, else the task fails!</font></td>
+</tr>
+
+<tr>
+<td>turbine.app.package</td>
+<td>Yes</td>
+<td>org.apache.turbine.app.${turbine.app.name}</td>
+<td>The Java package of the new application.</td>
+</tr>
+
+<tr>
+<td>turbine.app.om.name</td>
+<td>Yes</td>
+<td>${turbine.app.name}</td>
+<td>Name of the Torque datasource for application data.</td>
+</tr>
+
+<tr>
+<td>turbine.app.om.package</td>
+<td>Yes</td>
+<td>${turbine.app.package}.om</td>
+<td>Package for the OM classes to be used for application data.</td>
+</tr>
+
+<tr>
+<td>turbine.app.om.security.name</td>
+<td>Yes</td>
+<td>${turbine.app.om.name}</td>
+<td>Name of the Torque datasource which
+ contains the Turbine security tables (users, groups, roles, permissions)</td>
+</tr>
+
+<tr>
+<td>turbine.app.om.security.package</td>
+<td>Yes</td>
+<td>${turbine.app.om.package}</td>
+<td>Package for the OM classes to be used for security information.</td>
+</tr>
+
+<tr>
+<td>turbine.app.subdir</td>
+<td>Yes</td>
+<td>true</td>
+<td><ul>
+ <li>true: Create the skeleton for the new application in a subdirectory. Name of the subdirectory is ${turbine.app.name}.</li>
+ <li>false: Create the skeleton in the current directory.</li>
+ </ul></td>
+</tr>
+
+ </table>
+</p>
+</section>
+
+<section name="Setup Properties from other plugins">
+ <p>
+ <table>
+ <tr>
+ <th>Plugin</th>
+ <th>Property</th>
+ <th>Optional?</th>
+ <th>Default value</th>
+ <th>Description</th>
+ </tr>
+
+<tr>
+<td>appserver</td>
+<td>maven.appserver.name</td>
+<td>Yes</td>
+<td>tomcat</td>
+<td>Type of the application server used for testing and/or deploying of the application</td>
+</tr>
+
+<tr>
+<td>torque</td>
+<td>torque.database</td>
+<td>Yes</td>
+<td>postgresql</td>
+<td>Sets the database type that this application will use</td>
+</tr>
+
+<tr>
+<td>torque</td>
+<td>torque.database.driver</td>
+<td>Yes</td>
+<td>not set</td>
+<td>Set the database driver class</td>
+</tr>
+
+<tr>
+<td>torque</td>
+<td>torque.database.user</td>
+<td>Yes</td>
+<td>not set</td>
+<td>Set the database user for connecting</td>
+</tr>
+
+<tr>
+<td>torque</td>
+<td>torque.database.password</td>
+<td>Yes</td>
+<td>not set</td>
+<td>Set the database password for connecting</td>
+</tr>
+
+<tr>
+<td>torque</td>
+<td>torque.database.buildUrl</td>
+<td>Yes</td>
+<td>not set</td>
+<td>JDBC-URI which can be used for creating tables
+ and inserting data into the database</td>
+</tr>
+
+<tr>
+<td>torque</td>
+<td>torque.database.createUrl</td>
+<td>Yes</td>
+<td>not set</td>
+<td>JDBC-URI which can be used by the Torque plugin
+ to connect to the database engine to create the
+ requested database.</td>
+</tr>
+ </table>
+ </p>
+</section>
+
+<section name="Properties from the META plugin">
+ <p>
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Optional?</th>
+ <th>Default value</th>
+ <th>Description</th>
+ </tr>
+<tr>
+<td>turbine.app.inplace</td>
+<td>Yes</td>
+<td>false</td>
+<td>Defines whether a web application should be
+ treated as an inplace application (the source tree
+ is located in the web application) or it should be
+ copied into the application tree.
+</td>
+</tr>
+<tr>
+<td>turbine.app.inplace.dir</td>
+<td>Yes</td>
+<td>src/webapp</td>
+<td>Location of the deployment directory inside an application. This
+ property is only used when inplace deployment is
+ selected (turbine.app.inplace is true).
+</td>
+</tr>
+ </table>
+ </p>
+</section>
+
+<section name="Properties from other plugins">
+ <p>
+ <table>
+ <tr>
+ <th>Plugin</th>
+ <th>Property</th>
+ <th>Optional?</th>
+ <th>Default value</th>
+ <th>Description</th>
+ </tr>
+<tr>
+<td>appserver</td>
+<td>maven.appserver.home</td>
+<td>Yes</td>
+<td>not set</td>
+<td>Defines the root directory of your application server used for
+ testing and/or deploying of the application if you use container
+ deployment (turbine.app.inplace is true).
+</td>
+</tr>
+ </table>
+ </p>
+</section>
+</body>
</document>
No revision
Index: properties.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/extensions/maven-plugin/xdocs/properties.xml,v
retrieving revision 1.2.2.1
retrieving revision 1.2.2.2
diff -u -r1.2.2.1 -r1.2.2.2
--- properties.xml 19 May 2004 13:48:08 -0000 1.2.2.1
+++ properties.xml 21 May 2004 17:07:45 -0000 1.2.2.2
@@ -1,42 +1,217 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
-<!--
-/*
- * Copyright 2001-2004 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>
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
<properties>
- <title>Maven Turbine Plug-in Properties</title>
+ <title>Properties</title>
+ <author email="hps@intermeta.de">Henning P. Schmiedehausen</author>
</properties>
-
<body>
- <section name="Application Generation Settings">
- <table>
- <tr><th>Property</th><th>Optional?</th><th>Description</th><th>Default</th></tr>
- <tr>
- <td>package</td>
- <td>No</td>
- <td>
- Specifies the name of the Java package that code will be
- generated for.
- </td>
- <td/>
- </tr>
- </table>
- </section>
- </body>
+<section name="Setup Properties from the META plugin">
+ <p>
+META uses two sets of plugin properties to configure your Turbine
+application. The first set is called the "Setup Properties",
+because they're only read by the turbine:setup goal which is run when
+creating the skeleton of your application. These parameters are used
+in various places and transformed into your turbine specific
+configuration files. Once you've set up your application, these
+parameter are no longer used. If you change these, you must rerun the
+turbine:setup goal (which might result in losing other changes to your
+configuration files, so be careful!).
+</p>
+
+ <p>
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Optional?</th>
+ <th>Default value</th>
+ <th>Description</th>
+ </tr>
+
+<tr>
+<td>turbine.app.name</td>
+<td>No</td>
+<td><b>no default value</b></td>
+<td>Name of the new application.<font color="red">Must be set for turbine:setup, else the task fails!</font></td>
+</tr>
+
+<tr>
+<td>turbine.app.package</td>
+<td>Yes</td>
+<td>org.apache.turbine.app.${turbine.app.name}</td>
+<td>The Java package of the new application.</td>
+</tr>
+
+<tr>
+<td>turbine.app.om.name</td>
+<td>Yes</td>
+<td>${turbine.app.name}</td>
+<td>Name of the Torque datasource for application data.</td>
+</tr>
+
+<tr>
+<td>turbine.app.om.package</td>
+<td>Yes</td>
+<td>${turbine.app.package}.om</td>
+<td>Package for the OM classes to be used for application data.</td>
+</tr>
+
+<tr>
+<td>turbine.app.om.security.name</td>
+<td>Yes</td>
+<td>${turbine.app.om.name}</td>
+<td>Name of the Torque datasource which
+ contains the Turbine security tables (users, groups, roles, permissions)</td>
+</tr>
+
+<tr>
+<td>turbine.app.om.security.package</td>
+<td>Yes</td>
+<td>${turbine.app.om.package}</td>
+<td>Package for the OM classes to be used for security information.</td>
+</tr>
+
+<tr>
+<td>turbine.app.subdir</td>
+<td>Yes</td>
+<td>true</td>
+<td><ul>
+ <li>true: Create the skeleton for the new application in a subdirectory. Name of the subdirectory is ${turbine.app.name}.</li>
+ <li>false: Create the skeleton in the current directory.</li>
+ </ul></td>
+</tr>
+
+ </table>
+</p>
+</section>
+
+<section name="Setup Properties from other plugins">
+ <p>
+ <table>
+ <tr>
+ <th>Plugin</th>
+ <th>Property</th>
+ <th>Optional?</th>
+ <th>Default value</th>
+ <th>Description</th>
+ </tr>
+
+<tr>
+<td>appserver</td>
+<td>maven.appserver.name</td>
+<td>Yes</td>
+<td>tomcat</td>
+<td>Type of the application server used for testing and/or deploying of the application</td>
+</tr>
+
+<tr>
+<td>torque</td>
+<td>torque.database</td>
+<td>Yes</td>
+<td>postgresql</td>
+<td>Sets the database type that this application will use</td>
+</tr>
+
+<tr>
+<td>torque</td>
+<td>torque.database.driver</td>
+<td>Yes</td>
+<td>not set</td>
+<td>Set the database driver class</td>
+</tr>
+
+<tr>
+<td>torque</td>
+<td>torque.database.user</td>
+<td>Yes</td>
+<td>not set</td>
+<td>Set the database user for connecting</td>
+</tr>
+
+<tr>
+<td>torque</td>
+<td>torque.database.password</td>
+<td>Yes</td>
+<td>not set</td>
+<td>Set the database password for connecting</td>
+</tr>
+
+<tr>
+<td>torque</td>
+<td>torque.database.buildUrl</td>
+<td>Yes</td>
+<td>not set</td>
+<td>JDBC-URI which can be used for creating tables
+ and inserting data into the database</td>
+</tr>
+
+<tr>
+<td>torque</td>
+<td>torque.database.createUrl</td>
+<td>Yes</td>
+<td>not set</td>
+<td>JDBC-URI which can be used by the Torque plugin
+ to connect to the database engine to create the
+ requested database.</td>
+</tr>
+ </table>
+ </p>
+</section>
+
+<section name="Properties from the META plugin">
+ <p>
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Optional?</th>
+ <th>Default value</th>
+ <th>Description</th>
+ </tr>
+<tr>
+<td>turbine.app.inplace</td>
+<td>Yes</td>
+<td>false</td>
+<td>Defines whether a web application should be
+ treated as an inplace application (the source tree
+ is located in the web application) or it should be
+ copied into the application tree.
+</td>
+</tr>
+<tr>
+<td>turbine.app.inplace.dir</td>
+<td>Yes</td>
+<td>src/webapp</td>
+<td>Location of the deployment directory inside an application. This
+ property is only used when inplace deployment is
+ selected (turbine.app.inplace is true).
+</td>
+</tr>
+ </table>
+ </p>
+</section>
+
+<section name="Properties from other plugins">
+ <p>
+ <table>
+ <tr>
+ <th>Plugin</th>
+ <th>Property</th>
+ <th>Optional?</th>
+ <th>Default value</th>
+ <th>Description</th>
+ </tr>
+<tr>
+<td>appserver</td>
+<td>maven.appserver.home</td>
+<td>Yes</td>
+<td>not set</td>
+<td>Defines the root directory of your application server used for
+ testing and/or deploying of the application if you use container
+ deployment (turbine.app.inplace is true).
+</td>
+</tr>
+ </table>
+ </p>
+</section>
+</body>
</document>
1.1.2.1 +272 -0 jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/config.xml
1.1.2.1 +92 -0 jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/getting_started.xml
1.1.2.1 +112 -0 jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/installation.xml
1.1.2.1 +121 -0 jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/schema.xml
1.1.2.1 +210 -0 jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/tree.xml
1.1.2.1 +219 -0 jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/using_meta.xml
No revision
No revision
1.1.2.1 +28 -0 jakarta-turbine-2/extensions/maven-plugin/xdocs/images/Attic/dirtree.png
<<Binary file>>
1.1.2.1 +109 -0 jakarta-turbine-2/extensions/maven-plugin/xdocs/images/Attic/helloworld.png
<<Binary file>>
---------------------------------------------------------------------
To unsubscribe, e-mail: turbine-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: turbine-dev-help@jakarta.apache.org