extensions/maven-plugin/xdocs/installation.xml - turbine-core - Git at Google

 <?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>Installation</title>
     <author email="hps@intermeta.de">Henning P. Schmiedehausen</author>
   </properties>

   <body>
 <section name="Installation">

 <subsection name="Installing Maven">
 <p>
 If you want to use M.E.T.A., you need <a
 href="http://maven.apache.org/">maven</a> 1.0 (maven 2 is not currently supported).
 You can either get a binary or a source distribution from the Maven site.
 </p>

 </subsection>

 <subsection name="Installing the M.E.T.A. plugin">

 <p>
 After installing Maven, you can use the following maven command to download and install the plugin in one go:
 <source><![CDATA[
 maven -DartifactId=maven-turbine-plugin -DgroupId=turbine -Dversion=1.3 plugin:download
 ]]></source>
 </p>

 <p>
 Installing the plugin through the <code>plugin:download</code> is the preferred to go.
 Alternatively, you can get it from the <a href="http://turbine.apache.org/download.html">Turbine download page</a>.
 </p>

 <table>
 <tr>
   <td><a href="http://www.apache.org/dist/java-repository/turbine/plugins/maven-turbine-plugin-1.3.jar">M.E.T.A. Plugin (Version 1.3)</a></td>
 </tr>
 </table>

 <p>
 To install it manually, you copy this jar file 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/maven-1.x/start/install.html">on the
 maven install page</a>.
 </p>


 <p>
 After the installation, run <code>maven -g</code> and check whether the following
 targets are displayed in the goal list:
 </p>

 <source><![CDATA[
 [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
   war  ............................ Generate a Turbine based Web application (
                                     war)
 ]]></source>

 <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>

 </section>
 </body>
 </document>
	<?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>Installation</title>
	<author email="hps@intermeta.de">Henning P. Schmiedehausen</author>
	</properties>

	<body>
	<section name="Installation">

	<subsection name="Installing Maven">
	<p>
	If you want to use M.E.T.A., you need <a
	href="http://maven.apache.org/">maven</a> 1.0 (maven 2 is not currently supported).
	You can either get a binary or a source distribution from the Maven site.
	</p>

	</subsection>

	<subsection name="Installing the M.E.T.A. plugin">

	<p>
	After installing Maven, you can use the following maven command to download and install the plugin in one go:
	<source><![CDATA[
	maven -DartifactId=maven-turbine-plugin -DgroupId=turbine -Dversion=1.3 plugin:download
	]]></source>
	</p>

	<p>
	Installing the plugin through the <code>plugin:download</code> is the preferred to go.
	Alternatively, you can get it from the <a href="http://turbine.apache.org/download.html">Turbine download page</a>.
	</p>

	<table>
	<tr>
	<td><a href="http://www.apache.org/dist/java-repository/turbine/plugins/maven-turbine-plugin-1.3.jar">M.E.T.A. Plugin (Version 1.3)</a></td>
	</tr>
	</table>

	<p>
	To install it manually, you copy this jar file 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/maven-1.x/start/install.html">on the
	maven install page</a>.
	</p>


	<p>
	After the installation, run <code>maven -g</code> and check whether the following
	targets are displayed in the goal list:
	</p>

	<source><![CDATA[
	[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
	war ............................ Generate a Turbine based Web application (
	war)
	]]></source>

	<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>

	</section>
	</body>
	</document>