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 [31/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/guides/mini/guide-relocation.html
==============================================================================
--- websites/staging/maven/trunk/content/guides/mini/guide-relocation.html (added)
+++ websites/staging/maven/trunk/content/guides/mini/guide-relocation.html Mon Dec 10 08:17:24 2012
@@ -0,0 +1,260 @@
+<!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 - Guide to relocation</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="Dennis Lundberg" />
+ <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>
+ >
+ Guide to relocation
+ </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>Guide to relocation<a name="Guide_to_relocation"></a></h2><p>Sometimes it is necessary to relocate artifacts in the repository. One example of that is when a project moves from Maven 1 to Maven 2. Maven 1 projects have traditionally used a flat repository structure, while Maven 2 uses a deep repository structure. As an example the Maven 1 project has a groupId of <tt>maven</tt> while the Maven 2 project has a groupId of <tt>org.apache.maven</tt>.</p><p>Making changes to the repository can have far reaching consequences. So it is best to get it right the first time, hence this guide. It will go through a couple of different kinds of relocations:</p><ul><li>Maven 1 to Maven 1</li><li>Maven 2 to Maven 2</li><li>Maven 1 to Maven 2</li></ul><p>The goal of the examples below is to relocate the groupId from <tt>bar</tt> to <tt>org.bar</tt> for the <tt>foo</tt> project.</p><div class="section"><h3>How to relocate a Maven 1 artifact to a different gro
upId<a name="How_to_relocate_a_Maven_1_artifact_to_a_different_groupId"></a></h3><ol style="list-style-type: decimal"><li>Copy all <tt>foo</tt>-related files from <tt>/bar/</tt> in your Maven 1 repository to a temporary location.</li><li>Change the groupId to <tt>org.bar</tt> in all the <tt>foo</tt>-related pom files in the temporary location.</li><li>If your project uses MD5 or SHA1 checksums you must now create new checksums for the changed pom files in the temporary location. If the pom file needs to be signed, do that as well.</li><li>Copy all files from the temporary location to <tt>/org.bar/</tt> in your Maven 1 repository.</li><li>If your project syncs with ibiblio, you should now initiate that sync. This might happen automatically depending on your projects sync policy.</li></ol><p>Your <tt>foo</tt>-artifacts are now available to Maven 1 users with both the old and the new groupId.</p><div class="section"><h4>Releasing the next version<a name="Releasing_the_next_vers
ion"></a></h4><p>When the next release of <tt>foo</tt> is made, you publish the Maven 1 pom as you have always done. Unfortunately Maven 1 does not have a concept of automatic relocation and notification, so you will have to inform your users of the changed groupId through your regular information channels.</p></div></div><div class="section"><h3>How to relocate a Maven 2 artifact to a different groupId<a name="How_to_relocate_a_Maven_2_artifact_to_a_different_groupId"></a></h3><ol style="list-style-type: decimal"><li>Copy all <tt>foo</tt>-related files from <tt>/bar/foo/</tt> in your Maven 2 repository to a temporary location.</li><li>Change the groupId to <tt>org.bar</tt> in all <tt>foo</tt>-related pom files in the temporary location.</li><li>Copy all files from the temporary location to <tt>/org/bar/foo/</tt> in your Maven 2 repository.</li><li>Create a minimal Maven 2 pom file for every old release of <tt>foo</tt> in your Maven 2 repository. The pom files only need to i
nclude <tt>groupId</tt>, <tt>artifactId</tt>, <tt>version</tt> and the relocation section.<p><b>Note:</b> Before you replace your old pom files in <tt>/bar/foo/</tt> with these minimal pom files, make sure you have made backups!</p><p>The minimal pom file might look like this for version 1.0 of <tt>foo</tt>:</p><div class="source"><pre><project>
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>bar</groupId>
+ <artifactId>foo</artifactId>
+ <version>1.0</version>
+ <distributionManagement>
+ <relocation>
+ <groupId>org.bar</groupId>
+ </relocation>
+ </distributionManagement>
+</project></pre></div><p>In this case we are relocating because the groupId has changed. We only need to add the element that has changed to the <tt>relocation</tt> element. For information on which elements are allowed in the <tt>relocation</tt> element, see <a class="externalLink" href="http://maven.apache.org/ref/current/maven-model/maven.html#class_relocation">the pom reference</a>.</p></li><li>If your project uses MD5 or SHA1 checksums you must now create new checksums for the pom files in <tt>/bar/foo/</tt> in your Maven 2 repository. If the pom file needs to be signed, do that as well.</li><li>If your project syncs with ibiblio, you should now initiate that sync. This might happen automatically depending on your projects sync policy.</li></ol><p>Your <tt>foo</tt>-artifacts are now available to Maven 2 users with both the old and the new groupId. Projects using the old groupId will automatically be redirected to the new groupId and a warning telling the user to u
pdate their dependencies will be issued.</p><div class="section"><h4>Releasing the next version<a name="Releasing_the_next_version"></a></h4><p>When the next release of <tt>foo</tt> is made, you should publish two Maven 2 pom files. First you should publish a pom with the new groupId <tt>org.bar</tt>.</p><p>Because data in the repository is not supposed to change, Maven 2 doesn't download pom files that it has already downloaded. Therefor you will also need to publish a pom file with the old groupId <tt>bar</tt> for the new version. This should be a minimal relocation pom (as described in step 4 above), but for the new version of <tt>foo</tt>.</p><p>For the release after that, you only need to publish a Maven 2 pom with a groupId of <tt>org.bar</tt>, since users of the previous version have been informed of the changed groupId.</p></div></div><div class="section"><h3>How to relocate a Maven 1 artifact to a Maven 2 artifact with a different groupId<a name="How_to_relocate_a_M
aven_1_artifact_to_a_Maven_2_artifact_with_a_different_groupId"></a></h3><p><i>This is only of interest to organizations (like the Apache Software Foundation) that automatically converts the contents of their Maven 1 repository to their Maven 2 repository.</i></p><p>Follow steps 4 to 6 in the section <i>How to relocate a Maven 2 artifact to a different groupId</i> above.</p><div class="section"><h4>Releasing the next version<a name="Releasing_the_next_version"></a></h4><p>When the next release of <tt>foo</tt> is made, you should publish the Maven 1 pom as you have always done. In addition to that, you should publish a Maven 2 pom with a groupId of <tt>bar</tt>, a version of <next-version> and include a relocation section. This step can be done once for the first release of a project, after the groupId has been changed, but your users will be happier if you do it more times.</p></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/guides/mini/guide-repository-ssl.html
==============================================================================
--- websites/staging/maven/trunk/content/guides/mini/guide-repository-ssl.html (added)
+++ websites/staging/maven/trunk/content/guides/mini/guide-repository-ssl.html Mon Dec 10 08:17:24 2012
@@ -0,0 +1,268 @@
+<!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 - Remote repository access through authenticated HTTPS</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="Arnaud Bailly" />
+ <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>
+ >
+ Remote repository access through authenticated HTTPS
+ </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>Guide to Remote repository access through authenticated HTTPS<a name="Guide_to_Remote_repository_access_through_authenticated_HTTPS"></a></h2><p>This document describes how to configure Maven for accessing a remote repository that sits behind an HTTPS server which requires client authentication with certificates. It is expected that this documentation be valid both for Maven 1.x and Maven 2.0.</p><div class="section"><h3>The problem<a name="The_problem"></a></h3><p>You have a server storing a maven repository at addresse <tt>https://my.server.com/maven</tt>. This server only serves clients authenticated through SSL protocol by a valid certificate signed by an approved certificate authority's certificate which we call the <tt>CACert</tt>. In the simplest case where the server is used internally by an identified community of users (eg. corporate intranet), the server's certificate is the certificate authority as the server is used only internal
ly.</p><p>So we assume that we have access to the trusted certificate in X.509 format stored in a file named:</p><div><pre> /somewhere/in/filesystem/CACert.cert</pre></div><p>The client's certificate has been issued by some other mean not described in this document in PKCS#12 format, which is the format that is accepted by browsers (at least Firefox and Internet Explorer) for importation in their keystore. This file is named:</p><div><pre> /home/directory/mycertificate.p12</pre></div><p>and we assume it is accessible when launching maven. Note that this file contains the client's private key which may be very sensitive information and so is secured by a password:</p><div><pre> CeRtPwD</pre></div><p>The remote repository is referenced either through the <tt>pom.xml</tt> file (maven2.0) or one of <tt>build.properties</tt> or <tt>project.properties</tt> (Maven1.X). In Maven 1.X:</p><div><pre>maven.repo.remote=https://my.server.com/maven,http://www.ibiblio.org/maven</pre><
/div></div><div class="section"><h3>The solution<a name="The_solution"></a></h3><p>For maven to use this repository, we should take the following steps:</p><ol style="list-style-type: decimal"><li>Create a store to hold the server's certificate usings Sun's <a class="externalLink" href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/solaris/keytool.html"> keytool</a>,</li><li>Defines properties to be used by HttpClient for finding keys and certificate</li></ol><div class="section"><h4>Storing certificate<a name="Storing_certificate"></a></h4><p>The following command line imports the certififcate authority's certificate into a JKS formatted key store named <tt>trust.jks</tt>, the <i>trust store</i>.</p><div><pre>$> keytool -v -alias mavensrv -import \
+ -file /somewhere/in/filesystem/CACert.cert\
+ -keystore trust.jks
+Enter keystore password:
+Owner: ....
+Issuer: ....
+Serial number: ....
+Valid from: Mon Feb 21 22:34:25 CET 2005 until: Thu Feb 19 22:34:25 CET 2015
+Certificate fingerprints:
+ MD5: .......
+ SHA1: .....
+Trust this certificate? [no]: yes
+Certificate was added to keystore
+[Storing trust.jks]
+$></pre></div><p>Note that it should be possible to import a full chain of certificates with only one root certificate being trusted but the author did not test it.</p></div><div class="section"><h4>Setting properties<a name="Setting_properties"></a></h4><p>The following properties must be set at start of maven to be accessible when HttpClient starts up.</p><dl><dt>javax.net.ssl.trustStore</dt><dd>the path to the keystore where trusted certificates are stored</dd><dt>javax.net.ssl.trustStoreType</dt><dd>the type of storage for this store, maybe either <tt>jks</tt> (default) or <tt>pkcs12</tt></dd><dt>javax.net.ssl.trustStorePassword</dt><dd>the password protecting the store</dd><dt>javax.net.ssl.keyStore</dt><dd>the path to the keystore where user's private key is stored</dd><dt>javax.net.ssl.keyStoreType</dt><dd>the type of storage for this store, maybe either <tt>jks</tt> (default) or <tt>pkcs12</tt></dd><dt>javax.net.ssl.keyStorePassword</dt><dd>the password protecting
the store</dd></dl><p>Not all the properties must be set depending of your precise settings: type of store may left to default, password may be empty.</p><div class="section"><h5>Maven 2.0<a name="Maven_2.0"></a></h5><p>They may be set either on maven's command-line, in <tt>.mavenrc</tt> file or in <tt>MAVEN_OPTS</tt> environment variable. For the setting defined in this document, here is an example <tt>.mavenrc</tt> file:</p><div><pre>MAVEN_OPTS="-Xmx512m -Djavax.net.ssl.trustStore=trust.jks \
+ -Djavax.net.ssl.trustStorePassword= \
+ -Djavax.net.ssl.keyStore=/home/directory/mycertificate.p12 \
+ -Djavax.net.ssl.keyStoreType=pkcs12 \
+ -Djavax.net.ssl.keyStorePassword=XXXXXX"</pre></div></div><div class="section"><h5>For maven 1.X users<a name="For_maven_1.X_users"></a></h5><p>Setting these properties in <tt>build.properties</tt> or <tt>project.properties</tt> does <b>not work</b>: the properties are needed before any of theses files are opened.</p></div></div></div><div class="section"><h3>Links<a name="Links"></a></h3><p>The following links may be useful in understanding SSL infrastructure management in Java:</p><ul><li><a class="externalLink" href="http://java.sun.com/j2se/1.4.2/docs/guide/security/"> Javasecurity infrastructure (1.4.2)</a></li><li><a class="externalLink" href="http://hc.apache.org/httpclient-3.x/sslguide.html"> HttpClient</a>'s SSL guide</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/guides/mini/guide-site.html
==============================================================================
--- websites/staging/maven/trunk/content/guides/mini/guide-site.html (added)
+++ websites/staging/maven/trunk/content/guides/mini/guide-site.html Mon Dec 10 08:17:24 2012
@@ -0,0 +1,346 @@
+<!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 - Guide to creating a site</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
+Jason van Zyl" />
+ <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>
+ >
+ Guide to creating a site
+ </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>Creating a site<a name="Creating_a_site"></a></h2><div class="section"><h3>Creating Content<a name="Creating_Content"></a></h3><p>The first step to creating your site is to create some content. In Maven 2.0, the site content is separated by format, as there are several available.</p><div><pre>+- src/
+ +- site/
+ +- apt/
+ | +- index.apt
+ |
+ +- xdoc/
+ | +- other.xml
+ |
+ +- fml/
+ | +- general.fml
+ | +- faq.fml
+ |
+ +- site.xml</pre></div><p>You will notice there is now a <tt>${basedir}/src/site</tt> directory within which is contained a site descriptor along with various directories corresponding to the supported document types. Let's take a look at site descriptor and the examples of the various document types.</p><p>The Xdoc format is the same as <a class="externalLink" href="http://maven.apache.org/maven-1.x/using/site.html"> used in Maven 1.x</a>. However, <tt>navigation.xml</tt> has been replaced by the site descriptor (see below).</p><p>The APT format, "Almost Plain Text", is a wiki-like format that allows you to write simple, structured documents (like this one) very quickly. A full reference of the <a class="externalLink" href="http://maven.apache.org/doxia/references/apt-format.html"> APT Format</a> is available.</p><p>The FML format is the FAQ format, also used in Maven 1.x.</p><p>Other formats are available, but at this point these 3 are the best tested. Ther
e are also several possible output formats, but as of 2.0, only XHTML is available.</p><p>Note that all of the above is optional - just one index file is required in one of the input trees. Each of the paths will be merged together to form the root directory of the site.</p></div><div class="section"><h3>Customizing the Look & Feel<a name="Customizing_the_Look__Feel"></a></h3><p>If you want to tune the way your site looks, you can use a custom skin to provide your own CSS styles. If that is still not enough, you can even tweak the output templates that Maven uses to generate the site documentation. You can visit the <a class="externalLink" href="http://maven.apache.org/skins/">Skins site</a> to have a look at some of the skins that you can use to change the look of your site.</p><!-- TODO: The following link is currently not available. Restore it when it becomes available again. --><!-- For an in-depth discussion of site customization, please have a look at the --><!-- {
{{http://www.sonatype.com/book/site-generation.html} Maven User Guide, Chapter 9, "Site Generation"}}. --></div><div class="section"><h3>Generating the Site<a name="Generating_the_Site"></a></h3><p>Generating the site is very simple, and fast!</p><div><pre>mvn site</pre></div><p>By default, the resulting site will be in <tt>target/site/...</tt></p><p>For more information on the Maven Site Plugin, see its <a href="../../plugins/maven-site-plugin/"> plugin reference</a>.</p></div><div class="section"><h3>Deploying the Site<a name="Deploying_the_Site"></a></h3><p>To be able to deploy the site, you must first declare a location to distribute to in your <tt>pom.xml</tt>, similar to the repository for deployment.</p><div><pre><project>
+ ...
+ <distributionManagement>
+ <site>
+ <id>website</id>
+ <url>scp://www.mycompany.com/www/docs/project/</url>
+ </site>
+ </distributionManagement>
+ ...
+</project></pre></div><p>The <tt><id></tt> element identifies the repository, so that you can attach credentials to it in your <tt>settings.xml</tt> file using the <a href="../../settings.html#Servers"> <tt><servers></tt> element</a> as you would for any other repository.</p><p>The <tt><url></tt> gives the location to deploy to. Currently, only SSH is supported, as above which copies to the host <tt>www.mycompany.com</tt> in the path <tt>/www/docs/project/</tt>. If subprojects inherit the site URL from a parent POM, they will automatically append their <tt><artifactId></tt> to form their effective deployment location.</p><p>Deploying the site is done by using the <tt>site-deploy</tt> phase of the site lifecycle.</p><div><pre>mvn site-deploy</pre></div></div><div class="section"><h3>Creating a Site Descriptor<a name="Creating_a_Site_Descriptor"></a></h3><p>The <tt>site.xml</tt> file is used to describe the layout of the site, and replaces the <tt
>navigation.xml</tt> file used in Maven 1.x.</p><p>A sample is given below:</p><div><pre><?xml version="1.0" encoding="ISO-8859-1"?>
+<project name="Maven">
+ <bannerLeft>
+ <name>Maven</name>
+ <src>http://maven.apache.org/images/apache-maven-project.png</src>
+ <href>http://maven.apache.org/</href>
+ </bannerLeft>
+ <bannerRight>
+ <src>http://maven.apache.org/images/maven-small.gif</src>
+ </bannerRight>
+ <body>
+ <links>
+ <item name="Apache" href="http://www.apache.org/" />
+ <item name="Maven 1.x" href="http://maven.apache.org/maven-1.x/"/>
+ <item name="Maven 2" href="http://maven.apache.org/"/>
+ </links>
+
+ <menu name="Maven 2.0">
+ <item name="Introduction" href="index.html"/>
+ <item name="Download" href="download.html"/>
+ <item name="Release Notes" href="release-notes.html" />
+ <item name="General Information" href="about.html"/>
+ <item name="For Maven 1.x Users" href="maven1.html"/>
+ <item name="Road Map" href="roadmap.html" />
+ </menu>
+
+ <menu ref="reports"/>
+
+ ...
+ </body>
+</project></pre></div><!-- TODO: deserves more explanation. --><p><b>Note:</b> The <tt><menu ref="reports"/></tt> element above. When building the site, this is replaced by a menu with links to all the reports that you have configured.</p><p>More information about the site descriptor is available at the site for the <a class="externalLink" href="http://maven.apache.org/plugins/maven-site-plugin/examples/sitedescriptor.html">Maven Site Plugin</a>.</p></div><div class="section"><h3>Adding Extra Resources<a name="Adding_Extra_Resources"></a></h3><p>You can add any arbitrary resource to your site by including them in a <tt>resources</tt> directory as shown below. Additional CSS files will be picked up when they are placed in the <tt>css</tt> directory within the <tt>resources</tt> directory.</p><div><pre>+- src/
+ +- site/
+ +- resources/
+ +- css/
+ | +- site.css
+ |
+ +- images/
+ +- pic1.jpg</pre></div><p>The file <tt>site.css</tt> will be added to the default XHTML output, so it can be used to adjust the default Maven stylesheets if desired.</p><p>The file <tt>pic1.jpg</tt> will be available via a relative reference to the <tt>images</tt> directory from any page in your site.</p></div><div class="section"><h3>Configuring Reports<a name="Configuring_Reports"></a></h3><p>Maven has several reports that you can add to your web site to display the current state of the project. These reports take the form of plugins, just like those used to build the project.</p><p>There are many standard reports that are available by gleaning information from the POM. Currently what is provided by default are:</p><ul><li>Dependencies Report</li><li>Mailing Lists</li><li>Continuous Integration</li><li>Source Repository</li><li>Issue Tracking</li><li>Project Team</li><li>License</li></ul><p>To find out more please refer to the <a href="../../plugins/maven-proje
ct-info-reports-plugin/">Project Info Reports Plugin</a>.</p><p>To add these reports to your site, you must add the plugins to a special <tt><reporting></tt> section in the POM. The following example shows how to configure the standard project information reports that display information from the POM in a friendly format:</p><div><pre><project>
+ ...
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-project-info-reports-plugin</artifactId>
+ <version>2.0.1</version>
+ </plugin>
+ </plugins>
+ </reporting>
+ ...
+</project></pre></div><p>If you have included the appropriate <tt><menu ref="reports"/></tt> tag in your <tt>site.xml</tt> descriptor, then when you regenerate the site those items will appear in the menu.</p><p><b>Note:</b> Many report plugins provide a parameter called <tt>outputDirectory</tt> or similar to specify the destination for their report outputs. This parameter is only relevant if the report plugin is run standalone, i.e. by invocation directly from the command line. In constrast, when reports are generated as part of the site, the configuration of the Maven Site Plugin will determine the effective output directory to ensure that all reports end up in a central location.</p><!-- TODO: explain report sets --></div><div class="section"><h3>Internationalization<a name="Internationalization"></a></h3><p>Internationalization in Maven is very simple, as long as the reports you are using have that particular locale defined. For an overview of suppo
rted languages and instructions on how to add further languages, please see the related article <a href="../../plugins/maven-site-plugin/i18n.html"> Internationalization</a> from the Maven Site Plugin.</p><p>To enable multiple locales, add a configuration similar to the following to your POM:</p><div><pre><project>
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-site-plugin</artifactId>
+ <version>2.0-beta-6</version>
+ <configuration>
+ <locales>en,fr</locales>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ ...
+</project></pre></div><p>This will generate both an English and a French version of the site. If <tt>en</tt> is your current locale, then it will be generated at the root of the site, with a copy of the French translation of the site in the <tt>fr/</tt> subdirectory.</p><p>To add your own content for that translation instead of using the default, place a subdirectory with that locale name in your site directory and create a new site descriptor with the locale in the file name. For example:</p><div><pre>+- src/
+ +- site/
+ +- apt/
+ | +- index.apt (Default version)
+ |
+ +- fr/
+ | +- apt/
+ | +- index.apt (French version)
+ |
+ +- site.xml (Default site descriptor)
+ +- site_fr.xml (French site descriptor)</pre></div><p>With one site descriptor per language, the translated site(s) can evolve independently.</p></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/guides/mini/guide-snippet-macro.html
==============================================================================
--- websites/staging/maven/trunk/content/guides/mini/guide-snippet-macro.html (added)
+++ websites/staging/maven/trunk/content/guides/mini/guide-snippet-macro.html Mon Dec 10 08:17:24 2012
@@ -0,0 +1,271 @@
+<!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 - Guide to the Snippet Macro</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="Wendy Smoak" />
+ <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>
+ >
+ Guide to the Snippet Macro
+ </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>Guide to the Snippet Macro<a name="Guide_to_the_Snippet_Macro"></a></h2><p>When generating your project website with Maven, you have the option of dynamically including <i>snippet</i>s of source code in your pages.</p><p>A <i>snippet</i> is a section of a source code file that is surrounded by specially formatted comments.</p><p>This functionality is inspired by the <a class="externalLink" href="http://www.atlassian.com/software/confluence/">Confluence</a> snippet macro, and is provided by the Maven Doxia project by way of the Maven Site Plugin.</p><p>To include snippets of source code in your documentation, first add comments in the source document surrounding the lines you want to include, and then refer to the snippet by its id in the documentation file.</p><p>Each snippet must be assigned an id, and the id must be unique within the source document.</p><p>Following are examples of snippets in various source documents, as wel
l as the corresponding macros in the APT documentation format.</p><p>See the Doxia <a class="externalLink" href="http://maven.apache.org/doxia/macros/index.html#Snippet_Macro">Macros Guide</a> for more information and examples.</p><div class="section"><h3>Snippets in Sources<a name="Snippets_in_Sources"></a></h3><div class="section"><h4>Java<a name="Java"></a></h4><div><pre> // START SNIPPET: snip-id
+ public static void main( String[] args )
+ {
+ System.out.println( "Hello World!" );
+ }
+ // END SNIPPET: snip-id</pre></div></div><div class="section"><h4>XML<a name="XML"></a></h4><div><pre> <!-- START SNIPPET: snip-id -->
+ <navigation-rule>
+ <from-view-id>/logon.jsp</from-view-id>
+ <navigation-case>
+ <from-outcome>success</from-outcome>
+ <to-view-id>/mainMenu.jsp</to-view-id>
+ </navigation-case>
+ </navigation-rule>
+ <!-- END SNIPPET: snip-id --></pre></div></div><div class="section"><h4>JSP<a name="JSP"></a></h4><div><pre> <%-- START SNIPPET: snip-id --%>
+ <ul>
+ <li><a href="newPerson!input.action">Create</a> a new person</li>
+ <li><a href="listPeople.action">List</a> all people</li>
+ </ul>
+ <%-- END SNIPPET: snip-id --%></pre></div></div></div><div class="section"><h3>Snippets in Documentation<a name="Snippets_in_Documentation"></a></h3><div class="section"><h4>APT<a name="APT"></a></h4><div><pre> %{snippet|id=snip-id|url=http://svn.example.com/path/to/Sample.java}
+
+ %{snippet|id=snip-id|url=file:///path/to/Sample.java}</pre></div><p>As of doxia-core version 1.0-alpha-9, a 'file' parameter is also available. If a full path is not specified, the location is assumed to be relative to ${basedir}.</p><div><pre> ~~ Since doxia-core 1.0-alpha-9
+ %{snippet|id=abc|file=src/main/webapp/index.jsp}</pre></div><ul><li>Macros in apt <b>must not</b> be indented.</li><li>Exactly one of <tt>url</tt> or <tt>file</tt> <b>must</b> be specified.</li></ul></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/guides/mini/guide-using-ant.html
==============================================================================
--- websites/staging/maven/trunk/content/guides/mini/guide-using-ant.html (added)
+++ websites/staging/maven/trunk/content/guides/mini/guide-using-ant.html Mon Dec 10 08:17:24 2012
@@ -0,0 +1,317 @@
+<!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 - Guide to using Ant with Maven</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="Jason van Zyl" />
+ <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>
+ >
+ Guide to using Ant with Maven
+ </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>Guide to using Ant with Maven<a name="Guide_to_using_Ant_with_Maven"></a></h2><p>The example above illustrates how to bind an ant script to a lifecycle phase. You can add a script to each lifecycle phase, by duplicating the <i>execution/</i> section and specifying a new phase.</p><div class="source"><pre>
+<project>
+ <modelVersion>4.0.0</modelVersion>
+ <artifactId>my-test-app</artifactId>
+ <groupId>my-test-group</groupId>
+ <version>1.0-SNAPSHOT</version>
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-antrun-plugin</artifactId>
+ <version>1.1</version>
+ <executions>
+ <execution>
+ <phase>generate-sources</phase>
+ <configuration>
+ <tasks>
+
+ <!--
+ Place any ant task here. You can add anything
+ you can add between <target> and </target> in a
+ build.xml.
+ -->
+
+ </tasks>
+ </configuration>
+ <goals>
+ <goal>run</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+</project>
+</pre></div><p>So a concrete example would be something like the following:</p><div class="source"><pre>
+<project>
+ <modelVersion>4.0.0</modelVersion>
+ <artifactId>my-test-app</artifactId>
+ <groupId>my-test-group</groupId>
+ <version>1.0-SNAPSHOT</version>
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-antrun-plugin</artifactId>
+ <version>1.1</version>
+ <executions>
+ <execution>
+ <phase>generate-sources</phase>
+ <configuration>
+ <tasks>
+ <exec
+ dir="${basedir}"
+ executable="${basedir}/src/main/sh/do-something.sh"
+ failonerror="true">
+ <arg line="arg1 arg2 arg3 arg4" />
+ </exec>
+ </tasks>
+ </configuration>
+ <goals>
+ <goal>run</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+</project>
+</pre></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>