henning     2004/05/23 03:50:36

  Modified:    extensions/maven-plugin/xdocs Tag: TURBINE_2_3_BRANCH
                        config.xml getting_started.xml goals.xml index.xml
                        installation.xml properties.xml schema.xml tree.xml
                        using_meta.xml
  Log:
  Reworked the documentation, added a few links and clarifications.
  
  Revision  Changes    Path
  No                   revision
  No                   revision
  1.1.2.2   +69 -9     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.1
  retrieving revision 1.1.2.2
  diff -u -r1.1.2.1 -r1.1.2.2
  --- config.xml        21 May 2004 17:07:45 -0000      1.1.2.1
  +++ config.xml        23 May 2004 10:50:36 -0000      1.1.2.2
  @@ -29,13 +29,72 @@
     <p>
     META 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>Using META is no replacement for looking at the Turbine documentation and the
  -  comments in the configuration files!</b>
  +  <b>All configuration files, unless stated explicitly otherwise, get
  +  deleted and recreated if you re-run <code>turbine:setup</code>. So be
  +  careful!</b>
     </p>
   
  +<subsection name="Maven specific configuration files">
  +<p>
  +META 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
  +created with all parameters copied in. An existing setup.properties
  +file is never clobbered!<br/>
  +
  +<table>
  +  <tr>
  +    <th>Name</th>
  +    <th>Function</th>
  +    <th>Description</th>
  +  </tr>
  +  <tr>
  +    <a name="setup_properties"/>
  +    <td>setup.properties</td>
  +    <td>META 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
  +        href="properties.html#setup_properties">Setup Properties</a> for
  +        generating you application skeleton.</td>
  +  </tr>
  +  <tr>
  +    <td>build.properties</td>
  +    <td>Application configuration</td>
  +    <td>This file is intended to customize your application for a specific 
installation.</td>
  +  </tr>
  +    <a name="project_properties"/>
  +  <tr>
  +    <td>project.properties</td>
  +    <td>Application configuration</td>
  +    <td>This file is intended to configure your application. It should contain the 
properties that
  +        are the same for all installations.</td>
  +  </tr>
  +  <tr>
  +    <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
  +        custom goals or callbacks in this file.</td>
  +  </tr>
  +  <tr>
  +    <td>project.xml</td>
  +    <td>Maven POM file</td>
  +    <td>This file contains the maven-specific <a
  +        href="http://maven.apache.org/reference/project-descriptor.html";>Project
  +        descriptor</a>.</td>
  +  </tr>
  +  </table>
  +  </p>
  +  </subsection>
  +
     <subsection name="Application specific configuration files">
     <p>
  -  META generates the following configuration files for your application:
  +  META generates the following configuration files for your
  +  application. These files are located in the <code>conf</code>
  +  subdirectory of the application tree.
   
     <table>
     <tr>
  @@ -143,7 +202,7 @@
     <tr>
       <td>services.VelocityService.velocimacro.library.autoreload</td>
       <td>true</td>
  -    <td>Good for debuggging, bad for production. If your macro files no longer 
change, set this to false.</td>
  +    <td>Good for debugging, bad for production. If your macro files no longer 
change, set this to false.</td>
     </tr>
     <tr>
       <td>services.IntakeService.serialize.path</td>
  @@ -160,8 +219,8 @@
   
     <subsection name="Application-specific properties">
     <p>
  -  All application specific parameters are configured in this file. It gets
  -  merged into <code>TurbineResources.properties</code>
  +  All application specific parameters are configured in &lt;appname&gt;.properties. 
It gets
  +  merged into <code>TurbineResources.properties</code>.
     </p>
   
     <table>
  @@ -195,8 +254,7 @@
     <a href="http://db.apache.org/torque/";>Torque</a> to access databases.<br/>
     In this configuration file, the various datasources are defined. META
     generates a default data source (<code>default</code>) and an application
  -  specific data source (<code>&lt;appname&gt;</code>) which can be accessed
  -  in your application.<br/>
  +  specific data source (<code>&lt;appname&gt;</code>) for you.<br/>
     At setup time, both data sources are mapped onto the same JDBC data provider.
     </p>
   
  @@ -242,7 +300,7 @@
   </tr>
   <tr>
   <td>application.log</td>
  -<td>org.apache.turbine.app.&lt;appname&gt;<br/>
  +<td><a href="properties.html#turbine_app_package">${turbine.app.package}</a><br/>
       Everything else</td>
   <td>Catchall category. Your application logs its messages here</td>
   </tr>
  @@ -265,6 +323,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>
   </section>
   </body>
   </document>
  
  
  
  1.1.2.5   +7 -8      
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.4
  retrieving revision 1.1.2.5
  diff -u -r1.1.2.4 -r1.1.2.5
  --- getting_started.xml       21 May 2004 17:41:54 -0000      1.1.2.4
  +++ getting_started.xml       23 May 2004 10:50:36 -0000      1.1.2.5
  @@ -42,7 +42,7 @@
   
   Please make sure that you do not add the webapp subdirectory to this
   property! <br/>
  -On Windows, you must use the slash (&quot;/&quot;), not the backslash!.
  +On Windows, you must use the slash (&quot;/&quot;), not the backslash for the 
