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/06/27 16:34:16 UTC
cvs commit: jakarta-turbine-2/extensions/maven-plugin/xdocs/images dirtree.png
henning 2004/06/27 07:34:16
Modified: extensions/maven-plugin/xdocs Tag: TURBINE_2_3_BRANCH
config.xml flavors.xml getting_started.xml
goals.xml index.xml installation.xml navigation.xml
properties.xml schema.xml tree.xml using_meta.xml
Added: extensions/maven-plugin/xdocs Tag: TURBINE_2_3_BRANCH
modes.xml
Removed: extensions/maven-plugin/xdocs/images Tag: TURBINE_2_3_BRANCH
dirtree.png
Log:
Update documentation for the turbine-plugin
Revision Changes Path
No revision
No revision
1.1.2.3 +32 -26 jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/config.xml
Index: config.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/config.xml,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -u -r1.1.2.2 -r1.1.2.3
--- config.xml 23 May 2004 10:50:36 -0000 1.1.2.2
+++ config.xml 27 Jun 2004 14:34:15 -0000 1.1.2.3
@@ -27,7 +27,7 @@
<section name="Configuration files">
<p>
- META generates a few configuration files for your application. These work
+ M.E.T.A. generates a few configuration files for your application. These work
well for a simple application without security and just a few data sources.<br/>
<b>All configuration files, unless stated explicitly otherwise, get
deleted and recreated if you re-run <code>turbine:setup</code>. So be
@@ -36,11 +36,11 @@
<subsection name="Maven specific configuration files">
<p>
-META generates and uses the following configuration files in the root
+M.E.T.A. generates and uses the following configuration files in the root
directory of your application tree.<br/>
If you run the <code>turbine:setup</code> goal and no
-<code>setup.properties</code> file exists in it yet, a new file is
+<code>setup.properties</code> file exists in it, a new file is
created with all parameters copied in. An existing setup.properties
file is never clobbered!<br/>
@@ -53,7 +53,7 @@
<tr>
<a name="setup_properties"/>
<td>setup.properties</td>
- <td>META configuration</td>
+ <td>M.E.T.A. configuration</td>
<td>Whenever you run the <code>turbine:setup</code> goal, this
file is read and used to generate all other configuration
files. It should contain the <a
@@ -76,7 +76,7 @@
<td>maven.xml</td>
<td>Maven build file</td>
<td>This file contains the callbacks from other maven goals into
- META. If you need to customize your build process, you can add
+ M.E.T.A. If you need to customize your build process, you can add
custom goals or callbacks in this file.</td>
</tr>
<tr>
@@ -92,28 +92,32 @@
<subsection name="Application specific configuration files">
<p>
- META generates the following configuration files for your
- application. These files are located in the <code>conf</code>
- subdirectory of the application tree.
+ M.E.T.A. generates the following configuration files for your
+ application. These location of these files differ in the various
+ application development modes.
<table>
<tr>
- <th>Name</th>
+ <th>Name and Location in normal Mode</th>
+ <th>name and Location in inplace Mode</th>
<th>Function</th>
<th>Description</th>
</tr>
<tr>
- <td><appname>.properties</td>
+ <td>conf/<appname>.properties</td>
+ <td>WEB-INF/conf/<appname>.properties</td>
<td>Turbine configuration</td>
<td>This file gets included by the <code>TurbineResources.properties</code> file when Turbine is configured.</td>
</tr>
<tr>
- <td><appname>-web.xml</td>
+ <td>conf/<appname>-web.xml</td>
+ <td>WEB-INF/web.xml</td>
<td>Deployment descriptor</td>
- <td>This is the deployment descriptor for your application. It gets copied to <code>WEB-INF/web.xml</code> in your application.</td>
+ <td>This is the deployment descriptor for your application. In <a href="modes.html#normal">Normal</a> mode, it gets copied to <code>WEB-INF/web.xml</code> in your application.</td>
</tr>
<tr>
- <td><appname>-intake.xml</td>
+ <td>conf/<appname>-intake.xml</td>
+ <td>WEB-INF/conf/<appname>-intake.xml</td>
<td>IntakeService</td>
<td>This file should contain your intake group definitions.</td>
</tr>
@@ -124,7 +128,7 @@
<subsection name="TurbineResource.properties">
<p>
This is the main configuration file for Tubine. It contains all the
- settings for the turbine core. The META configuration has the
+ settings for the turbine core. The M.E.T.A. configuration has the
following settings which might bite you when you build an
application. It is necessary that you review the settings in this
file and customize them to match your application needs!<br/> This
@@ -156,7 +160,7 @@
<tr>
<td>action.sessionvalidator</td>
<td>sessionvalidator.TemplateSessionValidator</td>
- <td>A META-generated application does not use security by default! If you
+ <td>A M.E.T.A.-generated application does not use security by default! If you
need <a
href="http://www.lyricsdir.com/m/men-without-hats/security-everybody-feels-better-with.php">security</a>,
you must change this to
@@ -168,7 +172,7 @@
<td colspan="2">The default configuration does not activate all
the Turbine-supplied services! E.g. the Scheduler is not activated by
default. If you need additional services, you must add them to your
-configuration file. META activates the following services:<br/>
+configuration file. M.E.T.A. activates the following services:<br/>
<ul>
<li>AvalonComponentService</li>
<li>CryptoService</li>
@@ -219,8 +223,8 @@
<subsection name="Application-specific properties">
<p>
- All application specific parameters are configured in <appname>.properties. It gets
- merged into <code>TurbineResources.properties</code>.
+ All application specific parameters are configured in <appname>.properties. This file is
+ loaded by an <code>include</code> property in <code>TurbineResources.properties</code>.
</p>
<table>
@@ -250,22 +254,23 @@
<subsection name="torque.properties">
<p>
- Some parts of Turbine and probably your web application will use
+ Some parts of Turbine and probably your web application might use
<a href="http://db.apache.org/torque/">Torque</a> to access databases.<br/>
- In this configuration file, the various datasources are defined. META
+ In this configuration file, the various datasources are defined. M.E.T.A.
generates a default data source (<code>default</code>) and an application
specific data source (<code><appname></code>) for you.<br/>
At setup time, both data sources are mapped onto the same JDBC data provider.
</p>
- <p>META uses the <code>org.apache.torque.dsfactory.SharedPoolDataSourceFactory</code>
+ <p>M.E.T.A. configures Torque to use the
+ <code>org.apache.torque.dsfactory.SharedPoolDataSourceFactory</code>
as pool factory.</p>
</subsection>
<subsection name="log4j.properties">
<p>
For debugging purposes is it very important to get logging
- information from a running application. META generated applications
+ information from a running application. M.E.T.A. generated applications
write the following log files into the <a
href="tree.html#logs">logs</a> subdirectory:<br/>
@@ -311,9 +316,10 @@
<subsection name="Avalon specific configuration">
<p>
Turbine 2.3 uses the AvalonComponentService to load and initialize
- <a href="http://db.apache.org/torque/">Torque</a>. META provides two
+ <a href="http://db.apache.org/torque/">Torque</a>.<br/>
+ M.E.T.A. provides two
minimal <a href="http://avalon.apache.org/">Avalon</a> configuration
- files to allow this.<br/>
+ files to allow this:
<ul>
<li>componentConfiguration.xml</li>
@@ -323,8 +329,8 @@
If you don't intend to use Avalon in your application, you should
not change anything here.</p>
</subsection>
- <p><b>Using META is no replacement for looking at the Turbine documentation and the
- comments in the configuration files!</b></p>
+ <p><font color="red">Using M.E.T.A. is no replacement for looking at the Turbine documentation and the
+ comments in the configuration files!</font></p>
</section>
</body>
</document>
1.1.2.2 +24 -18 jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/flavors.xml
Index: flavors.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/flavors.xml,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- flavors.xml 23 May 2004 18:17:14 -0000 1.1.2.1
+++ flavors.xml 27 Jun 2004 14:34:15 -0000 1.1.2.2
@@ -11,7 +11,7 @@
There is more than just one version of Turbine. You might have to build one application using
a released version of Turbine (currently 2.3) and the next should use a developer version or
even a "bleeding edge" snapshot release of the Turbine code. Whatever you want to use,
- the META plugin helps you selecting the right skeleton for your code.
+ the M.E.T.A. plugin helps you selecting the right skeleton for your code.
</p>
<subsection name="Selecting Flavors">
@@ -34,16 +34,21 @@
<p>
<font color="red">This is a section for advanced users that are
reasonably familiar with maven and the Turbine framework. If you're
-just starting to use Turbine and META, you can skip this
+just starting to use Turbine and M.E.T.A., you can skip this
section.</font></p>
<p>
-Flavors are built from templates in various subdirectories in the META plugin. If you want to add a new
-flavor, you must modify the plugin source and then deploy the plugin to your maven installation.<br/>
+Flavors are built from templates in the <code>flavor</code>
+subdirectory of the M.E.T.A. plugin. If you want to add a new flavor, you
+must modify the plugin source and then rebuild and deploy the plugin
+to your maven installation.<br/>
The plugin source contains a subdirectory
-<code>src/plugin-resources</code>. Here are the setup files for each flavor stored, that are used by the
-<code>turbine:setup</code> goal.
+<code>src/plugin-resources/flavor</code>. Here are the setup files for
+each flavor stored, that are used by the <a
+href="goals.html#turbine_setup">turbine:setup</a> goal. Each flavor
+has its own subdirectory which can in turn contain the following
+directories:
<table>
<tr>
@@ -72,24 +77,25 @@
</tr>
</table>
-In each of these directories you'll find a directory called
-<code>common</code> and a subdirectory for each flavor. The setup goal
-first copies all the files from the <code>common</code> directory into
-the new application skeleton and then the files from the respective
-flavor directory. Files from the latter will overwrite files from the
-common tree.
+There is also a directory called <code>common</code> which contains
+files that are the same for all flavors.
</p>
<p>
-Subdirectories might be missing in the trees (e.g. there are no
-flavor-specific files in the <code>images</code> tree and no common
-files in the <code>conf</code> tree). In this case they will be
-silently skipped.
+<a href="goals.html#turbine_setup">turbine:setup</a> copies all the
+files from the <code>common</code> directory into the new application
+skeleton and then the files from the respective flavor
+directory. Files from the latter will overwrite files from the
+<code>common</code> tree.
</p>
<p>
-To add a new flavor, you must add at least a flavor specific
-subdirectory to the <code>maven</code> tree which contains the
+Subdirectories can be omitted if there are no flavor specific files.
+</p>
+
+<p>
+To add a new flavor, you must add at least a flavor specific <code>maven</code>
+subdirectory as <code>flavor/<your flavor name>/maven</code> which contains the
template for the maven POM (<code>project.xml</code>).
</p>
</subsection>
1.1.2.6 +63 -26 jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/getting_started.xml
Index: getting_started.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/getting_started.xml,v
retrieving revision 1.1.2.5
retrieving revision 1.1.2.6
diff -u -r1.1.2.5 -r1.1.2.6
--- getting_started.xml 23 May 2004 10:50:36 -0000 1.1.2.5
+++ getting_started.xml 27 Jun 2004 14:34:15 -0000 1.1.2.6
@@ -19,7 +19,7 @@
<document>
<properties>
- <title>Maven Environment for Turbine Applications (META)</title>
+ <title>Maven Environment for Turbine Applications (M.E.T.A.)</title>
<author email="hps@intermeta.de">Henning P. Schmiedehausen</author>
</properties>
@@ -28,9 +28,11 @@
<subsection name="Prepare your build.properties">
<p>
-To be able to install your applications into a servlet container, you must either
-use inplace deployment or add the location of your web container to your build.properties (If you're writing
-web applications with maven, this is a good idea anyway). You should add a line like this:
+M.E.T.A can install your application into a servlet container, if you
+supply its location (If you're writing web applications with maven,
+this is a good idea anyway). To do so, add the following line to your
+personal <code>build.properties</code> file which is normally located
+in your home directory.
<source><![CDATA[
For Unix:
@@ -40,17 +42,22 @@
maven.appserver.home = C:/Program Files/Apache Software Foundation/Tomcat-5.0.24
]]></source>
-Please make sure that you do not add the webapp subdirectory to this
-property! <br/>
-On Windows, you must use the slash ("/"), not the backslash for the directory pathes!
+<font color="red">
+<ul>
+<li>Please make sure that you do not append the <code>webapp</code> subdirectory. This property should contain the root of your application server!</li>
+<li>If you are using Windows, you must still use the slash ("/"), not the backslash for the directory paths!</li>
+</ul>
+</font>
</p>
</subsection>
<subsection name="Hello World">
<p>
-Ready to rock? Ok, let's do it. Enter the following command:
+<a href="http://www.ultimatequeen.co.uk/Songs/killers.htm#letme">Hello everybody. Feeling good? Are you ready to rock? Are you ready to roll? OK, let's do it.</a><br/>
+Enter the following command:
</p>
+<a name="singlecommand" />
<source><![CDATA[
maven -Dturbine.app.name=helloworld turbine:setup
]]></source>
@@ -60,31 +67,61 @@
subdirectory in your current directory called
"helloworld". It should have a directory structure like
this:</p>
-<p><center>
-<img src="images/dirtree.png" width="310" height="429"/><br/>
-</center></p>
-<p>
-Now enter this subdirectory. META has set up the skeleton of your
-application for you. It even contains a welcome page to show you that
-everything is fine. Lets compile and deploy the application to your
-web container to check this out:
+
+<source><![CDATA[
+helloworld
+|-- conf
+`-- src
+ |-- images
+ |-- java
+ | `-- org
+ | `-- apache
+ | `-- turbine
+ | `-- app
+ | `-- helloworld
+ | `-- modules
+ | |-- actions
+ | |-- layouts
+ | |-- navigations
+ | |-- pages
+ | `-- screens
+ |-- resources
+ |-- schema
+ |-- scripts
+ |-- style
+ |-- templates
+ | |-- layouts
+ | |-- macros
+ | |-- navigations
+ | `-- screens
+ `-- test
+]]></source>
+
+<p>
+M.E.T.A. has set up the skeleton of your application. It even
+contains a welcome page to show you that everything is fine.</p>
+
+<p>
+<font color="red">Enter the <code>helloworld</code> directory</font>.<br/>
+Compile and deploy the application to your web container:
<source><![CDATA[
maven turbine:deploy
]]></source>
-Restart your web comtainer or force it to reload its applications.<br/>
-Point your browser to the deployed application (if you use Tomcat
+Restart your web container or force it to reload its applications.<br/>
+Point your browser to the deployed application (if you use <a href="http://jakarta.apache.org/tomcat/">Tomcat</a>
running on your local machine, this would be
-http://localhost:8080/helloworld/app/). It should look like this:</p>
+<a href="http://localhost:8080/helloworld/app/">http://localhost:8080/helloworld/app/</a>).</p>
-<p><center>
-<img src="images/helloworld.png" width="722" height="525"/><br/>
-</center></p>
-<p>
-You've successfully installed and run your very first Turbine
-application! The gory details about the META plugin are found on the
-<a href="using_meta.html">Using META</a> page.</p>
+<p>The result should look like this:
+<center><img src="images/helloworld.png" width="722" height="525"/><br/></center>
+</p>
+
+<p>
+You have successfully installed and run your very first Turbine
+application! The gory details about the M.E.T.A. plugin are found on the
+<a href="using_meta.html">Using M.E.T.A.</a> page.</p>
</subsection>
</section>
</body>
1.2.2.4 +22 -5 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.3
retrieving revision 1.2.2.4
diff -u -r1.2.2.3 -r1.2.2.4
--- goals.xml 23 May 2004 10:50:36 -0000 1.2.2.3
+++ goals.xml 27 Jun 2004 14:34:15 -0000 1.2.2.4
@@ -2,36 +2,45 @@
<document>
<properties>
- <title>Maven Environment for Turbine Applications (META) Goals</title>
+ <title>Maven Environment for Turbine Applications (M.E.T.A.) 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
+ <p>These are the visible goals of the M.E.T.A. plugin, that you can use for building and
deploying your application.
</p>
<goals>
<goal>
+ <a name="turbine_setup"/>
<name>turbine:setup</name>
<description><a href="using_meta.html#Setting_up_your_application_for_the_first_time">Setup a new Turbine web application</a></description>
</goal>
<goal>
+ <a name="turbine_deploy"/>
<name>turbine:deploy</name>
<description>Deploys the Application into a local web container for testing</description>
</goal>
<goal>
+ <a name="turbine_sql"/>
<name>turbine:sql</name>
<description>Build the SQL files necessary for the application</description>
</goal>
<goal>
+ <a name="turbine_webapp"/>
<name>turbine:webapp</name>
<description>Generate a Turbine based Web application (war)</description>
</goal>
+ <goal>
+ <a name="turbine_install_libs"/>
+ <name>turbine:install-libs</name>
+ <description> Updates the libraries for an inplace application</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>These goals are called from the M.E.T.A.-installed maven.xml file in your application. They
+ hook into other plugins and allow M.E.T.A. to integrate with the regular maven build process.
</p>
<goals>
<goal>
@@ -56,6 +65,14 @@
</description>
</goal>
<goal>
+ <name>turbine:java-compile</name>
+ <description>
+<b>postGoal</b> For an inplace application, this updates the needed
+libraries in the <a href="tree.html#web_inf_lib">library location</a> of
+an inplace application.
+ </description>
+ </goal>
+ <goal>
<name>turbine:torque-datadtd</name>
<description>
<b>preGoal</b> Ensures that the the data definition files and their dtds are copied into the build tree before running the goal.
@@ -97,7 +114,7 @@
<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
+ releases). They're not public and their function outside the M.E.T.A. plugin.jelly
file is undefined.
</p>
<goals>
1.2.2.4 +27 -24 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.3
retrieving revision 1.2.2.4
diff -u -r1.2.2.3 -r1.2.2.4
--- index.xml 23 May 2004 10:50:36 -0000 1.2.2.3
+++ index.xml 27 Jun 2004 14:34:15 -0000 1.2.2.4
@@ -19,62 +19,65 @@
<document>
<properties>
- <title>Maven Environment for Turbine Applications (META)</title>
+ <title>Maven Environment for Turbine Applications (M.E.T.A.)</title>
<author email="hps@intermeta.de">Henning P. Schmiedehausen</author>
</properties>
<body>
-<section name="Maven Environment for Turbine Applications (META)">
+<section name="Maven Environment for Turbine Applications (M.E.T.A.)">
<p>
-The Maven Environment for Turbine Application (META) is an easy way to
-start writing applications based on the Turbine Webapplication
-framework and also a collection of "best practices" and
-configuration information.
+The Maven Environment for Turbine Application (M.E.T.A.) helps you to write
+applications based on the <a href="http://jakarta.apache.org/turbine/">Turbine Webapplication
+framework</a>.
</p>
</section>
<section name="How it works">
<p>
-META builds an application skeleton from a set of prebuilt
+M.E.T.A. 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 at setup time.
<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 is read by META
-when you setup your appliation. Please see the <a
+rapid prototype an application, you can do so by running <a
+href="getting_started.html#singlecommand">a single command</a>)
+or with a special properties file, which is read by M.E.T.A. when you
+setup your appliation. 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.
+M.E.T.A. is installed as a <a
+href="http://maven.apache.org/">maven</a> 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-goal or is it part of the META
-environment?). So the META environment uses the "turbine:"
-prefix.<br/>
+All M.E.T.A. goals are prefixed by "turbine" in the maven
+environment. While "meta" is distinctive in the Turbine
+context, using meta:<xxx> as goal names proved confusing in the
+Maven context (is meta:<xxx> a maven meta-goal or is it part of
+the M.E.T.A. environment?). So the M.E.T.A. environment uses the
+"turbine:" prefix.<br/>
The available goals are listed on the <a href="goals.html">Goals</a> page.
</p>
</subsection>
<subsection name="Properties">
<p>
To adjust the various parameters of the plugin 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. If you use the setup goal
-from META, these properties are preset either from the command line
-parameters or from the parameters set in the setup properties file.
+you must set properties in your <code>project.properties</code> or
+<code>build.properties</code> 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. If you use the <a
+href="goals.html#turbine_setup">turbine:setup</a> goal from M.E.T.A.,
+these properties are preset either from the command line parameters or
+from the parameters set in the setup properties file.
<br/>
-As META tries to integrate with the maven web application environment
+As M.E.T.A. 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>
1.1.2.5 +18 -14 jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/installation.xml
Index: installation.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/installation.xml,v
retrieving revision 1.1.2.4
retrieving revision 1.1.2.5
diff -u -r1.1.2.4 -r1.1.2.5
--- installation.xml 23 May 2004 18:49:00 -0000 1.1.2.4
+++ installation.xml 27 Jun 2004 14:34:15 -0000 1.1.2.5
@@ -19,7 +19,7 @@
<document>
<properties>
- <title>Maven Environment for Turbine Applications (META)</title>
+ <title>Maven Environment for Turbine Applications (M.E.T.A.)</title>
<author email="hps@intermeta.de">Henning P. Schmiedehausen</author>
</properties>
@@ -28,24 +28,24 @@
<subsection name="Installing Maven">
<p>
-If you want to use META, you need <a
+If you want to use M.E.T.A., you need <a
href="http://maven.apache.org/">maven</a>. Even though maven has still
no real release and many things are in a constant state of flux, you
-can get maven 1.0-RC3 from the<a
+can get maven 1.0-RC3 from the <a
href="http://maven.apache.org/start/download.html">maven download
-site</a>, which proved to be working with the META plugin. You can
+site</a>, which proved to be working with the M.E.T.A. plugin. You can
either get a binary or a source distribution.
</p>
</subsection>
-<subsection name="Installing the Torque and META plugins">
+<subsection name="Installing the Torque and M.E.T.A. plugins">
<p>
After you've installed maven, get these plugins through the following links.
</p>
<table>
<tr>
- <td><a href="http://www.apache.org/~henning/maven/maven-turbine-plugin-1.1-dev.jar">META Plugin (Version 1.1-dev)</a></td>
+ <td><a href="http://www.apache.org/~henning/maven/maven-turbine-plugin-1.2-dev.jar">M.E.T.A. Plugin (Version 1.2-dev)</a></td>
</tr>
<tr>
<td><a href="http://www.apache.org/~henning/maven/maven-torque-plugin-3.1.1-dev.jar">Torque Plugin (Version 3.1.1-dev)</a></td>
@@ -55,7 +55,7 @@
If you already have the Torque plugin installed, make sure that you
have the Plugin from the <a
href="http://db.apache.org/torque-31/">Torque 3.1 Branch</a>
-installed. META does not work yet with the 3.2 development branch.
+installed. M.E.T.A. does not work with the 3.2 development branch.
</p>
<p>
@@ -66,7 +66,7 @@
href="http://maven.apache.org/start/install.html">on the maven install
page</a>.<br/>
-After the installation, run maven -g and check whether the following
+After the installation, run <code>maven -g</code> and check whether the following
targets are displayed in the goal list:
</p>
@@ -98,6 +98,8 @@
[turbine] ( NO DEFAULT GOAL )
deploy ......................... Deploys the Application into a local web
container for testing
+ install-libs ................... updates the libraries for an inplace
+ application
setup .......................... Setup a new Turbine web application
sql ............................ Build the SQL files necessary for the
application
@@ -105,8 +107,8 @@
war)
]]></source>
-<p>If you get errors or build failures when running META goals,
-because maven cannot download either <code>torque-3.1.1-dev.jar</code>
+<p>If you get errors or build failures when running M.E.T.A. goals,
+because maven can not download either <code>torque-3.1.1-dev.jar</code>
or <code>torque-gen-3.1.1-dev.jar</code>, then get these files from
here:</p>
@@ -120,12 +122,14 @@
</table>
<p>
These files are dependencies of the Maven Torque plugin which has no
-official release yet and so its dependencies are not yet in the
-central maven repository. Get both files and put them into your local
-repository in the <code>torque/jars</code> subdirectory.
+official release and its dependencies might not be in the maven
+repository located at <a
+href="http://www.ibiblio.org/maven">ibiblio</a>. Get both files and
+put them into your local repository in the <code>torque/jars</code>
+subdirectory.
</p>
-<p>You are now ready to use META. Continue to the <a
+<p>You are now ready to use M.E.T.A. Continue to the <a
href="getting_started.html">Getting Started</a> page.</p>
</subsection>
1.2.2.4 +2 -1 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.3
retrieving revision 1.2.2.4
diff -u -r1.2.2.3 -r1.2.2.4
--- navigation.xml 23 May 2004 18:17:14 -0000 1.2.2.3
+++ navigation.xml 27 Jun 2004 14:34:15 -0000 1.2.2.4
@@ -13,10 +13,11 @@
<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="/using_meta.html" name="Using M.E.T.A."/>
<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="/modes.html" name="Application development modes"/>
<item href="/flavors.html" name="Flavors of Turbine applications"/>
<item href="/goals.html" name="Goals"/>
<item href="/properties.html" name="Properties"/>
1.2.2.5 +110 -28 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.4
retrieving revision 1.2.2.5
diff -u -r1.2.2.4 -r1.2.2.5
--- properties.xml 23 May 2004 18:17:14 -0000 1.2.2.4
+++ properties.xml 27 Jun 2004 14:34:15 -0000 1.2.2.5
@@ -9,18 +9,19 @@
<a name="setup_properties"/>
<section name="Setup Properties">
<p>
-META uses two sets of plugin properties to configure your Turbine
+M.E.T.A. 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
+because they're only read by the <a
+href="goals.html#turbine_setup">turbine:setup</a> 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
+<a href="goals.html#turbine_setup">turbine:setup</a> goal (which might result in losing other changes to your
configuration files, so be careful!).
</p>
-<subsection name="META Plugin">
+<subsection name="M.E.T.A. Plugin">
<p>
<table>
<tr>
@@ -34,7 +35,7 @@
<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 goal fails!</font></td>
+<td>Name of the new application. <font color="red">Must be set for <a href="goals.html#turbine_setup">turbine:setup</a>, else the goal fails!</font></td>
</tr>
<tr>
@@ -59,6 +60,29 @@
</ul></td>
</tr>
+<tr>
+<td>turbine.plugin.mode</td>
+<td>Yes</td>
+<td>normal</td>
+<td>Selects the <a href="modes.html">development mode</a> for your application.</td>
+</tr>
+
+<tr>
+<td>turbine.plugin.inplace.dir</td>
+<td>Yes</td>
+<td>.</td>
+<td>Selects the location of the web application tree relative to to
+ the root of your application when using <a
+ href="modes.html#inplace">inplace</a> development.</td>
+</tr>
+
+<tr>
+<td>turbine.setup.properties</td>
+<td>Yes</td>
+<td>setup.properties</td>
+<td>Selects the properties file which is loaded to configure the <a href="goals.html#turbine_setup">turbine:setup</a> goal.</td>
+</tr>
+
</table>
</p>
</subsection>
@@ -139,14 +163,14 @@
<section name="Properties">
<p>
-These properties are used at setup time and get copied into the META
+These properties are used at setup time and get copied into the M.E.T.A.
generated <a
href="config.html#project_properties">project.properties</a>
-file. They're used by various META goals and can be changed to modify
+file. They're used by various M.E.T.A. goals and can be changed to modify
the behaviour of the plugin goals.
</p>
-<subsection name="META Plugin">
+<subsection name="M.E.T.A. Plugin">
<p>
<table>
<tr>
@@ -194,24 +218,82 @@
</tr>
<tr>
-<td>turbine.app.inplace</td>
+<td>turbine.plugin.base.dir</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>
+<td>.</td>
+<td>Relative location of the web application tree to the application root when using inplace development.</td>
</tr>
+
+<tr>
+<td>turbine.plugin.src.images</td>
+<td>Yes</td>
+<td>depends on development mode, see <a href="tree.html">Directory tree reference</a></td>
+<td>Directory where image files are kept.</td>
+</tr>
+
+<tr>
+<td>turbine.plugin.src.resources</td>
+<td>Yes</td>
+<td>depends on development mode, see <a href="tree.html">Directory tree reference</a></td>
+<td>Directory where misc. Turbine resources are kept.</td>
+</tr>
+
+<tr>
+<td>turbine.plugin.src.schema</td>
+<td>Yes</td>
+<td>depends on development mode, see <a href="tree.html">Directory tree reference</a></td>
+<td>Directory where Torque schema files are kept.</td>
+</tr>
+
+<tr>
+<td>turbine.plugin.src.scripts</td>
+<td>Yes</td>
+<td>depends on development mode, see <a href="tree.html">Directory tree reference</a></td>
+<td>Directory where Javascript files are kept.</td>
+</tr>
+
+<tr>
+<td>turbine.plugin.src.style</td>
+<td>Yes</td>
+<td>depends on development mode, see <a href="tree.html">Directory tree reference</a></td>
+<td>Directory where cascading style sheets are kept.</td>
+</tr>
+
+<tr>
+<td>turbine.plugin.src.templates</td>
+<td>Yes</td>
+<td>depends on development mode, see <a href="tree.html">Directory tree reference</a></td>
+<td>Directory where Velocity template files are kept.</td>
+</tr>
+
+<tr>
+<td>turbine.plugin.src.conf</td>
+<td>Yes</td>
+<td>depends on development mode, see <a href="tree.html">Directory tree reference</a></td>
+<td>Directory where application and Turbine configuration files are kept.</td>
+</tr>
+
+<tr>
+<td>turbine.plugin.src.java</td>
+<td>Yes</td>
+<td>depends on development mode, see <a href="tree.html">Directory tree reference</a></td>
+<td>Directory where the Java source tree is located.</td>
+</tr>
+
+<tr>
+<td>turbine.plugin.src.test</td>
+<td>Yes</td>
+<td>depends on development mode, see <a href="tree.html">Directory tree reference</a></td>
+<td>Directory where Java source code for test classes is kept.</td>
+</tr>
+
+<tr>
+<td>turbine.plugin.target.lib</td>
+<td>Yes</td>
+<td>depends on development mode, see <a href="tree.html">Directory tree reference</a></td>
+<td>Target directory for application libraries when using inplace development.</td>
+</tr>
+
</table>
</p>
</subsection>
@@ -232,8 +314,8 @@
<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).
+ testing and/or deploying of the application if you use a development
+ mode that needs container deployment.
</td>
</tr>
</table>
1.1.2.3 +15 -14 jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/schema.xml
Index: schema.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/schema.xml,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -u -r1.1.2.2 -r1.1.2.3
--- schema.xml 23 May 2004 10:50:36 -0000 1.1.2.2
+++ schema.xml 27 Jun 2004 14:34:15 -0000 1.1.2.3
@@ -29,16 +29,16 @@
<p>
Most Turbine applications use <a
href="http://db.apache.org/torque/">Torque</a> to access
- databases. META supplies you with a few schema files to preset your
+ databases. M.E.T.A. supplies you with a few schema files to preset your
database and to generate some data which can be put into the
database by running the <code>torque:insert-sql</code> goal. All
schema files are located in <a
- href="tree.html#src_schema"><code>src/schema</code></a>, their
+ href="tree.html#src_schema">the schema source directory</a> and their
result is put into the <code>target/sql</code> directory.</p>
<subsection name="application-specific files">
<p>
- META generates a dummy schema file for you. If want to use Torque
+ M.E.T.A. generates a dummy schema file for you. If want to use Torque
to access a database, put your table definitions and data values
into these files.
<table>
@@ -64,15 +64,16 @@
file and changes whenever your table definition file changes.</td>
</tr>
<tr>
- <td><appname>-data.dtdp</td>
+ <td><appname>-data.dtd</td>
<td>Data Type Definition for your custom tables</td>
<td>If you want to use the data loading goals of torque, you must describe
your data in XML which is validated against this DTD. You
don't have to update this file by hand, you can run the
<code>torque:datadtd</code> goal and copy the resulting file
- from <code>target/sql</code> into your <code>src/schema</code>
- directory.<br/> The META generated file is just a dummy because there
- are no custom tables defined at setup time.</td>
+ from <code>target/sql</code> into your <a
+ href="tree.html#src_schema">schema source directory</a>
+ directory.<br/> The M.E.T.A. generated file is just a dummy
+ because there are no custom tables defined at setup time.</td>
</tr>
</table>
</p>
@@ -82,16 +83,16 @@
<p>
The plugin supplies you with a configuration file for generating an <code>ID_TABLE</code>
table which is used by the Torque IdBroker to generate unique table row IDs. If you run
- the <code>turbine:sql</code> goal, SQL for this table is generated. There are no peer and object classes
+ the <a href="goals.html#turbine_sql">turbine:sql</a> goal, SQL for this table is generated. There are no peer and object classes
for the id table.</p>
</subsection>
<subsection name="Turbine Security">
<p>
- Even though the default META application uses no security, it still
+ Even though the default M.E.T.A. application uses no security, it still
generates the necessary tables and informations to write a
security-enabled application.<br/>
- META supplies table definition and preset data to be used in
+ M.E.T.A. supplies table definition and preset data to be used in
conjunction with the <a
href="http://jakarta.apache.org/turbine/turbine-2.3/services/torque-security-service.html">Torque
Security Service</a>. The Schema is similar to the <a
@@ -100,11 +101,11 @@
href="http://jakarta.apache.org/turbine/">Turbine web site</a>.</p>
<p>
- META also provides a demo for presetting security tables from an XML
+ M.E.T.A. also provides a demo for presetting security tables from an XML
file. <code>turbine-security-data.xml</code> and
<code>turbine-security-data.dtd</code> are provided as examples and
can be safely modified or removed if the values are not suitable for
- your application. There is no code inside the META plugin or a META
+ your application. There is no code inside the M.E.T.A. plugin or a M.E.T.A.
generated application that uses the generated Users, Groups, Roles
or Permissions.</p>
@@ -113,8 +114,8 @@
drawback: If you want to use password encryption, you must put the
encrypted strings into the <code>Password</code> attributes of the
TurbineUser elements. If you want to put cleartext passwords into
- the XML file, you must not use Password encryption. This is the
- reason why the default META configuration uses cleartext passwords.
+ the XML file, you must not use Password encryption (The default
+ M.E.T.A. configuration uses cleartext passwords).
</p>
</subsection>
</section>
1.1.2.3 +45 -10 jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/tree.xml
Index: tree.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/tree.xml,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -u -r1.1.2.2 -r1.1.2.3
--- tree.xml 23 May 2004 10:50:36 -0000 1.1.2.2
+++ tree.xml 27 Jun 2004 14:34:15 -0000 1.1.2.3
@@ -26,18 +26,19 @@
<body>
<section name="Development tree">
<p>
-The development tree is prebuilt by the META plugin and conforms to the
-<a href="http://maven.apache.org/reference/dirlayout.html">maven common directory layout</a>.</p>
-
+ The actual tree layout is different in each M.E.T.A. <a href="modes.html">Mode</a>.
+ </p>
<table>
<tr>
- <th>Path</th>
+ <th>normal Mode</th>
+ <th>inplace Mode</th>
<th>Function</th>
<th>Description</th>
</tr>
<a name="conf"/>
<tr>
<td>conf</td>
+<td>WEB-INF/conf</td>
<td>Configuration data for your web application</td>
<td>This directory contains all the configuration files for your
application. All files in this directory with the exception of
@@ -50,6 +51,7 @@
<a name="src_images"/>
<tr>
<td>src/images</td>
+<td>images</td>
<td>Graphics and Images for your application</td>
<td>All files in this directory will be copied to the <code>images</code>
subdirectory in the root of your application. The plugin creates two image
@@ -58,6 +60,7 @@
<tr>
<td>src/java</td>
+<td>WEB-INF/src</td>
<td>Java source files</td>
<td>All files ending on .java in this directory tree get compiled by the
java compile into class files. All other files get copied as is into the
@@ -67,6 +70,7 @@
<a name="src_scripts"/>
<tr>
<td>src/scripts</td>
+<td>scripts</td>
<td>JavaScript files for your application</td>
<td>All files in this directory will be copied to the <code>scripts</code>
subdirectory in the root of your application.</td>
@@ -74,6 +78,7 @@
<tr>
<td>src/schema</td>
+<td>src/schema</td>
<td>XML source files for Torque</td>
<td>This directory contains the definition files for generating the
peer and object classes for Torque and also DTD and data files to
@@ -84,6 +89,7 @@
<a name="src_style"/>
<tr>
<td>src/style</td>
+<td>style</td>
<td>Cascading style sheet files for your application</td>
<td>All files in this directory will be copied to the <code>style</code>
subdirectory in the root of your application.</td>
@@ -92,9 +98,10 @@
<a name="src_templates"/>
<tr>
<td>src/templates/layouts</td>
+<td>templates/layouts</td>
<td>Layout templates for your application</td>
<td>The templates in this directory are used to position screens and
-navigations on a reponse page. The META plugin adds a default layout
+navigations on a reponse page. The M.E.T.A. plugin adds a default layout
page here which just returns the current screen. If you want to use
navigation elements with your application, you must either add your
own custom layout pages or change the default layout to contain
@@ -105,6 +112,7 @@
<tr>
<td>src/templates/macros</td>
+<td>templates/macros</td>
<td>VelociMacros for your application</td>
<td>Files in this directory should be loaded by the Velocity Service
to be used as <a
@@ -115,22 +123,24 @@
<tr>
<td>src/templates/navigations</td>
+<td>templates/navigations</td>
<td>Navigation templates for your application</td>
<td>Put your navigation templates here. If you want to use navigation,
you need layouts that reference these files. The default configuration
-of a META-generated Turbine application does not use navigation.</td>
+of a M.E.T.A.-generated Turbine application does not use navigation.</td>
</tr>
<tr>
<td>src/templates/screens</td>
<td>Screen templates for your application</td>
<td>Put your screen templates to be rendered as output of your application into this
- subdirectory. META creates a sample index screen, which is displayed when you
+ subdirectory. M.E.T.A. creates a sample index screen, which is displayed when you
deploy the application without changing this page.</td>
</tr>
<tr>
<td>src/test/</td>
+<td>WEB-INF/test/</td>
<td>Java test code</td>
<td>Maven expects java classes that contain unit tests in this
@@ -139,13 +149,38 @@
href="http://maven.apache.org/reference/plugins/test/">Maven test
plugin</a> for further information.</td>
</tr>
+<tr>
+<a name="web_inf_lib"/>
+<td><font color="red">Deployment is used</font></td>
+<td>WEB-INF/lib</td>
+<td>libs directory</td>
+<td>All jar files in the project.xml file of your application, that
+have the <code>war.bundle</code> property set to true will be copied
+into this directory.</td>
+</tr>
+<tr>
+<td><font color="red">Deployment is used</font></td>
+<td>WEB-INF/classes</td>
+<td>classes directory</td>
+<td>All class files and all non-java files from the source tree are
+copied into this sub directory. This is defined in the <a href="http://java.sun.com/products/servlet/docs.html">Sun Servlet API</a>.</td>
+</tr>
+<tr>
+<a name="logs"/>
+<td><font color="red">Deployment is used</font></td>
+<td>logs</td>
+<td>Log files</td>
+<td>A M.E.T.A. generated application writes a few logfiles which are useful for debugging and runtime diagnosis. These files are put here.</td>
+</tr>
</table>
</section>
<section name="Deployment tree">
<p>
-This is the layout of a compiled META application in the web container
-or inplace deployment directory.
+This is the layout of a compiled M.E.T.A. application in the web container when
+deployed to a web container. This applies only to modes where deployment is used,
+not to inplace development modes.
+
</p>
<table>
@@ -178,7 +213,7 @@
<a name="logs"/>
<td>logs</td>
<td>Log files</td>
-<td>A META generated application writes a few logfiles which are useful for debugging and runtime diagnosis. These files are put here.</td>
+<td>A M.E.T.A. generated application writes a few logfiles which are useful for debugging and runtime diagnosis. These files are put here.</td>
</tr>
<tr>
<td>templates</td>
1.1.2.3 +57 -68 jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/using_meta.xml
Index: using_meta.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/using_meta.xml,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -u -r1.1.2.2 -r1.1.2.3
--- using_meta.xml 23 May 2004 10:50:36 -0000 1.1.2.2
+++ using_meta.xml 27 Jun 2004 14:34:15 -0000 1.1.2.3
@@ -19,25 +19,34 @@
<document>
<properties>
- <title>Maven Environment for Turbine Applications (META)</title>
+ <title>Maven Environment for Turbine Applications (M.E.T.A.)</title>
<author email="hps@intermeta.de">Henning P. Schmiedehausen</author>
</properties>
<body>
-<section name="Maven goals and your development cycle">
+<section name="Using M.E.T.A.">
+
+<subsection name="M.E.T.A. Modes">
<p>
-If you tried out the example from the <a
-href="getting_started.html">Getting Started</a> page, then you already
-learned about two of the goals that the META plugin provides:<br/>
+The M.E.T.A. plugin can operate in different modes. Currently it supports the following modes:
+
<ul>
-<li><code>turbine:setup</code> creates the application skeleton of your new application.</li>
-<li><code>turbine:deploy</code> installs an application into your web container.</li>
+<li><b>normal</b> - Your application is developed outside the container tree. It must be deployed to the
+container by running the <a href="goals.html#turbine_deploy">turbine:deploy</a> goal.</li>
+<li><b>inplace</b> - The source code and the class files are kept together . Your web container will access
+the files in the development location and no explicit deployment to the container is necessary.
+This mode is similar to developing with the old <a href="http://jakarta.apache.org/turbine/tdk/">Turbine Development Kit</a>.</li>
</ul>
-</p>
+
+Modes are discussed on the <a href="modes.html">Modes</a> page.</p>
+
+</subsection>
+
+<subsection name="Intended Development Cycles">
<p>
-The goals of the META plugin interact with many other goals from maven
+The goals of the M.E.T.A. plugin interact with many other goals from maven
to create your build environment. As the function of some is not
really intuitive, this is how the plugin is intended to be used:</p>
<p>
@@ -61,7 +70,8 @@
| |
^ | no
| V
-t maven turbine:deploy - deploy to container
+| optional: maven turbine:deploy - deploy to container
+| (not needed in "inplace" mode)
| |
| V
^ [In-container testing]
@@ -115,9 +125,10 @@
Ship files from target/sql directory
]]></source>
</p>
+</subsection>
</section>
-<section name="Setting up your application for the first time">
+<section name="Preparing a new M.E.T.A. application">
<subsection name="Ad hoc setup">
<p>
@@ -125,15 +136,15 @@
href="getting_started.html">Getting Started</a> page, then you already
know that setting up a new Turbine-based application is just a single
maven command away. We will refer to this as "ad hoc" setup,
-because you don't need to prepare anything before running the
-<code>turbine:setup</code> goal.
+because you do not need to prepare anything before running the
+<a href="goals.html#turbine_setup">turbine:setup</a> goal.
</p>
<p>
Ad hoc setup is best used if you plan on doing lots of customization
work to your properties anyway or if you just need a quick skeleton to
test out something or jot down a few classes. You simply provide the
-application name on the maven command line and META sets up the rest
+application name on the maven command line and M.E.T.A. sets up the rest
for you using the plugin defaults.</p>
<source><![CDATA[
@@ -142,80 +153,58 @@
<p>
Note: In the subdirectory which contains your application skeleton,
-there will be a META properties file, called <code>setup.properties</code>. This is
+there will be a M.E.T.A. properties file, called <a href="config.html#setup_properties">setup.properties</a>. This is
auto-generated by the plugin to make your setup reproducible.
</p>
</subsection>
<subsection name="Custom setup">
<p>
-Sometimes, ad hoc simply won't cut the cake. Then you need to prepare
-a properties file for the META plugin. This properties file is called
-<a href="config.html#setup_properties"><code>setup.properties</code></a>
-and must be in the directory where you will run the
-<code>turbine:setup</code> goal. Inside this <code>setup.properties</code> file you
-can use <a href="properties.html">all the properties defined by
-META</a>.<br/> This is the only place where the "Setup
-Properties" are used. So changing the <code>setup.properties</code> file after
-running the <code>turbine:setup</code> goal won't do any changes to
-your application unless you rerun the <code>turbine:setup</code> goal.
+Sometimes, ad hoc simply will not cut the cake. Then you need to prepare
+a properties file for the M.E.T.A. plugin called <a href="config.html#setup_properties">setup.properties</a>.
+It must be placed in the directory where you will run the
+<a href="goals.html#turbine_setup">turbine:setup</a> goal. This properties file allows you to customize the layout of the new application.<br/>
</p>
</subsection>
<p>
-Both kinds of setup generate a <code>setup.properties</code> file
-in the application itself. If you want to rebuild the skeleton, you
-can delete all files but the <code>setup.properties</code> from the directory and
-rerun <code>turbine:setup</code>.
+In the application skeleton is a new <a href="config.html#setup_properties">setup.properties</a>
+file created, which can be used to rebuild it by deleting all but this
+file from the directory tree and re-run <a
+href="goals.html#turbine_setup">turbine:setup</a>.
</p>
</section>
-<section name="Deploying your application with META">
+<section name="Deploying your application with M.E.T.A.">
<p>
-Application development normally happens in cycles of programming,
-compile and deploy. If you use an external web container, you simply
-deploy your compiled application into its <code>webapp</code>
-directory. However, if you want to use an integrated development
-environment (IDE) like <a href="http://www.eclipse.org">Eclipse</a>,
-then you might want to use its builtin web container for debugging and
-testing.<br/> The META plugin supports both developmen styles (web
-container and IDE) by using two different deployment modes.</p>
-
-<p>Selecting one of the deployment styles and switching between them
-can be done by changing the <code>turbine.app.inplace</code> property.
-</p>
-
-<subsection name="Container deployment">
-<p>
-Container deployment needs a working web container (e.g. <a
-href="http://jakarta.apache.org/tomcat/">Jakarta Tomcat</a>) on your
-local computer. It copies your application code and all turbine
-support files into a web application in the <code>webapp</code>
-subdirectory of your container. All you need to do is the configuration for
-the appserver plugin (which also gives you the power to start and stop
-your container from maven if it is supported. See the <a
+Application development happens in cycles of programming, compile and
+deploy. If you use an external web container, you deploy your compiled
+application into its <code>webapp</code> directory. If you have a
+local web container that you can customize, you might want to develop
+directly in the <code>webapp</code> directory and skip the
+deployment.<br/>
+</p>
+
+<subsection name="Deployment to a web container">
+<p>
+All your application code and Turbine support files are copied into a
+web container which is outside your development tree. You must
+configure the appserver plugin (which also gives you the power to
+start and stop your container from maven. See the <a
href="http://maven.apache.org/reference/plugins/appserver/">appserver
-plugin documentation</a> for more information). On the <a
-href="properties.html">Properties Page</a> is a description of the
-needed appserver properties.<br/> You can choose this mode by setting
-the <code>turbine.app.inplace</code> property to <code>false</code>.
+plugin documentation</a> for more information) and its configuration
+is then used by M.E.T.A. The required appserver properties are listed
+on the <a href="properties.html">Properties Page</a>.
</p>
</subsection>
-<subsection name="Inplace deployment">
+<subsection name="Inplace Development">
<p>
-Inplace deployment means, that you can freely choose the location
-where your application will be deployed to. For an IDE, this will
-probably be a path inside your application source tree so that the IDE
-can pick up the changes you've made and reconfigure its integrated
-container accordingly.<br/>
-To chose this mode, you must set the <code>turbine.app.inplace</code>
-property to <code>true</code> and set the
-<code>turbine.app.inplace.dir</code> to point at your deployment
-directory. The default is <code>src/webapp</code>, so that the
-application tree lies next to the source tree in
-<code>src/java</code>.
+Inplace development allows you to work directly on the files that are
+used by your web container. Your application code and the Turbine
+support files are located in a directory which is accessed by the web
+container.
</p>
</subsection>
</section>
No revision
Index: using_meta.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/using_meta.xml,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -u -r1.1.2.2 -r1.1.2.3
--- using_meta.xml 23 May 2004 10:50:36 -0000 1.1.2.2
+++ using_meta.xml 27 Jun 2004 14:34:15 -0000 1.1.2.3
@@ -19,25 +19,34 @@
<document>
<properties>
- <title>Maven Environment for Turbine Applications (META)</title>
+ <title>Maven Environment for Turbine Applications (M.E.T.A.)</title>
<author email="hps@intermeta.de">Henning P. Schmiedehausen</author>
</properties>
<body>
-<section name="Maven goals and your development cycle">
+<section name="Using M.E.T.A.">
+
+<subsection name="M.E.T.A. Modes">
<p>
-If you tried out the example from the <a
-href="getting_started.html">Getting Started</a> page, then you already
-learned about two of the goals that the META plugin provides:<br/>
+The M.E.T.A. plugin can operate in different modes. Currently it supports the following modes:
+
<ul>
-<li><code>turbine:setup</code> creates the application skeleton of your new application.</li>
-<li><code>turbine:deploy</code> installs an application into your web container.</li>
+<li><b>normal</b> - Your application is developed outside the container tree. It must be deployed to the
+container by running the <a href="goals.html#turbine_deploy">turbine:deploy</a> goal.</li>
+<li><b>inplace</b> - The source code and the class files are kept together . Your web container will access
+the files in the development location and no explicit deployment to the container is necessary.
+This mode is similar to developing with the old <a href="http://jakarta.apache.org/turbine/tdk/">Turbine Development Kit</a>.</li>
</ul>
-</p>
+
+Modes are discussed on the <a href="modes.html">Modes</a> page.</p>
+
+</subsection>
+
+<subsection name="Intended Development Cycles">
<p>
-The goals of the META plugin interact with many other goals from maven
+The goals of the M.E.T.A. plugin interact with many other goals from maven
to create your build environment. As the function of some is not
really intuitive, this is how the plugin is intended to be used:</p>
<p>
@@ -61,7 +70,8 @@
| |
^ | no
| V
-t maven turbine:deploy - deploy to container
+| optional: maven turbine:deploy - deploy to container
+| (not needed in "inplace" mode)
| |
| V
^ [In-container testing]
@@ -115,9 +125,10 @@
Ship files from target/sql directory
]]></source>
</p>
+</subsection>
</section>
-<section name="Setting up your application for the first time">
+<section name="Preparing a new M.E.T.A. application">
<subsection name="Ad hoc setup">
<p>
@@ -125,15 +136,15 @@
href="getting_started.html">Getting Started</a> page, then you already
know that setting up a new Turbine-based application is just a single
maven command away. We will refer to this as "ad hoc" setup,
-because you don't need to prepare anything before running the
-<code>turbine:setup</code> goal.
+because you do not need to prepare anything before running the
+<a href="goals.html#turbine_setup">turbine:setup</a> goal.
</p>
<p>
Ad hoc setup is best used if you plan on doing lots of customization
work to your properties anyway or if you just need a quick skeleton to
test out something or jot down a few classes. You simply provide the
-application name on the maven command line and META sets up the rest
+application name on the maven command line and M.E.T.A. sets up the rest
for you using the plugin defaults.</p>
<source><![CDATA[
@@ -142,80 +153,58 @@
<p>
Note: In the subdirectory which contains your application skeleton,
-there will be a META properties file, called <code>setup.properties</code>. This is
+there will be a M.E.T.A. properties file, called <a href="config.html#setup_properties">setup.properties</a>. This is
auto-generated by the plugin to make your setup reproducible.
</p>
</subsection>
<subsection name="Custom setup">
<p>
-Sometimes, ad hoc simply won't cut the cake. Then you need to prepare
-a properties file for the META plugin. This properties file is called
-<a href="config.html#setup_properties"><code>setup.properties</code></a>
-and must be in the directory where you will run the
-<code>turbine:setup</code> goal. Inside this <code>setup.properties</code> file you
-can use <a href="properties.html">all the properties defined by
-META</a>.<br/> This is the only place where the "Setup
-Properties" are used. So changing the <code>setup.properties</code> file after
-running the <code>turbine:setup</code> goal won't do any changes to
-your application unless you rerun the <code>turbine:setup</code> goal.
+Sometimes, ad hoc simply will not cut the cake. Then you need to prepare
+a properties file for the M.E.T.A. plugin called <a href="config.html#setup_properties">setup.properties</a>.
+It must be placed in the directory where you will run the
+<a href="goals.html#turbine_setup">turbine:setup</a> goal. This properties file allows you to customize the layout of the new application.<br/>
</p>
</subsection>
<p>
-Both kinds of setup generate a <code>setup.properties</code> file
-in the application itself. If you want to rebuild the skeleton, you
-can delete all files but the <code>setup.properties</code> from the directory and
-rerun <code>turbine:setup</code>.
+In the application skeleton is a new <a href="config.html#setup_properties">setup.properties</a>
+file created, which can be used to rebuild it by deleting all but this
+file from the directory tree and re-run <a
+href="goals.html#turbine_setup">turbine:setup</a>.
</p>
</section>
-<section name="Deploying your application with META">
+<section name="Deploying your application with M.E.T.A.">
<p>
-Application development normally happens in cycles of programming,
-compile and deploy. If you use an external web container, you simply
-deploy your compiled application into its <code>webapp</code>
-directory. However, if you want to use an integrated development
-environment (IDE) like <a href="http://www.eclipse.org">Eclipse</a>,
-then you might want to use its builtin web container for debugging and
-testing.<br/> The META plugin supports both developmen styles (web
-container and IDE) by using two different deployment modes.</p>
-
-<p>Selecting one of the deployment styles and switching between them
-can be done by changing the <code>turbine.app.inplace</code> property.
-</p>
-
-<subsection name="Container deployment">
-<p>
-Container deployment needs a working web container (e.g. <a
-href="http://jakarta.apache.org/tomcat/">Jakarta Tomcat</a>) on your
-local computer. It copies your application code and all turbine
-support files into a web application in the <code>webapp</code>
-subdirectory of your container. All you need to do is the configuration for
-the appserver plugin (which also gives you the power to start and stop
-your container from maven if it is supported. See the <a
+Application development happens in cycles of programming, compile and
+deploy. If you use an external web container, you deploy your compiled
+application into its <code>webapp</code> directory. If you have a
+local web container that you can customize, you might want to develop
+directly in the <code>webapp</code> directory and skip the
+deployment.<br/>
+</p>
+
+<subsection name="Deployment to a web container">
+<p>
+All your application code and Turbine support files are copied into a
+web container which is outside your development tree. You must
+configure the appserver plugin (which also gives you the power to
+start and stop your container from maven. See the <a
href="http://maven.apache.org/reference/plugins/appserver/">appserver
-plugin documentation</a> for more information). On the <a
-href="properties.html">Properties Page</a> is a description of the
-needed appserver properties.<br/> You can choose this mode by setting
-the <code>turbine.app.inplace</code> property to <code>false</code>.
+plugin documentation</a> for more information) and its configuration
+is then used by M.E.T.A. The required appserver properties are listed
+on the <a href="properties.html">Properties Page</a>.
</p>
</subsection>
-<subsection name="Inplace deployment">
+<subsection name="Inplace Development">
<p>
-Inplace deployment means, that you can freely choose the location
-where your application will be deployed to. For an IDE, this will
-probably be a path inside your application source tree so that the IDE
-can pick up the changes you've made and reconfigure its integrated
-container accordingly.<br/>
-To chose this mode, you must set the <code>turbine.app.inplace</code>
-property to <code>true</code> and set the
-<code>turbine.app.inplace.dir</code> to point at your deployment
-directory. The default is <code>src/webapp</code>, so that the
-application tree lies next to the source tree in
-<code>src/java</code>.
+Inplace development allows you to work directly on the files that are
+used by your web container. Your application code and the Turbine
+support files are located in a directory which is accessed by the web
+container.
</p>
</subsection>
</section>
No revision
Index: using_meta.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/using_meta.xml,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -u -r1.1.2.2 -r1.1.2.3
--- using_meta.xml 23 May 2004 10:50:36 -0000 1.1.2.2
+++ using_meta.xml 27 Jun 2004 14:34:15 -0000 1.1.2.3
@@ -19,25 +19,34 @@
<document>
<properties>
- <title>Maven Environment for Turbine Applications (META)</title>
+ <title>Maven Environment for Turbine Applications (M.E.T.A.)</title>
<author email="hps@intermeta.de">Henning P. Schmiedehausen</author>
</properties>
<body>
-<section name="Maven goals and your development cycle">
+<section name="Using M.E.T.A.">
+
+<subsection name="M.E.T.A. Modes">
<p>
-If you tried out the example from the <a
-href="getting_started.html">Getting Started</a> page, then you already
-learned about two of the goals that the META plugin provides:<br/>
+The M.E.T.A. plugin can operate in different modes. Currently it supports the following modes:
+
<ul>
-<li><code>turbine:setup</code> creates the application skeleton of your new application.</li>
-<li><code>turbine:deploy</code> installs an application into your web container.</li>
+<li><b>normal</b> - Your application is developed outside the container tree. It must be deployed to the
+container by running the <a href="goals.html#turbine_deploy">turbine:deploy</a> goal.</li>
+<li><b>inplace</b> - The source code and the class files are kept together . Your web container will access
+the files in the development location and no explicit deployment to the container is necessary.
+This mode is similar to developing with the old <a href="http://jakarta.apache.org/turbine/tdk/">Turbine Development Kit</a>.</li>
</ul>
-</p>
+
+Modes are discussed on the <a href="modes.html">Modes</a> page.</p>
+
+</subsection>
+
+<subsection name="Intended Development Cycles">
<p>
-The goals of the META plugin interact with many other goals from maven
+The goals of the M.E.T.A. plugin interact with many other goals from maven
to create your build environment. As the function of some is not
really intuitive, this is how the plugin is intended to be used:</p>
<p>
@@ -61,7 +70,8 @@
| |
^ | no
| V
-t maven turbine:deploy - deploy to container
+| optional: maven turbine:deploy - deploy to container
+| (not needed in "inplace" mode)
| |
| V
^ [In-container testing]
@@ -115,9 +125,10 @@
Ship files from target/sql directory
]]></source>
</p>
+</subsection>
</section>
-<section name="Setting up your application for the first time">
+<section name="Preparing a new M.E.T.A. application">
<subsection name="Ad hoc setup">
<p>
@@ -125,15 +136,15 @@
href="getting_started.html">Getting Started</a> page, then you already
know that setting up a new Turbine-based application is just a single
maven command away. We will refer to this as "ad hoc" setup,
-because you don't need to prepare anything before running the
-<code>turbine:setup</code> goal.
+because you do not need to prepare anything before running the
+<a href="goals.html#turbine_setup">turbine:setup</a> goal.
</p>
<p>
Ad hoc setup is best used if you plan on doing lots of customization
work to your properties anyway or if you just need a quick skeleton to
test out something or jot down a few classes. You simply provide the
-application name on the maven command line and META sets up the rest
+application name on the maven command line and M.E.T.A. sets up the rest
for you using the plugin defaults.</p>
<source><![CDATA[
@@ -142,80 +153,58 @@
<p>
Note: In the subdirectory which contains your application skeleton,
-there will be a META properties file, called <code>setup.properties</code>. This is
+there will be a M.E.T.A. properties file, called <a href="config.html#setup_properties">setup.properties</a>. This is
auto-generated by the plugin to make your setup reproducible.
</p>
</subsection>
<subsection name="Custom setup">
<p>
-Sometimes, ad hoc simply won't cut the cake. Then you need to prepare
-a properties file for the META plugin. This properties file is called
-<a href="config.html#setup_properties"><code>setup.properties</code></a>
-and must be in the directory where you will run the
-<code>turbine:setup</code> goal. Inside this <code>setup.properties</code> file you
-can use <a href="properties.html">all the properties defined by
-META</a>.<br/> This is the only place where the "Setup
-Properties" are used. So changing the <code>setup.properties</code> file after
-running the <code>turbine:setup</code> goal won't do any changes to
-your application unless you rerun the <code>turbine:setup</code> goal.
+Sometimes, ad hoc simply will not cut the cake. Then you need to prepare
+a properties file for the M.E.T.A. plugin called <a href="config.html#setup_properties">setup.properties</a>.
+It must be placed in the directory where you will run the
+<a href="goals.html#turbine_setup">turbine:setup</a> goal. This properties file allows you to customize the layout of the new application.<br/>
</p>
</subsection>
<p>
-Both kinds of setup generate a <code>setup.properties</code> file
-in the application itself. If you want to rebuild the skeleton, you
-can delete all files but the <code>setup.properties</code> from the directory and
-rerun <code>turbine:setup</code>.
+In the application skeleton is a new <a href="config.html#setup_properties">setup.properties</a>
+file created, which can be used to rebuild it by deleting all but this
+file from the directory tree and re-run <a
+href="goals.html#turbine_setup">turbine:setup</a>.
</p>
</section>
-<section name="Deploying your application with META">
+<section name="Deploying your application with M.E.T.A.">
<p>
-Application development normally happens in cycles of programming,
-compile and deploy. If you use an external web container, you simply
-deploy your compiled application into its <code>webapp</code>
-directory. However, if you want to use an integrated development
-environment (IDE) like <a href="http://www.eclipse.org">Eclipse</a>,
-then you might want to use its builtin web container for debugging and
-testing.<br/> The META plugin supports both developmen styles (web
-container and IDE) by using two different deployment modes.</p>
-
-<p>Selecting one of the deployment styles and switching between them
-can be done by changing the <code>turbine.app.inplace</code> property.
-</p>
-
-<subsection name="Container deployment">
-<p>
-Container deployment needs a working web container (e.g. <a
-href="http://jakarta.apache.org/tomcat/">Jakarta Tomcat</a>) on your
-local computer. It copies your application code and all turbine
-support files into a web application in the <code>webapp</code>
-subdirectory of your container. All you need to do is the configuration for
-the appserver plugin (which also gives you the power to start and stop
-your container from maven if it is supported. See the <a
+Application development happens in cycles of programming, compile and
+deploy. If you use an external web container, you deploy your compiled
+application into its <code>webapp</code> directory. If you have a
+local web container that you can customize, you might want to develop
+directly in the <code>webapp</code> directory and skip the
+deployment.<br/>
+</p>
+
+<subsection name="Deployment to a web container">
+<p>
+All your application code and Turbine support files are copied into a
+web container which is outside your development tree. You must
+configure the appserver plugin (which also gives you the power to
+start and stop your container from maven. See the <a
href="http://maven.apache.org/reference/plugins/appserver/">appserver
-plugin documentation</a> for more information). On the <a
-href="properties.html">Properties Page</a> is a description of the
-needed appserver properties.<br/> You can choose this mode by setting
-the <code>turbine.app.inplace</code> property to <code>false</code>.
+plugin documentation</a> for more information) and its configuration
+is then used by M.E.T.A. The required appserver properties are listed
+on the <a href="properties.html">Properties Page</a>.
</p>
</subsection>
-<subsection name="Inplace deployment">
+<subsection name="Inplace Development">
<p>
-Inplace deployment means, that you can freely choose the location
-where your application will be deployed to. For an IDE, this will
-probably be a path inside your application source tree so that the IDE
-can pick up the changes you've made and reconfigure its integrated
-container accordingly.<br/>
-To chose this mode, you must set the <code>turbine.app.inplace</code>
-property to <code>true</code> and set the
-<code>turbine.app.inplace.dir</code> to point at your deployment
-directory. The default is <code>src/webapp</code>, so that the
-application tree lies next to the source tree in
-<code>src/java</code>.
+Inplace development allows you to work directly on the files that are
+used by your web container. Your application code and the Turbine
+support files are located in a directory which is accessed by the web
+container.
</p>
</subsection>
</section>
1.1.2.1 +155 -0 jakarta-turbine-2/extensions/maven-plugin/xdocs/Attic/modes.xml
---------------------------------------------------------------------
To unsubscribe, e-mail: turbine-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: turbine-dev-help@jakarta.apache.org