blob: 93e6d5a4ef5d8d48ceed09f4563507449efb9369 [file] [log] [blame]
<?xml version="1.0"?>
<!--
/*
* 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 xmlns="http://maven.apache.org/XDOC/2.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
<properties>
<title>Introduction</title>
<author>Vincent Siveton</author>
<author email="hboutemy_AT_apache_DOT_org">Hervé Boutemy</author>
</properties>
<body>
<section name="Maven Plugin Tools">
<p>The Maven Plugin Tools contains the necessary tools to generate rebarbative content like descriptor,
help and documentation. In addition, it provides tools to write Maven Plugins in scripting languages
like Ant or Beanshell.</p>
<p>
<img src="images/plugin-tools-deps.png" width="826" height="491" border="0" usemap="#PluginTools_dependencies" />
<map name="PluginTools_dependencies">
<area shape="rect" coords="279,0,508,38" alt="maven-plugin-plugin" href="./maven-plugin-plugin" />
<area shape="rect" coords="31,101,223,138" alt="plugin-tools-api" href="./maven-plugin-tools-api"/>
<area shape="rect" coords="62,163,251,200" alt="plugin-tools-java" href="./maven-plugin-tools-java"/>
<area shape="rect" coords="312,163,539,200" alt="plugin-tools-javadoc" href="./maven-plugin-tools-javadoc"/>
<area shape="rect" coords="61,225,319,262" alt="plugin-tools-annotations" href="./maven-plugin-tools-annotations"/>
<area shape="rect" coords="339,225,539,262" alt="plugin-annotations" href="./maven-plugin-annotations"/>
<area shape="rect" coords="61,286,320,324" alt="plugin-tools-beanshell" href="./maven-plugin-tools-beanshell"/>
<area shape="rect" coords="348,286,605,324" alt="maven-script-beanshell" href="./maven-script/maven-script-beanshell"/>
<area shape="rect" coords="61,348,244,386" alt="plugin-tools-ant" href="./maven-plugin-tools-ant"/>
<area shape="rect" coords="423,348,605,386" alt="maven-script-ant" href="./maven-script/maven-script-ant"/>
<area shape="rect" coords="339,277,623,421" alt="maven-script" href="./maven-script"/>
<area shape="rect" coords="43,410,261,447" alt="plugin-tools-model" href="./maven-plugin-tools-model"/>
<area shape="rect" coords="538,101,804,139" alt="plugin-tools-generators" href="./maven-plugin-tools-generators"/>
<area shape="rect" coords="380,454,584,490" alt="maven-plugin-api" href="/ref/current/maven-plugin-api/"/>
<area shape="rect" coords="556,163,633,200" alt="qdox" href="http://qdox.codehaus.org/"/>
<area shape="rect" coords="555,225,634,262" alt="asm" href="http://asm.ow2.org/"/>
<area shape="rect" coords="657,142,825,178" alt="Doxia" href="/doxia/"/>
<area shape="rect" coords="657,181,825,218" alt="plexus-velocity" href="http://plexus.codehaus.org/plexus-components/plexus-velocity/"/>
<area shape="rect" coords="652,287,777,324" alt="beanshell" href="http://www.beanshell.org/"/>
<area shape="rect" coords="651,348,730,386" alt="ant" href="http://ant.apache.maven/"/>
</map>
</p>
<table>
<tr><th><b>Module</b></th><th><b>Overview</b></th></tr>
<tr>
<td><b><a href="./maven-plugin-plugin/index.html">maven-plugin-plugin</a></b></td>
<td>Create a Maven plugin descriptor for any mojos found in the source tree, generate reports, create help goal.</td>
</tr>
<tr>
<td><a href="./maven-plugin-tools-generators/index.html">maven-plugin-tools-generators</a></td>
<td>Generators (XML descriptor, help, documentation), used by maven-plugin-plugin to generate content from descriptor extracted from sources.</td>
</tr>
<tr>
<td><a href="./maven-plugin-tools-api/index.html">maven-plugin-tools-api</a></td>
<td>Descriptor extractor API, used by maven-plugin-plugin to extract Plugin information.</td>
</tr>
<tr>
<td>&nbsp;&nbsp;<a href="./maven-plugin-tools-java/index.html">maven-plugin-tools-java</a></td>
<td>Descriptor extractor for plugins written in Java annotated with Mojo Javadoc Tags.</td>
</tr>
<tr>
<td>&nbsp;&nbsp;&nbsp;&nbsp;<a href="./maven-plugin-tools-javadoc/index.html">maven-plugin-tools-javadoc</a></td>
<td>Provides doclets to support Mojo Javadoc Tags in the Javadoc Tool.</td>
</tr>
<tr>
<td>&nbsp;&nbsp;<a href="./maven-plugin-tools-annotations/index.html">maven-plugin-tools-annotations</a></td>
<td>Descriptor extractor for plugins written in Java with Java 5 annotations.</td>
</tr>
<tr>
<td>&nbsp;&nbsp;&nbsp;&nbsp;<a href="./maven-plugin-annotations/index.html">maven-plugin-annotations</a></td>
<td>Provides the Java 5 annotations to use in Mojos.</td>
</tr>
<tr>
<td>&nbsp;&nbsp;<a href="./maven-plugin-tools-beanshell/index.html">maven-plugin-tools-beanshell</a></td>
<td>Descriptor extractor for plugins written in Beanshell.</td>
</tr>
<tr>
<td>&nbsp;&nbsp;<a href="./maven-plugin-tools-ant/index.html">maven-plugin-tools-ant</a></td>
<td>Descriptor extractor for plugins written in Ant.</td>
</tr>
<tr>
<td><a href="./maven-plugin-tools-model/index.html">maven-plugin-tools-model</a></td>
<td>API to play with the Maven Plugin Metadata Model for script-based plugins.</td>
</tr>
<tr>
<td><a href="./maven-script/index.html">maven-script</a></td>
<td>Maven Script Mojo Support lets developer write Maven plugins/goals with scripting languages instead of compiled Java.</td>
</tr>
<tr>
<td>&nbsp;&nbsp;<a href="./maven-script/maven-script-beanshell/index.html">maven-script-beanshell</a></td>
<td>Maven Beanshell Mojo Support, ie write Maven plugins with Beanshell scripts.</td>
</tr>
<tr>
<td>&nbsp;&nbsp;<a href="./maven-script/maven-script-ant/index.html">maven-script-ant</a></td>
<td>Maven Ant Mojo Support, ie write Maven plugins with Ant script.</td>
</tr>
</table>
<subsection name="See Also">
<ul>
<li><a href="/plugin-testing/">Maven Plugin Testing</a></li>
<li><a href="/ref/current/maven-plugin-api/">Maven Plugin API</a></li>
</ul>
</subsection>
</section>
</body>
</document>