directory pathes!
   </p>
   </subsection>
   
  @@ -56,8 +56,8 @@
   ]]></source>
   
   <p>
  -This should produce some maven output and you end up with a
  -subdirectory to your current directory called
  +This produces some maven output and creates a
  +subdirectory in your current directory called
   &quot;helloworld&quot;. It should have a directory structure like
   this:</p>
   <p><center>
  @@ -73,11 +73,10 @@
   maven turbine:deploy
   ]]></source>
   
  -Now do the necessary steps that your web container requires to reload
  -an application in its webapp directory. Point your browser to the
  -application (if you use Tomcat running on your local machine, this
  -would be http://localhost:8080/helloworld/app/). It should look like
  -this:</p>
  +Restart your web comtainer or force it to reload its applications.<br/>
  +Point your browser to the deployed application (if you use Tomcat
  +running on your local machine, this would be
  +http://localhost:8080/helloworld/app/). It should look like this:</p>
   
   <p><center>
   <img src="images/helloworld.png" width="722" height="525"/><br/>
  
  
  
  1.2.2.3   +2 -2      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.2
  retrieving revision 1.2.2.3
  diff -u -r1.2.2.2 -r1.2.2.3
  --- goals.xml 21 May 2004 17:07:45 -0000      1.2.2.2
  +++ goals.xml 23 May 2004 10:50:36 -0000      1.2.2.3
  @@ -13,7 +13,7 @@
       <goals>
         <goal>
           <name>turbine:setup</name>
  -        <description>Setup a new Turbine web application</description>
  +        <description><a 
href="using_meta.html#Setting_up_your_application_for_the_first_time">Setup a new 
Turbine web application</a></description>
         </goal>
         <goal>
           <name>turbine:deploy</name>
  @@ -72,7 +72,7 @@
           <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
  +other torque goal, this preGoal ensures that all torque goals work on
   the latest schema file versions.
           </description>
         </goal>
  
  
  
  1.2.2.3   +19 -16    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.2
  retrieving revision 1.2.2.3
  diff -u -r1.2.2.2 -r1.2.2.3
  --- index.xml 21 May 2004 17:07:45 -0000      1.2.2.2
  +++ index.xml 23 May 2004 10:50:36 -0000      1.2.2.3
  @@ -27,10 +27,9 @@
   <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
  +start writing applications based on the Turbine Webapplication
   framework and also a collection of &quot;best practices&quot; and
  -configuration information to get you started with writing code using
  -the Turbine framework.
  +configuration information.
   </p>
   </section>
   
  @@ -39,13 +38,14 @@
   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.
  +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 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.
  +maven command) or with a special properties file that is read by META
  +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">
  @@ -56,20 +56,23 @@
   <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:&lt;xxx&gt; proved confusing in the Maven context (is meta:&lt;xxx&gt; a
  -maven meta-task or is it part of the META environment?). So the META
  -environment uses the "turbine:" prefix.<br/>
  -
  +environment. While &quot;META&quot; is distinctive in the Turbine
  +context, using meta:&lt;xxx&gt; proved confusing in the Maven context
  +(is meta:&lt;xxx&gt; a maven meta-goal or is it part of the META
  +environment?). So the META 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 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.
  +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.
   <br/>
   As META tries to integrate with the maven web application environment
   as seamlessly as possible, it requires a few properties from other
  
  
  
  1.1.2.2   +20 -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.1
  retrieving revision 1.1.2.2
  diff -u -r1.1.2.1 -r1.1.2.2
  --- installation.xml  21 May 2004 17:07:45 -0000      1.1.2.1
  +++ installation.xml  23 May 2004 10:50:36 -0000      1.1.2.2
  @@ -29,20 +29,19 @@
   <subsection name="Installing Maven">
   <p>
   If you want to use META, you need <a
  -href="http://maven.apache.org/";>maven</a>.  A problem with maven is,
  -that there is still no real release and many things are in a constant
  -state of flux.</p>
  -
  -<p>From the <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
   href="http://maven.apache.org/start/download.html";>maven download
  -site</a> you can get maven 1.0-RC3 which proved to be working with the
  -META plugin. You can either get a binary or a source distribution.</p>
  +site</a>, which proved to be working with the META plugin. You can
  +either get a binary or a source distribution.
  +</p>
   
   </subsection>
   
   <subsection name="Installing the Torque and META plugins">
   <p>
  -If you have maven running, get these plugins through the following links.
  +After you've installed maven, get these plugins through the following links.
   </p>
   <table>
   <tr>
  @@ -53,15 +52,22 @@
   </tr>
   </table>
   <p>
  -If you already have the Torque plugin, make sure that you have the
  -Plugin from the Torque 3.1 Branch installed. META does not work yet
  -with the 3.2 development branch.
  +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.
   </p>
   
   <p>
  -Now copy the two plugins into your plugins folder (which is located in
  -your MAVEN_HOME directory). After doing so, run maven -g and check
  -whether the following targets are displayed in the goal list:
  +Now copy the two plugins into your local plugin directory, which is
  +either referenced by MAVEN_HOME_LOCAL/plugins or the global plugins
  +directory at MAVEN_HOME/plugins. Which one to use depends on your
  +maven installation. You find some documentation on how to do this <a
  +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
  +targets are displayed in the goal list:
   </p>
   
   <source><![CDATA[
  
  
  
  1.2.2.3   +58 -43    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.2
  retrieving revision 1.2.2.3
  diff -u -r1.2.2.2 -r1.2.2.3
  --- properties.xml    21 May 2004 17:07:45 -0000      1.2.2.2
  +++ properties.xml    23 May 2004 10:50:36 -0000      1.2.2.3
  @@ -6,7 +6,8 @@
       <author email="[EMAIL PROTECTED]">Henning P. Schmiedehausen</author>
     </properties>
     <body>
  -<section name="Setup Properties from the META plugin">
  +<a name="setup_properties"/>
  +<section name="Setup Properties">
       <p>
   META uses two sets of plugin properties to configure your Turbine
   application. The first set is called the &quot;Setup Properties&quot;,
  @@ -19,6 +20,7 @@
   configuration files, so be careful!).
   </p>
   
  +<subsection name="META Plugin">
     <p>
     <table>
       <tr>
  @@ -32,43 +34,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 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>
  +<td>Name of the new application.<font color="red">Must be set for turbine:setup, 
else the goal fails!</font></td>
   </tr>
   
   <tr>
  @@ -83,9 +49,9 @@
   
     </table>
   </p>
  -</section>
  +</subsection>
   
  -<section name="Setup Properties from other plugins">
  +<subsection name="Other plugins">
     <p>
     <table>
       <tr>
  @@ -156,9 +122,19 @@
   </tr>
     </table>
     </p>
  +</subsection>
   </section>
   
  -<section name="Properties from the META plugin">
  +<section name="Properties">
  +    <p>
  +These properties are used at setup time and get copied into the META
  +generated <a
  +href="config.html#project_properties">project.properties</a>
  +file. They're used by various META goals and can be changed to modify
  +the behaviour of the plugin goals.
  +</p>
  +
  +<subsection name="META Plugin">
     <p>
     <table>
       <tr>
  @@ -167,6 +143,44 @@
         <th>Default value</th>
         <th>Description</th>
       </tr>
  +
  +<a name="turbine_app_package"/>
  +<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.inplace</td>
   <td>Yes</td>
  @@ -188,9 +202,9 @@
   </tr>
     </table>
     </p>
  -</section>
  +</subsection>
   
  -<section name="Properties from other plugins">
  +<subsection name="From other plugins">
     <p>
     <table>
       <tr>
  @@ -212,6 +226,7 @@
   </tr>
     </table>
     </p>
  +</subsection>
   </section>
   </body>
   </document>
  
  
  
  1.1.2.2   +7 -6      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.1
  retrieving revision 1.1.2.2
  diff -u -r1.1.2.1 -r1.1.2.2
  --- schema.xml        21 May 2004 17:07:45 -0000      1.1.2.1
  +++ schema.xml        23 May 2004 10:50:36 -0000      1.1.2.2
  @@ -32,13 +32,14 @@
     databases. META 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 <code>src/schema</code>, their result is
  -  put into the <code>target/sql</code> directory.</p>
  +  schema files are located in <a
  +  href="tree.html#src_schema"><code>src/schema</code></a>, 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
  -  to access a database, you put your table definitions and data values
  +  to access a database, put your table definitions and data values
     into these files.
     <table>
     <tr>
  @@ -59,13 +60,13 @@
       <td>Torque allows you to describe data for your custom tables in
          an XML file and load it into the database using the
          <code>torque:datasql</code> and <code>torque:insert-sql</code>
  -       tasks. The syntax of this file is described in the &lt;appname&gt;-data.dtd
  +       goals. The syntax of this file is described in the &lt;appname&gt;-data.dtd
          file and changes whenever your table definition file changes.</td>
     </tr>
     <tr>
       <td>&lt;appname&gt;-data.dtdp</td>
       <td>Data Type Definition for your custom tables</td>
  -    <td>If you want to use the data loading tasks of torque, you must describe
  +    <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
  @@ -81,7 +82,7 @@
     <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> task, SQL for this table is generated. There are no 
peer and object classes
  +  the <code>turbine:sql</code> goal, SQL for this table is generated. There are no 
peer and object classes
     for the id table.</p>
     </subsection>
   
  
  
  
  1.1.2.2   +1 -1      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.1
  retrieving revision 1.1.2.2
  diff -u -r1.1.2.1 -r1.1.2.2
  --- tree.xml  21 May 2004 17:07:45 -0000      1.1.2.1
  +++ tree.xml  23 May 2004 10:50:36 -0000      1.1.2.2
  @@ -27,7 +27,7 @@
     <section name="Development tree">
     <p>
   The development tree is prebuilt by the META plugin and conforms to the
  -maven layout rules.</p>
  +<a href="http://maven.apache.org/reference/dirlayout.html";>maven common directory 
layout</a>.</p>
   
     <table>
       <tr>
  
  
  
  1.1.2.2   +33 -29    
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.1
  retrieving revision 1.1.2.2
  diff -u -r1.1.2.1 -r1.1.2.2
  --- using_meta.xml    21 May 2004 17:07:45 -0000      1.1.2.1
  +++ using_meta.xml    23 May 2004 10:50:36 -0000      1.1.2.2
  @@ -29,14 +29,17 @@
   <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 in this plugin.<br/>
  -<code>turbine:setup</code> creates the application skeleton of your new application.
  -<code>turbine:deploy</code> installs an application into your web container.</p>
  +learned about two of the goals that the META plugin provides:<br/>
  +<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>
  +</ul>
  +</p>
   
   <p>
   The goals of the META plugin interact with many other goals from maven
   to create your build environment. As the function of some is not
  -really intuitive, this how the plugin is intended to be used.</p>
  +really intuitive, this is how the plugin is intended to be used:</p>
   <p>
   <source><![CDATA[
   Development cycle for java code
  @@ -114,7 +117,7 @@
   </p>
   </section>
   
  -<section name="Setting your application up for the first time">
  +<section name="Setting up your application for the first time">
   
   <subsection name="Ad hoc setup">
   <p>
  @@ -123,7 +126,7 @@
   know that setting up a new Turbine-based application is just a single
   maven command away. We will refer to this as &quot;ad hoc&quot; setup,
   because you don't need to prepare anything before running the
  -turbine:setup goal.
  +<code>turbine:setup</code> goal.
   </p>
   
   <p>
  @@ -139,7 +142,7 @@
   
   <p>
   Note: In the subdirectory which contains your application skeleton,
  -there will be a META properties file, called setup.properties. This is
  +there will be a META properties file, called <code>setup.properties</code>. This is
   auto-generated by the plugin to make your setup reproducible.
   </p>
   </subsection>
  @@ -148,20 +151,21 @@
   <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
  -<code>setup.properties</code> and must be in the directory where you
  -will run the turbine:setup goal. Inside this setup.properties file you
  +<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 &quot;Setup
  -Properties&quot; are used. So changing the setup.properties file after
  -running the turbine:setup goal won't do any changes to your
  -application unless you rerun the turbine:setup goal.
  +Properties&quot; 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.
   </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 setup.properties from the directory and
  +can delete all files but the <code>setup.properties</code> from the directory and
   rerun <code>turbine:setup</code>.
   </p>
   
  @@ -169,28 +173,28 @@
   
   <section name="Deploying your application with META">
   <p>
  -Development normally happens in cycles of development, compile and
  -deploy. If you use an external web container with its own webapp
  -directory, then you're fine. 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>
  +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 in the <code>setup.properties</code> to define the initial
  -mode before running the <code>turbine:setup</code> goal or in the
  -<code>project.properties</code> file after running the setup.
  +can be done by changing the <code>turbine.app.inplace</code> property.
   </p>
   
   <subsection name="Container deployment">
   <p>
  -This is the simpler deployment mode. 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 is the
  -configuration for the appserver plugin (which also gives you the power
  -to start and stop your container from maven. See the <a
  +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
   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
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to