You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by bu...@apache.org on 2012/12/10 09:17:44 UTC
svn commit: r841370 [38/47] - in /websites/staging/maven/trunk/content: ./
ant/ background/ css/ developers/ developers/conventions/
developers/release/ developers/website/ docs/ docs/2.0.1/ docs/2.0.10/
docs/2.0.11/ docs/2.0.2/ docs/2.0.3/ docs/2.0.4/...
Added: websites/staging/maven/trunk/content/plugin-developers/cookbook/generate-assembly.html
==============================================================================
--- websites/staging/maven/trunk/content/plugin-developers/cookbook/generate-assembly.html (added)
+++ websites/staging/maven/trunk/content/plugin-developers/cookbook/generate-assembly.html Mon Dec 10 08:17:24 2012
@@ -0,0 +1,311 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+ | Generated by Apache Maven Doxia at Dec 10, 2012
+ | Rendered using Apache Maven Stylus Skin 1.5
+-->
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Maven - Cookbook - How To Generate Assembly</title>
+ <style type="text/css" media="all">
+ @import url("../../css/maven-base.css");
+ @import url("../../css/maven-theme.css");
+ @import url("../../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" />
+ <meta name="author" content="Vincent Siveton" />
+ <meta name="Date-Revision-yyyymmdd" content="20121210" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+
+<script type="text/javascript">_uacct = "UA-140879-1";
+ urchinTracker();</script>
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../.././" id="bannerLeft">
+ <img src="../../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <span id="bannerRight">
+ <img src="../../images/maven-logo-2.gif" alt="" />
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../index.html">Maven</a>
+ >
+ Cookbook - How To Generate Assembly
+ </div>
+ <div class="xright">
+ Last Published: 2012-12-10
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+ <h5>Main</h5>
+ <ul>
+ <li class="none">
+ <a href="../../index.html">Welcome</a>
+ </li>
+ </ul>
+ <h5>Get Maven</h5>
+ <ul>
+ <li class="none">
+ <a href="../../download.html">Download</a>
+ </li>
+ <li class="none">
+ <a href="../../docs/3.0.4/release-notes.html">Release Notes (3.0.4)</a>
+ </li>
+ <li class="none">
+ <a href="../../docs/2.2.1/release-notes.html">Release Notes (2.2.1)</a>
+ </li>
+ <li class="none">
+ <a href="../../docs/2.0.11/release-notes.html">Release Notes (2.0.11)</a>
+ </li>
+ <li class="none">
+ <a href="../../license.html">License</a>
+ </li>
+ </ul>
+ <h5>IDE Integration</h5>
+ <ul>
+ <li class="none">
+ <a href="../../eclipse-plugin.html">Eclipse</a>
+ </li>
+ <li class="none">
+ <a href="../../netbeans-module.html">NetBeans</a>
+ </li>
+ </ul>
+ <h5>About Maven</h5>
+ <ul>
+ <li class="none">
+ <a href="../../what-is-maven.html">What is Maven?</a>
+ </li>
+ <li class="none">
+ <a href="../../maven-features.html">Features</a>
+ </li>
+ <li class="none">
+ <a href="../../general.html">FAQ (official)</a>
+ </li>
+ <li class="none">
+ <a href="http://docs.codehaus.org/display/MAVENUSER/FAQs-1" class="externalLink">FAQ (unofficial)</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+ <li class="none">
+ <a href="../../plugins/index.html">Maven Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../guides/index.html">Index (category)</a>
+ </li>
+ <li class="none">
+ <a href="../../run-maven/index.html">Running Maven</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../users/index.html">User Centre</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../plugin-developers/index.html">Plugin Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="../../repository/index.html">Maven Repository Centre</a>
+ </li>
+ <li class="none">
+ <a href="../../developers/index.html">Maven Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="../../articles.html">Books and Resources</a>
+ </li>
+ <li class="none">
+ <a href="http://docs.codehaus.org/display/MAVENUSER/Home" class="externalLink">Wiki</a>
+ </li>
+ </ul>
+ <h5>Community</h5>
+ <ul>
+ <li class="none">
+ <a href="../../community.html">Community Overview</a>
+ </li>
+ <li class="none">
+ <a href="../../guides/development/guide-helping.html">How to Contribute</a>
+ </li>
+ <li class="none">
+ <a href="../../guides/mini/guide-maven-evangelism.html">Maven Repository</a>
+ </li>
+ <li class="none">
+ <a href="../../users/getting-help.html">Getting Help</a>
+ </li>
+ <li class="none">
+ <a href="../../issue-tracking.html">Issue Tracking</a>
+ </li>
+ <li class="none">
+ <a href="../../source-repository.html">Source Repository</a>
+ </li>
+ <li class="none">
+ <a href="../../team-list.html">The Maven Team</a>
+ </li>
+ </ul>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../../project-info.html">Project Information</a>
+ </li>
+ </ul>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../../doxia/index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Maven 2 & 3</a>
+ </li>
+ <li class="none">
+ <a href="../../pom/index.html">Parent POMs</a>
+ </li>
+ <li class="none">
+ <a href="../../plugins/index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../plugin-tools/index.html">Plugin Tools</a>
+ </li>
+ <li class="none">
+ <a href="../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../skins/index.html">Skins</a>
+ </li>
+ <li class="none">
+ <a href="../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../wagon/index.html">Wagon</a>
+ </li>
+ </ul>
+ <h5>ASF</h5>
+ <ul>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../../images/logos/maven-feather.png"/>
+ </a>
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <div class="section"><h2>Cookbook: How To Generate Assembly?<a name="Cookbook:_How_To_Generate_Assembly"></a></h2><div class="section"><h3>Summary<a name="Summary"></a></h3><p>This recipe describes how to generate assembly like zip, tar.gz or tar.bz2.</p></div><div class="section"><h3>Prerequisite Plugins<a name="Prerequisite_Plugins"></a></h3><p>Here is the list of the plugins used:</p><table border="1" class="bodyTable"><tr class="a"><th align="left"><b>Plugin</b></th><th align="left"><b>Version</b></th></tr><tr class="b"><td align="left"><a href="../../plugins/maven-assembly-plugin/"> <tt>assembly</tt></a></td><td align="left">2.2-beta-1</td></tr></table></div><div class="section"><h3>Sample Generated Output<a name="Sample_Generated_Output"></a></h3><div class="source"><pre>
+attach-source-javadoc
+|-- pom.xml
+|-- src\
+`-- target
+ `-- apache-maven-cookbook-1.0-SNAPSHOT-bin
+ `-- apache-maven-cookbook-1.0-SNAPSHOT-bin.tar.bz2
+ `-- apache-maven-cookbook-1.0-SNAPSHOT-bin.tar.gz
+ `-- apache-maven-cookbook-1.0-SNAPSHOT-bin.zip
+</pre></div></div><div class="section"><h3>Recipe<a name="Recipe"></a></h3><div class="section"><h4>Configuring Assembly Descriptor<a name="Configuring_Assembly_Descriptor"></a></h4><p>To generate an assembly, we need to configure an assembly descriptor called <tt>bin.xml</tt> in the <tt>src/assembly</tt> directory. Firstly, we specify the wanted formats, i.e.</p><div class="source"><pre><formats>
+ <format>tar.gz</format>
+ <format>tar.bz2</format>
+ <format>zip</format>
+</formats>
+</pre></div><p>And the wanted files sets, i.e.</p><div class="source"><pre><fileSets>
+ <fileSet>
+ <includes>
+ <include>README*</include>
+ </includes>
+ </fileSet>
+ <fileSet>
+ <directory>src/bin</directory>
+ <outputDirectory>bin</outputDirectory>
+ <includes>
+ <include>*.bat</include>
+ </includes>
+ <lineEnding>dos</lineEnding>
+ </fileSet>
+ <fileSet>
+ <directory>src/bin</directory>
+ <outputDirectory>bin</outputDirectory>
+ <includes>
+ <include>hello</include>
+ </includes>
+ <lineEnding>unix</lineEnding>
+ <fileMode>0755</fileMode>
+ </fileSet>
+ <fileSet>
+ <directory>target</directory>
+ <outputDirectory>lib</outputDirectory>
+ <includes>
+ <include>generate-assembly-*.jar</include>
+ </includes>
+ </fileSet>
+</fileSets>
+</pre></div></div><div class="section"><h4>Configuring Maven Assembly Plugin<a name="Configuring_Maven_Assembly_Plugin"></a></h4><p>We execute the <tt><a href="../../plugins/maven-assembly-plugin/single-mojo.html">assembly:single</a></tt> goal from the Assembly plugin during the <tt>package</tt> phase.</p><div class="source"><pre><plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-assembly-plugin</artifactId>
+ <configuration>
+ <descriptor>src/assembly/bin.xml</descriptor>
+ <finalName>apache-maven-cookbook-${pom.version}</finalName>
+ </configuration>
+ <executions>
+ <execution>
+ <phase>package</phase>
+ <goals>
+ <goal>single</goal>
+ </goals>
+ </execution>
+ </executions>
+</plugin>
+</pre></div></div><div class="section"><h4>Running Maven<a name="Running_Maven"></a></h4><p>Just call Maven to generate the packages:</p><div class="source"><pre>mvn package</pre></div></div></div><div class="section"><h3>Resources<a name="Resources"></a></h3><ul><li>Source code: <a class="externalLink" href="http://svn.apache.org/repos/asf/maven/sandbox/trunk/site/cookbook/generate-assembly">http://svn.apache.org/repos/asf/maven/sandbox/trunk/site/cookbook/generate-assembly</a></li><li><a href="../../plugins/maven-assembly-plugin/">Maven Assembly Plugin </a></li></ul></div></div>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">
+ © 2002-2012
+ The Apache Software Foundation
+
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Added: websites/staging/maven/trunk/content/plugin-developers/cookbook/index.html
==============================================================================
--- websites/staging/maven/trunk/content/plugin-developers/cookbook/index.html (added)
+++ websites/staging/maven/trunk/content/plugin-developers/cookbook/index.html Mon Dec 10 08:17:24 2012
@@ -0,0 +1,252 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+ | Generated by Apache Maven Doxia at Dec 10, 2012
+ | Rendered using Apache Maven Stylus Skin 1.5
+-->
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Maven - Plugins Cookbook</title>
+ <style type="text/css" media="all">
+ @import url("../../css/maven-base.css");
+ @import url("../../css/maven-theme.css");
+ @import url("../../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" />
+ <meta name="author" content="Brett Porter
+Vincent Siveton" />
+ <meta name="Date-Creation-yyyymmdd" content="20090802" />
+ <meta name="Date-Revision-yyyymmdd" content="20121210" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+
+<script type="text/javascript">_uacct = "UA-140879-1";
+ urchinTracker();</script>
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../.././" id="bannerLeft">
+ <img src="../../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <span id="bannerRight">
+ <img src="../../images/maven-logo-2.gif" alt="" />
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../index.html">Maven</a>
+ >
+ Plugins Cookbook
+ </div>
+ <div class="xright">
+ Last Published: 2012-12-10
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+ <h5>Main</h5>
+ <ul>
+ <li class="none">
+ <a href="../../index.html">Welcome</a>
+ </li>
+ </ul>
+ <h5>Get Maven</h5>
+ <ul>
+ <li class="none">
+ <a href="../../download.html">Download</a>
+ </li>
+ <li class="none">
+ <a href="../../docs/3.0.4/release-notes.html">Release Notes (3.0.4)</a>
+ </li>
+ <li class="none">
+ <a href="../../docs/2.2.1/release-notes.html">Release Notes (2.2.1)</a>
+ </li>
+ <li class="none">
+ <a href="../../docs/2.0.11/release-notes.html">Release Notes (2.0.11)</a>
+ </li>
+ <li class="none">
+ <a href="../../license.html">License</a>
+ </li>
+ </ul>
+ <h5>IDE Integration</h5>
+ <ul>
+ <li class="none">
+ <a href="../../eclipse-plugin.html">Eclipse</a>
+ </li>
+ <li class="none">
+ <a href="../../netbeans-module.html">NetBeans</a>
+ </li>
+ </ul>
+ <h5>About Maven</h5>
+ <ul>
+ <li class="none">
+ <a href="../../what-is-maven.html">What is Maven?</a>
+ </li>
+ <li class="none">
+ <a href="../../maven-features.html">Features</a>
+ </li>
+ <li class="none">
+ <a href="../../general.html">FAQ (official)</a>
+ </li>
+ <li class="none">
+ <a href="http://docs.codehaus.org/display/MAVENUSER/FAQs-1" class="externalLink">FAQ (unofficial)</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+ <li class="none">
+ <a href="../../plugins/index.html">Maven Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../guides/index.html">Index (category)</a>
+ </li>
+ <li class="none">
+ <a href="../../run-maven/index.html">Running Maven</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../users/index.html">User Centre</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../plugin-developers/index.html">Plugin Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="../../repository/index.html">Maven Repository Centre</a>
+ </li>
+ <li class="none">
+ <a href="../../developers/index.html">Maven Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="../../articles.html">Books and Resources</a>
+ </li>
+ <li class="none">
+ <a href="http://docs.codehaus.org/display/MAVENUSER/Home" class="externalLink">Wiki</a>
+ </li>
+ </ul>
+ <h5>Community</h5>
+ <ul>
+ <li class="none">
+ <a href="../../community.html">Community Overview</a>
+ </li>
+ <li class="none">
+ <a href="../../guides/development/guide-helping.html">How to Contribute</a>
+ </li>
+ <li class="none">
+ <a href="../../guides/mini/guide-maven-evangelism.html">Maven Repository</a>
+ </li>
+ <li class="none">
+ <a href="../../users/getting-help.html">Getting Help</a>
+ </li>
+ <li class="none">
+ <a href="../../issue-tracking.html">Issue Tracking</a>
+ </li>
+ <li class="none">
+ <a href="../../source-repository.html">Source Repository</a>
+ </li>
+ <li class="none">
+ <a href="../../team-list.html">The Maven Team</a>
+ </li>
+ </ul>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../../project-info.html">Project Information</a>
+ </li>
+ </ul>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../../doxia/index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Maven 2 & 3</a>
+ </li>
+ <li class="none">
+ <a href="../../pom/index.html">Parent POMs</a>
+ </li>
+ <li class="none">
+ <a href="../../plugins/index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../plugin-tools/index.html">Plugin Tools</a>
+ </li>
+ <li class="none">
+ <a href="../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../skins/index.html">Skins</a>
+ </li>
+ <li class="none">
+ <a href="../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../wagon/index.html">Wagon</a>
+ </li>
+ </ul>
+ <h5>ASF</h5>
+ <ul>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../../images/logos/maven-feather.png"/>
+ </a>
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <!-- 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. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/referen
ces/apt-format.html --><div class="section"><h2>Maven Plugins Cookbook<a name="Maven_Plugins_Cookbook"></a></h2><p>A set of small complete working examples projects that demonstrate how to use Maven Plugins. It is based on commons how-to questions from the <a href="../../mail-lists.html">Maven User Mailing List</a>.</p><p><i>(Like to add more cookbooks? See <a href="../../guides/development/guide-helping.html"> How to Contribute</a> page)</i></p><div class="section"><h3>How To/Recipes<a name="How_ToRecipes"></a></h3><ul><li><a href="./add-build-time-to-manifest.html">How to add build time to a JAR manifest?</a></li><li><a href="./add-svn-revision-to-manifest.html">How to add SVN revision to a JAR manifest?</a></li><li><a href="./attach-source-javadoc-artifacts.html">How to attach source and javadoc artifacts?</a></li><li><a href="./generate-assembly.html">How to generate assembly?</a></li><li><a href="./plexus-plugin-upgrade.html">How to upgrade from Plexus javadoc tags to P
lexus Java annotations?</a></li></ul></div><div class="section"><h3>Other Resources<a name="Other_Resources"></a></h3><ul><li><a class="externalLink" href="http://docs.codehaus.org/display/MAVENUSER/Mojo+Developer+Cookbook">Mojo Developer Cookbook</a></li></ul></div></div>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">
+ © 2002-2012
+ The Apache Software Foundation
+
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Added: websites/staging/maven/trunk/content/plugin-developers/cookbook/plexus-plugin-upgrade.html
==============================================================================
--- websites/staging/maven/trunk/content/plugin-developers/cookbook/plexus-plugin-upgrade.html (added)
+++ websites/staging/maven/trunk/content/plugin-developers/cookbook/plexus-plugin-upgrade.html Mon Dec 10 08:17:24 2012
@@ -0,0 +1,310 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+ | Generated by Apache Maven Doxia at Dec 10, 2012
+ | Rendered using Apache Maven Stylus Skin 1.5
+-->
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Maven - Cookbook - How To Upgrade from Plexus Javadoc Tags to Plexus Java Annotations</title>
+ <style type="text/css" media="all">
+ @import url("../../css/maven-base.css");
+ @import url("../../css/maven-theme.css");
+ @import url("../../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" />
+ <meta name="author" content="Hervé Boutemy" />
+ <meta name="Date-Creation-yyyymmdd" content="20120602" />
+ <meta name="Date-Revision-yyyymmdd" content="20121210" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+
+<script type="text/javascript">_uacct = "UA-140879-1";
+ urchinTracker();</script>
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../.././" id="bannerLeft">
+ <img src="../../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <span id="bannerRight">
+ <img src="../../images/maven-logo-2.gif" alt="" />
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../index.html">Maven</a>
+ >
+ Cookbook - How To Upgrade from Plexus Javadoc Tags to Plexus Java Annotations
+ </div>
+ <div class="xright">
+ Last Published: 2012-12-10
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+ <h5>Main</h5>
+ <ul>
+ <li class="none">
+ <a href="../../index.html">Welcome</a>
+ </li>
+ </ul>
+ <h5>Get Maven</h5>
+ <ul>
+ <li class="none">
+ <a href="../../download.html">Download</a>
+ </li>
+ <li class="none">
+ <a href="../../docs/3.0.4/release-notes.html">Release Notes (3.0.4)</a>
+ </li>
+ <li class="none">
+ <a href="../../docs/2.2.1/release-notes.html">Release Notes (2.2.1)</a>
+ </li>
+ <li class="none">
+ <a href="../../docs/2.0.11/release-notes.html">Release Notes (2.0.11)</a>
+ </li>
+ <li class="none">
+ <a href="../../license.html">License</a>
+ </li>
+ </ul>
+ <h5>IDE Integration</h5>
+ <ul>
+ <li class="none">
+ <a href="../../eclipse-plugin.html">Eclipse</a>
+ </li>
+ <li class="none">
+ <a href="../../netbeans-module.html">NetBeans</a>
+ </li>
+ </ul>
+ <h5>About Maven</h5>
+ <ul>
+ <li class="none">
+ <a href="../../what-is-maven.html">What is Maven?</a>
+ </li>
+ <li class="none">
+ <a href="../../maven-features.html">Features</a>
+ </li>
+ <li class="none">
+ <a href="../../general.html">FAQ (official)</a>
+ </li>
+ <li class="none">
+ <a href="http://docs.codehaus.org/display/MAVENUSER/FAQs-1" class="externalLink">FAQ (unofficial)</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+ <li class="none">
+ <a href="../../plugins/index.html">Maven Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../guides/index.html">Index (category)</a>
+ </li>
+ <li class="none">
+ <a href="../../run-maven/index.html">Running Maven</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../users/index.html">User Centre</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../plugin-developers/index.html">Plugin Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="../../repository/index.html">Maven Repository Centre</a>
+ </li>
+ <li class="none">
+ <a href="../../developers/index.html">Maven Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="../../articles.html">Books and Resources</a>
+ </li>
+ <li class="none">
+ <a href="http://docs.codehaus.org/display/MAVENUSER/Home" class="externalLink">Wiki</a>
+ </li>
+ </ul>
+ <h5>Community</h5>
+ <ul>
+ <li class="none">
+ <a href="../../community.html">Community Overview</a>
+ </li>
+ <li class="none">
+ <a href="../../guides/development/guide-helping.html">How to Contribute</a>
+ </li>
+ <li class="none">
+ <a href="../../guides/mini/guide-maven-evangelism.html">Maven Repository</a>
+ </li>
+ <li class="none">
+ <a href="../../users/getting-help.html">Getting Help</a>
+ </li>
+ <li class="none">
+ <a href="../../issue-tracking.html">Issue Tracking</a>
+ </li>
+ <li class="none">
+ <a href="../../source-repository.html">Source Repository</a>
+ </li>
+ <li class="none">
+ <a href="../../team-list.html">The Maven Team</a>
+ </li>
+ </ul>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../../project-info.html">Project Information</a>
+ </li>
+ </ul>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../../doxia/index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Maven 2 & 3</a>
+ </li>
+ <li class="none">
+ <a href="../../pom/index.html">Parent POMs</a>
+ </li>
+ <li class="none">
+ <a href="../../plugins/index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../plugin-tools/index.html">Plugin Tools</a>
+ </li>
+ <li class="none">
+ <a href="../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../skins/index.html">Skins</a>
+ </li>
+ <li class="none">
+ <a href="../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../wagon/index.html">Wagon</a>
+ </li>
+ </ul>
+ <h5>ASF</h5>
+ <ul>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../../images/logos/maven-feather.png"/>
+ </a>
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <div class="section"><h2>Cookbook: How To Upgrade from Plexus Javadoc Tags to Plexus Java Annotations?<a name="Cookbook:_How_To_Upgrade_from_Plexus_Javadoc_Tags_to_Plexus_Java_Annotations"></a></h2><div class="section"><h3>Summary<a name="Summary"></a></h3><p>This recipe describes how to upgrade from Plexus Javadoc Tags to Plexus Java Annotations, in 2 steps:</p><ol style="list-style-type: decimal"><li>replace the deprecated <a class="externalLink" href="http://plexus.codehaus.org/plexus-maven-plugin/"><tt>plexus-maven-plugin</tt></a>, which only supports Plexus Javadoc Tags, with its successor: <a class="externalLink" href="http://plexus.codehaus.org/plexus-containers/plexus-component-metadata/"><tt>plexus-component-metadata</tt></a>, which support both Plexus Javadoc Tags and Plexus Java Annotations,</li><li>update sources with <a class="externalLink" href="http://plexus.codehaus.org/plexus-containers/plexus-component-annotations/">Java Annotations for Plexus</a>.<
/li></ol></div><div class="section"><h3>Prerequisite Plugins<a name="Prerequisite_Plugins"></a></h3><p>Here is the list of the plugins used:</p><table border="1" class="bodyTable"><tr class="a"><th align="left"><b>Plugin</b></th><th align="left"><b>Version</b></th></tr><tr class="b"><td align="left"><a class="externalLink" href="http://plexus.codehaus.org/plexus-maven-plugin/"><tt>plexus-maven-plugin</tt></a></td><td align="left">1.3.8</td></tr><tr class="a"><td align="left"><a class="externalLink" href="http://plexus.codehaus.org/plexus-containers/plexus-component-metadata/"><tt>plexus-component-metadata</tt></a></td><td align="left">1.5.5</td></tr></table></div><div class="section"><h3>Equivalence Table<a name="Equivalence_Table"></a></h3><table border="1" class="bodyTable"><tr class="a"><td align="center"></td><th align="center"><b>plexus-maven-plugin</b></th><th align="center"><b>plexus-component-metadata</b></th></tr><tr class="b"><td align="left"></td><td align="left">
<a class="externalLink" href="http://plexus.codehaus.org/plexus-maven-plugin/">project</a> / <a class="externalLink" href="http://plexus.codehaus.org/plexus-maven-plugin/plugin-info.html">plugin info</a></td><td align="left"><a class="externalLink" href="http://plexus.codehaus.org/plexus-containers/plexus-component-metadata/">project</a> / <a class="externalLink" href="http://plexus.codehaus.org/plexus-containers/plexus-component-metadata/plugin-info.html">plugin info</a></td></tr><tr class="a"><th align="left">latest</th><td align="left">1.3.8</td><td align="left">1.5.5</td></tr><tr class="b"><th align="left">phase</th><td align="left">process-sources</td><td align="left">process-classes</td></tr><tr class="a"><th align="left">goals</th><td align="left"><a class="externalLink" href="http://plexus.codehaus.org/plexus-maven-plugin/descriptor-mojo.html"><tt>descriptor</tt></a></td><td align="left"><a class="externalLink" href="http://plexus.codehaus.org/plexus-containers/plexu
s-component-metadata/generate-metadata-mojo.html"><tt>generate-metadata</tt></a></td></tr><tr class="b"><td align="left"></td><td align="left"><a class="externalLink" href="http://plexus.codehaus.org/plexus-maven-plugin/merge-descriptors-mojo.html"><tt>merge-descriptors</tt></a></td><td align="left">see <tt>staticMetadataDirectory</tt> parameter  <br />default: <tt>${basedir}/src/main/resources/META-INF/plexus</tt></td></tr><tr class="a"><td align="left"></td><td align="left"><a class="externalLink" href="http://plexus.codehaus.org/plexus-maven-plugin/test-descriptor-mojo.html"><tt>test-descriptor</tt></a></td><td align="left"><a class="externalLink" href="http://plexus.codehaus.org/plexus-containers/plexus-component-metadata/generate-test-metadata-mojo.html"><tt>generate-test-metadata</tt></a></td></tr><tr class="b"><td align="left"></td><td align="left"><a class="externalLink" href="http://plexus.codehaus.org/plexus-maven-plugin/test-merge-descriptors-mojo.html"><tt>t
est-merge-descriptors</tt></a></td><td align="left">see <tt>testStaticMetadataDirectory</tt> parameter  <br />default: <tt>${basedir}/src/test/resources/META-INF/plexus</tt></td></tr><tr class="a"><th align="left">source annotations</th><td align="left">javadoc tags:  <br /><tt>@plexus.component</tt>, <tt>@plexus.requirement</tt>, <tt>@plexus.configuration</tt>  </td><td align="left">javadoc tags + <a class="externalLink" href="http://plexus.codehaus.org/plexus-containers/plexus-component-annotations/"><tt>plexus-component-annotations</tt></a> Java 5 annotations: <br /><a class="externalLink" href="http://plexus.codehaus.org/plexus-containers/plexus-component-annotations/apidocs/org/codehaus/plexus/component/annotations/Component.html"><tt>@Component</tt></a>, <a class="externalLink" href="http://plexus.codehaus.org/plexus-containers/plexus-component-annotations/apidocs/org/codehaus/plexus/component/annotations/Requirement.html"><tt>@Requirement</tt></a>,
<a class="externalLink" href="http://plexus.codehaus.org/plexus-containers/plexus-component-annotations/apidocs/org/codehaus/plexus/component/annotations/Configuration.html"><tt>@Configuration</tt></a>,</td></tr></table></div><div class="section"><h3>Recipe<a name="Recipe"></a></h3><div class="section"><h4>Plugin Configuration<a name="Plugin_Configuration"></a></h4><p>In your <tt>pom.xml</tt>, replace <tt>plexus-maven-plugin</tt> configuration:</p><div class="source"><pre><project>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.codehaus.plexus</groupId>
+ <artifactId>plexus-maven-plugin</artifactId>
+ <version>1.3.8</version>
+ <executions>
+ <execution>
+ <goals>
+ <goal>descriptor</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </build>
+</project></pre></div><p>with corresponding <tt>plexus-component-metadata</tt> configuration:</p><div class="source"><pre><project>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.codehaus.plexus</groupId>
+ <artifactId>plexus-component-metadata</artifactId>
+ <version>1.5.5</version>
+ <executions>
+ <execution>
+ <goals>
+ <goal>generate-metadata</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </build>
+</project></pre></div><p>If <tt>merge-descriptors</tt> is used, move the handwritten xml file to <tt>${basedir}/src/main/resources/META-INF/plexus</tt>.</p></div><div class="section"><h4>Replacing Plexus Javadoc Tags with Plexus Java 5 Annotations<a name="Replacing_Plexus_Javadoc_Tags_with_Plexus_Java_5_Annotations"></a></h4><p>In your <tt>pom.xml</tt>, add <tt>plexus-component-annotations</tt> dependency:</p><div class="source"><pre><project>
+ <dependencies>
+ <dependency>
+ <groupId>org.codehaus.plexus</groupId>
+ <artifactId>plexus-component-annotations</artifactId>
+ <version>1.5.5</version>
+ </dependency>
+ </dependencies>
+</project></pre></div><p>In your java sources, replace javadoc tags:</p><div class="source"><pre>/**
+ * @plexus.component role="foo.MyComponent" role-hint="hint-value"
+ */
+public class MyComponentImplementation
+ implements MyComponent
+{
+ /**
+ * @plexus.requirement
+ */
+ private InjectedComponent;
+}</pre></div><p>with corresponding Java 5 annotations</p><div class="source"><pre>import org.codehaus.plexus.component.annotations.Component;
+import org.codehaus.plexus.component.annotations.Requirement;
+
+@Component( role = MyComponent.class, hint = "hint-value" )
+public class MyComponentImplementation
+ implements MyComponent
+{
+ @Requirement
+ private InjectedComponent;
+}</pre></div></div></div></div>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">
+ © 2002-2012
+ The Apache Software Foundation
+
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Added: websites/staging/maven/trunk/content/plugin-developers/index.html
==============================================================================
--- websites/staging/maven/trunk/content/plugin-developers/index.html (added)
+++ websites/staging/maven/trunk/content/plugin-developers/index.html Mon Dec 10 08:17:24 2012
@@ -0,0 +1,261 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+ | Generated by Apache Maven Doxia at Dec 10, 2012
+ | Rendered using Apache Maven Stylus Skin 1.5
+-->
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Maven - Plugin Developers Centre</title>
+ <style type="text/css" media="all">
+ @import url("../css/maven-base.css");
+ @import url("../css/maven-theme.css");
+ @import url("../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
+ <meta name="author" content="Brett Porter" />
+ <meta name="Date-Revision-yyyymmdd" content="20121210" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+
+<script type="text/javascript">_uacct = "UA-140879-1";
+ urchinTracker();</script>
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href=".././" id="bannerLeft">
+ <img src="../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <span id="bannerRight">
+ <img src="../images/maven-logo-2.gif" alt="" />
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../index.html">Maven</a>
+ >
+ Plugin Developers Centre
+ </div>
+ <div class="xright">
+ Last Published: 2012-12-10
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+ <h5>Main</h5>
+ <ul>
+ <li class="none">
+ <a href="../index.html">Welcome</a>
+ </li>
+ </ul>
+ <h5>Get Maven</h5>
+ <ul>
+ <li class="none">
+ <a href="../download.html">Download</a>
+ </li>
+ <li class="none">
+ <a href="../docs/3.0.4/release-notes.html">Release Notes (3.0.4)</a>
+ </li>
+ <li class="none">
+ <a href="../docs/2.2.1/release-notes.html">Release Notes (2.2.1)</a>
+ </li>
+ <li class="none">
+ <a href="../docs/2.0.11/release-notes.html">Release Notes (2.0.11)</a>
+ </li>
+ <li class="none">
+ <a href="../license.html">License</a>
+ </li>
+ </ul>
+ <h5>IDE Integration</h5>
+ <ul>
+ <li class="none">
+ <a href="../eclipse-plugin.html">Eclipse</a>
+ </li>
+ <li class="none">
+ <a href="../netbeans-module.html">NetBeans</a>
+ </li>
+ </ul>
+ <h5>About Maven</h5>
+ <ul>
+ <li class="none">
+ <a href="../what-is-maven.html">What is Maven?</a>
+ </li>
+ <li class="none">
+ <a href="../maven-features.html">Features</a>
+ </li>
+ <li class="none">
+ <a href="../general.html">FAQ (official)</a>
+ </li>
+ <li class="none">
+ <a href="http://docs.codehaus.org/display/MAVENUSER/FAQs-1" class="externalLink">FAQ (unofficial)</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+ <li class="none">
+ <a href="../plugins/index.html">Maven Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../guides/index.html">Index (category)</a>
+ </li>
+ <li class="none">
+ <a href="../run-maven/index.html">Running Maven</a>
+ </li>
+ <li class="collapsed">
+ <a href="../users/index.html">User Centre</a>
+ </li>
+ <li class="expanded">
+ <strong>Plugin Developer Centre</strong>
+ <ul>
+ <li class="none">
+ <a href="../guides/plugin/guide-java-plugin-development.html">Your First Mojo</a>
+ </li>
+ <li class="none">
+ <a href="../developers/mojo-api-specification.html">Mojo API</a>
+ </li>
+ <li class="none">
+ <a href="../ref/current/index.html">Maven API</a>
+ </li>
+ </ul>
+ </li>
+ <li class="none">
+ <a href="../repository/index.html">Maven Repository Centre</a>
+ </li>
+ <li class="none">
+ <a href="../developers/index.html">Maven Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="../articles.html">Books and Resources</a>
+ </li>
+ <li class="none">
+ <a href="http://docs.codehaus.org/display/MAVENUSER/Home" class="externalLink">Wiki</a>
+ </li>
+ </ul>
+ <h5>Community</h5>
+ <ul>
+ <li class="none">
+ <a href="../community.html">Community Overview</a>
+ </li>
+ <li class="none">
+ <a href="../guides/development/guide-helping.html">How to Contribute</a>
+ </li>
+ <li class="none">
+ <a href="../guides/mini/guide-maven-evangelism.html">Maven Repository</a>
+ </li>
+ <li class="none">
+ <a href="../users/getting-help.html">Getting Help</a>
+ </li>
+ <li class="none">
+ <a href="../issue-tracking.html">Issue Tracking</a>
+ </li>
+ <li class="none">
+ <a href="../source-repository.html">Source Repository</a>
+ </li>
+ <li class="none">
+ <a href="../team-list.html">The Maven Team</a>
+ </li>
+ </ul>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../project-info.html">Project Information</a>
+ </li>
+ </ul>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../doxia/index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../index.html">Maven 2 & 3</a>
+ </li>
+ <li class="none">
+ <a href="../pom/index.html">Parent POMs</a>
+ </li>
+ <li class="none">
+ <a href="../plugins/index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../plugin-tools/index.html">Plugin Tools</a>
+ </li>
+ <li class="none">
+ <a href="../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../skins/index.html">Skins</a>
+ </li>
+ <li class="none">
+ <a href="../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../wagon/index.html">Wagon</a>
+ </li>
+ </ul>
+ <h5>ASF</h5>
+ <ul>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../images/logos/maven-feather.png"/>
+ </a>
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <div class="section"><h2>Plugin Developers Centre<a name="Plugin_Developers_Centre"></a></h2><p>This documentation centre is for those that are developing Maven plugins. This might be for your own build, or as an accompaniment to your third party tool.</p><!-- TODO: callout --><p><b>What is a Mojo?</b> A mojo is a <b>M</b>aven plain <b>O</b>ld <b>J</b>ava <b>O</b>bject. Each mojo is an executable <i>goal</i> in Maven, and a plugin is a distribution of one or more related mojos.</p><!-- TODO: tasks as buttons? --><ul><li><a href="../guides/plugin/guide-java-plugin-development.html"> Your First Mojo</a> - Learn how to write your first plugin</li><li><a href="./plugin-testing.html"> Testing your Plugin</a> - How to write tests for your plugins</li><li><a href="./plugin-documenting.html"> Documenting your Plugin</a> - How to write documentation for your plugins</li><li><a href="./cookbook/index.html"> Plugins Cookbook</a> - Examples for how to perform common tasks in plu
gins</li><li><a href="./common-bugs.html"> Common Bugs and Pitfalls</a> - Overview of problematic coding patterns</li></ul><!-- TODO: trails --><div class="section"><h3>Reference<a name="Reference"></a></h3><ul><li><a href="../developers/mojo-api-specification.html"> Mojo API and Annotation Reference</a></li><li><a href="../ref/current/index.html"> Maven API Reference</a></li><li><a href="../guides/mini/guide-maven-classloading.html"> Maven Class Loading</a></li></ul></div><div class="section"><h3>Examples<a name="Examples"></a></h3><ul><li><a href="../examples/injecting-properties-via-settings.html">Injecting POM Properties via settings.xml</a></li><li><a href="../examples/maven-3-lifecycle-extensions.html">Maven 3 lifecycle extensions</a></li></ul></div></div>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">
+ © 2002-2012
+ The Apache Software Foundation
+
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Added: websites/staging/maven/trunk/content/plugin-developers/plugin-documenting.html
==============================================================================
--- websites/staging/maven/trunk/content/plugin-developers/plugin-documenting.html (added)
+++ websites/staging/maven/trunk/content/plugin-developers/plugin-documenting.html Mon Dec 10 08:17:24 2012
@@ -0,0 +1,250 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+ | Generated by Apache Maven Doxia at Dec 10, 2012
+ | Rendered using Apache Maven Stylus Skin 1.5
+-->
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Maven - Developers centre - Documentation Plugins Strategies</title>
+ <style type="text/css" media="all">
+ @import url("../css/maven-base.css");
+ @import url("../css/maven-theme.css");
+ @import url("../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
+ <meta name="author" content="Vincent Siveton" />
+ <meta name="Date-Revision-yyyymmdd" content="20121210" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+
+<script type="text/javascript">_uacct = "UA-140879-1";
+ urchinTracker();</script>
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href=".././" id="bannerLeft">
+ <img src="../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <span id="bannerRight">
+ <img src="../images/maven-logo-2.gif" alt="" />
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../index.html">Maven</a>
+ >
+ Developers centre - Documentation Plugins Strategies
+ </div>
+ <div class="xright">
+ Last Published: 2012-12-10
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+ <h5>Main</h5>
+ <ul>
+ <li class="none">
+ <a href="../index.html">Welcome</a>
+ </li>
+ </ul>
+ <h5>Get Maven</h5>
+ <ul>
+ <li class="none">
+ <a href="../download.html">Download</a>
+ </li>
+ <li class="none">
+ <a href="../docs/3.0.4/release-notes.html">Release Notes (3.0.4)</a>
+ </li>
+ <li class="none">
+ <a href="../docs/2.2.1/release-notes.html">Release Notes (2.2.1)</a>
+ </li>
+ <li class="none">
+ <a href="../docs/2.0.11/release-notes.html">Release Notes (2.0.11)</a>
+ </li>
+ <li class="none">
+ <a href="../license.html">License</a>
+ </li>
+ </ul>
+ <h5>IDE Integration</h5>
+ <ul>
+ <li class="none">
+ <a href="../eclipse-plugin.html">Eclipse</a>
+ </li>
+ <li class="none">
+ <a href="../netbeans-module.html">NetBeans</a>
+ </li>
+ </ul>
+ <h5>About Maven</h5>
+ <ul>
+ <li class="none">
+ <a href="../what-is-maven.html">What is Maven?</a>
+ </li>
+ <li class="none">
+ <a href="../maven-features.html">Features</a>
+ </li>
+ <li class="none">
+ <a href="../general.html">FAQ (official)</a>
+ </li>
+ <li class="none">
+ <a href="http://docs.codehaus.org/display/MAVENUSER/FAQs-1" class="externalLink">FAQ (unofficial)</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+ <li class="none">
+ <a href="../plugins/index.html">Maven Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../guides/index.html">Index (category)</a>
+ </li>
+ <li class="none">
+ <a href="../run-maven/index.html">Running Maven</a>
+ </li>
+ <li class="collapsed">
+ <a href="../users/index.html">User Centre</a>
+ </li>
+ <li class="collapsed">
+ <a href="../plugin-developers/index.html">Plugin Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="../repository/index.html">Maven Repository Centre</a>
+ </li>
+ <li class="none">
+ <a href="../developers/index.html">Maven Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="../articles.html">Books and Resources</a>
+ </li>
+ <li class="none">
+ <a href="http://docs.codehaus.org/display/MAVENUSER/Home" class="externalLink">Wiki</a>
+ </li>
+ </ul>
+ <h5>Community</h5>
+ <ul>
+ <li class="none">
+ <a href="../community.html">Community Overview</a>
+ </li>
+ <li class="none">
+ <a href="../guides/development/guide-helping.html">How to Contribute</a>
+ </li>
+ <li class="none">
+ <a href="../guides/mini/guide-maven-evangelism.html">Maven Repository</a>
+ </li>
+ <li class="none">
+ <a href="../users/getting-help.html">Getting Help</a>
+ </li>
+ <li class="none">
+ <a href="../issue-tracking.html">Issue Tracking</a>
+ </li>
+ <li class="none">
+ <a href="../source-repository.html">Source Repository</a>
+ </li>
+ <li class="none">
+ <a href="../team-list.html">The Maven Team</a>
+ </li>
+ </ul>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../project-info.html">Project Information</a>
+ </li>
+ </ul>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../doxia/index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../index.html">Maven 2 & 3</a>
+ </li>
+ <li class="none">
+ <a href="../pom/index.html">Parent POMs</a>
+ </li>
+ <li class="none">
+ <a href="../plugins/index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../plugin-tools/index.html">Plugin Tools</a>
+ </li>
+ <li class="none">
+ <a href="../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../skins/index.html">Skins</a>
+ </li>
+ <li class="none">
+ <a href="../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../wagon/index.html">Wagon</a>
+ </li>
+ </ul>
+ <h5>ASF</h5>
+ <ul>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../images/logos/maven-feather.png"/>
+ </a>
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <!-- 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. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/referen
ces/apt-format.html --><div class="section"><h2>Introduction<a name="Introduction"></a></h2><p>A <a href="../guides/development/guide-plugin-documentation.html">Guide to the Plugin Documentation Standard</a> was created. This document is intended to verify it during the Plugins development.</p></div><div class="section"><h2>Verify Plugin Documentation<a name="Verify_Plugin_Documentation"></a></h2><p>The <a href="../plugins/maven-docck-plugin">maven-docck-plugin</a> checks that a project complies with the Plugin Documentation Standard.</p><p>You <b>should</b> verify that all Plugin documentation respects this standard. The maven-docck-plugin can be run:</p><div class="source"><pre>mvn docck:check</pre></div></div><div class="section"><h2>References<a name="References"></a></h2><ul><li><a class="externalLink" href="http://cwiki.apache.org/confluence/display/MAVENOLD/Maven+Plugin+Documentation">Maven Plugin Documentation</a></li></ul></div>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">
+ © 2002-2012
+ The Apache Software Foundation
+
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>