blob: b57256c7d6eccfe0cc8cc29bf55cadac3489c493 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-->
<document>
<properties>
<title>Properties reference</title>
<author email="hps@intermeta.de">Henning P. Schmiedehausen</author>
</properties>
<body>
<a name="setup_properties"/>
<section name="Setup Properties">
<p>
M.E.T.A. uses two sets of plugin properties to configure your Turbine
application. The first set is called the &quot;Setup Properties&quot;,
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
<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="M.E.T.A. Plugin">
<p>
<table>
<tr>
<th>Property</th>
<th>Optional?</th>
<th>Default value</th>
<th>Description</th>
</tr>
<tr>
<td>turbine.app.name</td>
<td>No</td>
<td><b>no default value</b></td>
<td>Name of the new application. <font color="red">Must be set for <a href="goals.html#turbine_setup">turbine:setup</a>, else the goal fails!</font></td>
</tr>
<tr>
<td>turbine.app.flavor</td>
<td>Yes</td>
<td>turbine-2.3.1</td>
<td>Defines the dependencies and the release version of Turbine that the new application should use. Currently supported versions are:<br/>
<ul>
<li>turbine-2.3</li>
<li>turbine-2.3.1</li>
</ul>
See the <a href="flavors.html">Flavors page</a> for more information.</td>
</tr>
<tr>
<a name="turbine_app_om_layer" />
<td>turbine.app.om.layer</td>
<td>Yes</td>
<td>torque</td>
<td>Defines the OM layer which is configured and used with Turbine to access database information. Currently supported settings are:<br/>
<ul>
<li>none - don't configure an OM layer</li>
<li>torque - configure Torque</li>
</ul>
See the <a href="using_meta.html#OM_Layers">OM Layer Configuration</a> for more information.</td>
</tr>
<tr>
<td>turbine.app.subdir</td>
<td>Yes</td>
<td>true</td>
<td><ul>
<li>true: Create the skeleton for the new application in a subdirectory. Name of the subdirectory is ${turbine.app.name}.</li>
<li>false: Create the skeleton in the current directory.</li>
</ul></td>
</tr>
<tr>
<a name="turbine_app_setup_demo" />
<td>turbine.app.setup.demo</td>
<td>Yes</td>
<td>true</td>
<td>If true, copy the demo images, a default start page and a redirection page into the newly created application. If set to false,
no content files are copied into the new application tree. See also the <a href="using_meta.html#Demo_pages">Demo Pages</a> section.
</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>
<a name="turbine_setup_properties" />
<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>
<subsection name="Other plugins">
<p>
<table>
<tr>
<th>Plugin</th>
<th>Property</th>
<th>Optional?</th>
<th>Default value</th>
<th>Description</th>
</tr>
<tr>
<td>appserver</td>
<td>maven.appserver.name</td>
<td>Yes</td>
<td>tomcat</td>
<td>Type of the application server used for testing and/or deploying of the application</td>
</tr>
<tr>
<td>torque</td>
<td>torque.database</td>
<td>Yes</td>
<td>postgresql</td>
<td>Sets the database type that this application will use</td>
</tr>
<tr>
<td>torque</td>
<td>torque.database.driver</td>
<td>Yes</td>
<td>not set</td>
<td>Set the database driver class</td>
</tr>
<tr>
<td>torque</td>
<td>torque.database.user</td>
<td>Yes</td>
<td>not set</td>
<td>Set the database user for connecting</td>
</tr>
<tr>
<td>torque</td>
<td>torque.database.password</td>
<td>Yes</td>
<td>not set</td>
<td>Set the database password for connecting</td>
</tr>
<tr>
<td>torque</td>
<td>torque.database.buildUrl</td>
<td>Yes</td>
<td>not set</td>
<td>JDBC-URI which can be used for creating tables
and inserting data into the database</td>
</tr>
<tr>
<td>torque</td>
<td>torque.database.createUrl</td>
<td>Yes</td>
<td>not set</td>
<td>JDBC-URI which can be used by the Torque plugin
to connect to the database engine to create the
requested database.</td>
</tr>
</table>
</p>
</subsection>
</section>
<section name="Properties">
<p>
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 M.E.T.A. goals and can be changed to modify
the behaviour of the plugin goals.
</p>
<subsection name="M.E.T.A. Plugin">
<p>
<table>
<tr>
<th>Property</th>
<th>Optional?</th>
<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.plugin.base.dir</td>
<td>Yes</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.pages</td>
<td>Yes</td>
<td>depends on development mode, see <a href="tree.html">Directory tree reference</a></td>
<td>Directory where files that should go into the root of the web application are kept.</td>
</tr>
<tr>
<td>turbine.plugin.src.props</td>
<td>Yes</td>
<td>depends on development mode, see <a href="tree.html">Directory tree reference</a></td>
<td>Directory where files that should go into the WEB-INF/classes directory of the web application 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>
<a name="skip_properties" />
<tr>
<td>turbine.plugin.config.skip</td>
<td>Yes</td>
<td>false</td>
<td>If set to true, the configuration files from the turbine.plugin.src.conf location will be neither deployed nor added to the WAR file.</td>
</tr>
<tr>
<td>turbine.plugin.images.skip</td>
<td>Yes</td>
<td>false</td>
<td>If set to true, the files from the turbine.plugin.src.images location will be neither deployed nor added to the WAR file.</td>
</tr>
<tr>
<td>turbine.plugin.pages.skip</td>
<td>Yes</td>
<td>false</td>
<td>If set to true, the files from the turbine.plugin.src.pages location will be neither deployed nor added to the WAR file.</td>
</tr>
<tr>
<td>turbine.plugin.resources.skip</td>
<td>Yes</td>
<td>false</td>
<td>If set to true, the files from the turbine.plugin.src.resources location will be neither deployed nor added to the WAR file.</td>
</tr>
<tr>
<td>turbine.plugin.scripts.skip</td>
<td>Yes</td>
<td>false</td>
<td>If set to true, the files from the turbine.plugin.src.scripts location will be neither deployed nor added to the WAR file.</td>
</tr>
<tr>
<td>turbine.plugin.style.skip</td>
<td>Yes</td>
<td>false</td>
<td>If set to true, the files from the turbine.plugin.src.style location will be neither deployed nor added to the WAR file.</td>
</tr>
<tr>
<td>turbine.plugin.templates.skip</td>
<td>Yes</td>
<td>false</td>
<td>If set to true, the files from the turbine.plugin.src.templates location will be neither deployed nor added to the WAR file.</td>
</tr>
</table>
</p>
</subsection>
<subsection name="From other plugins">
<p>
<table>
<tr>
<th>Plugin</th>
<th>Property</th>
<th>Optional?</th>
<th>Default value</th>
<th>Description</th>
</tr>
<tr>
<td>appserver</td>
<td>maven.appserver.home</td>
<td>Yes</td>
<td>not set</td>
<td>Defines the root directory of your application server used for
testing and/or deploying of the application if you use a development
mode that needs container deployment.
</td>
</tr>
</table>
</p>
</subsection>
<subsection name="Special Properties">
<p>
<table>
<tr>
<th>Property</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<a name="turbine_target_dir" />
<td>turbine.target.dir</td>
<td>Deployment directory of your application</td>
<td>Available <b>only</b> in <a
href="goals.html#turbine_deploy">turbine:deploy</a> postGoals to allow
custom scripts to copy additional files to the deployment target.</td>
</tr>
</table>
</p>
</subsection>
</section>
</body>
</document>