maven-archetype/maven-archetype-plugin/src/site/apt/index.apt

 ------
 Introduction
 ------
 Franz Allan Valencia See
 ------
 17 July 2006
 ------

~~ Copyright 2006 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.

~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/guides/mini/guide-apt-format.html

Maven 2 Archetype Plugin

 The Archetype Plugin allows the user to build archetype containers. These 
 archetype containers contains the pom, default source, test, resources,
 test-resources, and site-resources files in a specific directory structure. The 
 content of the pom, the default files, and the directory structure depends on 
 the what archetype container was built. 
 
 Upon writing this documentation, there are ten (10) available archetype 
 containers provided by maven These are:
 
   * <<<maven-archetype-archetype>>>
   
   * <<<maven-archetype-j2ee-simple>>>
   
   * <<<maven-archetype-mojo>>>
   
   * <<<maven-archetype-portlet>>>
   
   * <<<maven-archetype-profiles>>> (<currently under development>)
   
   * <<<maven-archetype-quickstart>>>
   
   * <<<maven-archetype-simple>>> (<currently under development>)
   
   * <<<maven-archetype-site>>>
   
   * <<<maven-archetype-site-simple>>>, and 
   
   * <<<maven-archetype-webapp>>>

* Goals Overview

   The Archetype Plugin has two goals:

   * {{{create-mojo.html}archetype:create}} looks for an achetype with a given 
     <<<groupId>>>, <<<artifactId>>>, and <<<version>>> and retrieves it from 
     the remote repository. Once the archetype is retrieved, it is then 
     processed against a set of user parameters to create a working Maven 
     project.

   * {{{create-from-project-mojo.html}archetype:create-from-project}} creates an
     archetype from an existing Maven projecct.

* Usage

   Instructions on how to use the Archetype Plugin can be found 
   {{{usage.html}here}}.

* Examples

   The following examples show how to use the Archetype Plugin in more advanced 
   usecases:

   * {{{examples/remote-repositories.html}Specifying the Remote Repositories}}

   * {{{examples/simple.html}Creating a Simple Java Application}}

   * {{{examples/site.html}Creating a Site}}

   * {{{examples/j2ee-simple.html}Creating a Simple J2ee Project}}

   * {{{examples/webapp.html}Creating a Webapp}}

   * {{{examples/portlet.html}Creating a Portlet}}

   * {{{examples/mojo.html}Creating a Mojo}}

   * {{{examples/archetype.html}Creating your own Archetype}}