extensions/maven-plugin/xdocs/modes.xml (91 lines of code) (raw):
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you 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>Mode reference</title>
<author email="hps@intermeta.de">Henning P. Schmiedehausen</author>
</properties>
<body>
<section name="M.E.T.A. development modes">
<p>To suit the different styles of Turbine developers, M.E.T.A. allows
you to choose between various directory layouts for your application.
</p>
<p>
The following modes are currently supported:
<ul>
<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 deprecated <a href="http://turbine.apache.org/tdk/">Turbine Development Kit</a>.</li>
</ul>
</p>
<subsection name="Selecting a Development Mode">
<p>
The development mode is selected by providing the <a href="properties.html#turbine_plugin_mode">turbine.plugin.mode</a> property in either
the <a href="config.html#setup_properties">setup.properties</a> file or on the maven command line when using <a href="using_meta.html#Ad_hoc_setup">Ad Hoc setup</a>.
</p>
<source><![CDATA[
Build an inplace development skeleton:
maven -Dturbine.app.name=inplace -Dturbine.plugin.mode=inplace turbine:setup
]]></source>
<p>
The default mode is the <a href="modes.html#normal">Normal</a>
development mode which needs the <a
href="goals.html#turbine_deploy">turbine:deploy</a> target to deploy
the application to a web container.
</p>
</subsection>
</section>
<section name="Development Modes">
<subsection name="normal">
<p>
This is the recommended mode to develop a Turbine application. It
keeps the source files separate from the generated and compiled
files. The development tree conforms to the <a
href="http://maven.apache.org/maven-1.x/reference/dirlayout.html">maven common
directory layout</a>.
</p>
<source><![CDATA[
.
|-- conf
`-- src
|-- images
|-- java
| `-- org
| `-- apache
| `-- turbine
| `-- app
| `-- helloworld
| `-- modules
| |-- actions
| |-- layouts
| |-- navigations
| |-- pages
| `-- screens
|-- pages
|-- resources
|-- schema
|-- scripts
|-- style
|-- templates
| |-- layouts
| |-- macros
| |-- navigations
| `-- screens
`-- test
]]></source>
</subsection>
<subsection name="inplace">
<p>
This mode is suitable when moving from the <a
href="http://turbine.apache.org/tdk/">Turbine Development
Kit</a> to M.E.T.A. or when you can customize your web container to
access your development location. Its tree layout is directly usable
as a web application.
</p>
<p>
An application that has been set up with this mode can be loaded into
an IDE, e.g. <a href="http://www.eclipse.org/">Eclipse</a>. Please
refer to the <a href="ide.html">IDE Reference</a> on how to do this.
</p>
<source><![CDATA[
.
|-- WEB-INF
| |-- conf
| |-- src
| | `-- org
| | `-- apache
| | `-- turbine
| | `-- app
| | `-- helloworld
| | `-- modules
| | |-- actions
| | |-- layouts
| | |-- navigations
| | |-- pages
| | `-- screens
| `-- test
|-- images
|-- pages
|-- resources
|-- scripts
|-- src
| `-- schema
|-- style
`-- templates
|-- layouts
|-- macros
|-- navigations
`-- screens
]]></source>
</subsection>
</section>
</body>
</document>