You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2012/05/08 14:09:45 UTC
svn commit: r816568 [25/49] - in
/websites/production/maventest/content/plugins/maven-site-plugin-latest: ./
apidocs/ apidocs/org/apache/maven/plugins/site/
apidocs/org/apache/maven/plugins/site/class-use/
apidocs/org/apache/maven/plugins/site/wagon/ a...
Modified: websites/production/maventest/content/plugins/maven-site-plugin-latest/stage-deploy-mojo.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-site-plugin-latest/stage-deploy-mojo.html (original)
+++ websites/production/maventest/content/plugins/maven-site-plugin-latest/stage-deploy-mojo.html Tue May 8 12:09:38 2012
@@ -1,18 +1,8 @@
<!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 Jul 30, 2011 -->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
- <title>Maven Site Plugin -
+ <title>
site:stage-deploy</title>
<style type="text/css" media="all">
@import url("./css/maven-base.css");
@@ -20,61 +10,43 @@
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta name="Date-Revision-yyyymmdd" content="20110730" />
+ <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" src="http://www.google-analytics.com/urchin.js"></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>
+ <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>
+ >
+ <a href="../index.html">Plugins</a>
+ >
+ <a href="./">Maven Site Plugin 3</a>
+ >
- <div class="xleft">
-
- <a href="http://www.apache.org/" class="externalLink">Apache</a>
- >
-
- <a href="../../index.html">Maven</a>
- >
-
- <a href="../index.html">Plugins</a>
- >
-
- <a href="http://maven.apache.org/plugins/maven-site-plugin-3.0-beta-3" class="externalLink">Maven Site Plugin</a>
- </div>
- <div class="xright">
-
-
-
-
-
-
-
- Last Published: 2010-10-18
- | Version: 3.0-beta-3
+ site:stage-deploy
+ </div>
+ <div class="xright">
+ Last Published: 2011-07-30
+ | Version: 3.0
</div>
<div class="clear">
<hr/>
@@ -82,203 +54,117 @@
</div>
<div id="leftColumn">
<div id="navcolumn">
-
-
-
-
-
-
-
-
- <h5>Overview</h5>
- <ul>
-
- <li class="none">
- <a href="index.html">Introduction</a>
- </li>
-
- <li class="none">
- <a href="plugin-info.html">Goals</a>
- </li>
-
- <li class="none">
- <a href="usage.html">Usage</a>
- </li>
-
- <li class="none">
- <a href="faq.html">FAQ</a>
- </li>
-
- <li class="none">
- <a href="migrate.html">Migrate</a>
- </li>
-
- <li class="none">
- <a href="maven-3.html">Maven 3</a>
- </li>
+
+ <h5>Overview</h5>
+ <ul>
+ <li class="none">
+ <a href="index.html">Introduction</a>
+ </li>
+ <li class="none">
+ <a href="plugin-info.html">Goals</a>
+ </li>
+ <li class="none">
+ <a href="usage.html">Usage</a>
+ </li>
+ <li class="none">
+ <a href="faq.html">FAQ</a>
+ </li>
+ <li class="none">
+ <a href="migrate.html">Migrate</a>
+ </li>
+ <li class="none">
+ <a href="maven-3.html">Maven 3</a>
+ </li>
</ul>
- <h5>Configuration</h5>
- <ul>
-
- <li class="none">
- <a href="i18n.html">Internationalization</a>
- </li>
+ <h5>Configuration</h5>
+ <ul>
+ <li class="none">
+ <a href="i18n.html">Internationalization</a>
+ </li>
</ul>
- <h5>Examples</h5>
- <ul>
-
- <li class="none">
- <a href="examples/creating-content.html">Creating Content</a>
- </li>
-
- <li class="none">
- <a href="examples/sitedescriptor.html">Configuring the Site Descriptor</a>
- </li>
-
- <li class="none">
- <a href="examples/configuring-reports.html">Configuring Reports</a>
- </li>
-
- <li class="none">
- <a href="examples/siterun.html">Configuring Site Run</a>
- </li>
-
- <li class="none">
- <a href="examples/templatefile.html">Changing the Template File</a>
- </li>
-
- <li class="none">
- <a href="examples/creatingskins.html">Creating Skins</a>
- </li>
-
- <li class="none">
- <a href="examples/moduleexcludes.html">Excluding Document Formats</a>
- </li>
-
- <li class="none">
- <a href="examples/site-deploy-to-sourceforge.net.html">Deploying to sourceforge.net</a>
- </li>
+ <h5>Examples</h5>
+ <ul>
+ <li class="none">
+ <a href="examples/creating-content.html">Creating Content</a>
+ </li>
+ <li class="none">
+ <a href="examples/sitedescriptor.html">Configuring the Site Descriptor</a>
+ </li>
+ <li class="none">
+ <a href="examples/multimodule.html">Building a multi-module site</a>
+ </li>
+ <li class="none">
+ <a href="examples/configuring-reports.html">Configuring Reports</a>
+ </li>
+ <li class="none">
+ <a href="examples/siterun.html">Configuring Site Run</a>
+ </li>
+ <li class="none">
+ <a href="examples/adding-deploy-protocol.html">Adding a Protocol to Deploy the Site</a>
+ </li>
+ <li class="none">
+ <a href="examples/templatefile.html">Changing the Template File</a>
+ </li>
+ <li class="none">
+ <a href="examples/creatingskins.html">Creating Skins</a>
+ </li>
+ <li class="none">
+ <a href="examples/moduleexcludes.html">Excluding Document Formats</a>
+ </li>
+ <li class="none">
+ <a href="examples/site-deploy-to-sourceforge.net.html">Deploying to sourceforge.net</a>
+ </li>
</ul>
- <h5>Project Documentation</h5>
- <ul>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="collapsed">
- <a href="project-info.html">Project Information</a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="collapsed">
- <a href="project-reports.html">Project Reports</a>
- </li>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="project-info.html">Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="project-reports.html">Project Reports</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="../../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</a>
- </li>
-
- <li class="none">
- <a href="../../mercury/index.html">Mercury</a>
- </li>
-
- <li class="none">
- <a href="../index.html">Plugins</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="../../surefire/index.html">Surefire</a>
- </li>
-
- <li class="none">
- <a href="../../wagon/index.html">Wagon</a>
- </li>
+ <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</a>
+ </li>
+ <li class="none">
+ <a href="../index.html">Plugins</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="../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../wagon/index.html">Wagon</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"></img>
- </a>
+ <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>
<div id="bodyColumn">
<div id="contentBox">
@@ -286,7 +172,7 @@
<div class="section"><h2>site:stage-deploy<a name="site:stage-deploy"></a></h2>
<p><b>Full name</b>:</p>
- <p>org.apache.maven.plugins:maven-site-plugin:3.0-beta-3:stage-deploy</p>
+ <p>org.apache.maven.plugins:maven-site-plugin:3.0:stage-deploy</p>
<p><b>Description</b>:</p>
<div>Deploys the generated site to a staging or mock directory to the
site URL specified in the
@@ -295,11 +181,12 @@ supports <tt>scp</tt> and <tt>file</tt>
deployment.</div>
<p><b>Attributes</b>:</p>
<ul>
- <li>Requires a Maven 2.0 project to be executed.</li>
+ <li>Requires a Maven project to be executed.</li>
<li>Requires dependency resolution of artifacts in scope: <tt>test</tt>.</li>
+ <li>Since version: <tt>2.3</tt>.</li>
</ul>
<div class="section"><h3>Required Parameters<a name="Required_Parameters"></a></h3>
- <table class="bodyTable" border="0" align="left">
+ <table class="bodyTable" border="0">
<tr class="a">
<th>Name</th>
<th>Type</th>
@@ -307,22 +194,16 @@ deployment.</div>
<th>Description</th>
</tr>
<tr class="b">
- <td><b><a href="#generatedSiteDirectory">generatedSiteDirectory</a></b></td>
- <td><tt>File</tt></td>
- <td><tt>-</tt></td>
- <td>Directory containing generated documentation.<br /></td>
- </tr>
- <tr class="a">
- <td><b><a href="#outputDirectory">outputDirectory</a></b></td>
+ <td><b><a href="#inputDirectory">inputDirectory</a></b></td>
<td><tt>File</tt></td>
- <td><tt>-</tt></td>
+ <td><tt>2.3</tt></td>
<td>Directory containing the generated project sites and report
-distributions.<br /><b>Default value is</b>: <tt>${project.reporting.outputDirectory}</tt>.</td>
+distributions.<br /></td>
</tr>
</table>
</div>
<div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
- <table class="bodyTable" border="0" align="left">
+ <table class="bodyTable" border="0">
<tr class="a">
<th>Name</th>
<th>Type</th>
@@ -330,120 +211,60 @@ distributions.<br /><b>Default value is<
<th>Description</th>
</tr>
<tr class="b">
- <td><b><a href="#attributes">attributes</a></b></td>
- <td><tt>Map</tt></td>
- <td><tt>-</tt></td>
- <td>The template properties for rendering the site.<br /></td>
- </tr>
- <tr class="a">
<td><b><a href="#chmod">chmod</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>2.1</tt></td>
<td>Whether to run the "chmod" command on the remote site after the
deploy. Defaults to "true".<br /><b>Default value is</b>: <tt>true</tt>.</td>
</tr>
- <tr class="b">
+ <tr class="a">
<td><b><a href="#chmodMode">chmodMode</a></b></td>
<td><tt>String</tt></td>
<td><tt>2.1</tt></td>
<td>The mode used by the "chmod" command. Only used if chmod = true.
Defaults to "g+w,a+rX".<br /><b>Default value is</b>: <tt>g+w,a+rX</tt>.</td>
</tr>
- <tr class="a">
+ <tr class="b">
<td><b><a href="#chmodOptions">chmodOptions</a></b></td>
<td><tt>String</tt></td>
<td><tt>2.1</tt></td>
<td>The options used by the "chmod" command. Only used if chmod = true.
Defaults to "-Rf".<br /><b>Default value is</b>: <tt>-Rf</tt>.</td>
</tr>
- <tr class="b">
- <td><b><a href="#generateReports">generateReports</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>-</tt></td>
- <td>Convenience parameter that allows you to disable report generation.<br /><b>Default value is</b>: <tt>true</tt>.</td>
- </tr>
<tr class="a">
- <td><b><a href="#generateSitemap">generateSitemap</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>2.1</tt></td>
- <td>Generate a sitemap. The result will be a "sitemap.html" file at the
-site root.<br /><b>Default value is</b>: <tt>false</tt>.</td>
- </tr>
- <tr class="b">
<td><b><a href="#inputEncoding">inputEncoding</a></b></td>
<td><tt>String</tt></td>
- <td><tt>-</tt></td>
+ <td><tt>2.3</tt></td>
<td>Specifies the input encoding.<br /><b>Default value is</b>: <tt>${project.build.sourceEncoding}</tt>.</td>
</tr>
- <tr class="a">
- <td><b><a href="#localRepository">localRepository</a></b></td>
- <td><tt>ArtifactRepository</tt></td>
- <td><tt>-</tt></td>
- <td>The local repository.<br /><b>Default value is</b>: <tt>${localRepository}</tt>.</td>
- </tr>
<tr class="b">
<td><b><a href="#locales">locales</a></b></td>
<td><tt>String</tt></td>
- <td><tt>-</tt></td>
+ <td><tt>2.3</tt></td>
<td>A comma separated list of locales supported by Maven. The first
valid token will be the default Locale for this instance of the
Java Virtual Machine.<br /></td>
</tr>
<tr class="a">
- <td><b><a href="#moduleExcludes">moduleExcludes</a></b></td>
- <td><tt>Map</tt></td>
- <td><tt>-</tt></td>
- <td>Module type exclusion mappings ex: <tt>fml ->
-**/*-m1.fml</tt> (excludes fml files ending in '-m1.fml'
-recursively)
-
-<p></p>The configuration looks like this:
-
-<div><pre>
- <moduleExcludes>
- <moduleType>filename1.ext,**/*sample.ext</moduleType>
- <!-- moduleType can be one of 'apt', 'fml' or 'xdoc'. -->
- <!-- The value is a comma separated list of -->
- <!-- filenames or fileset patterns. -->
- <!-- Here's an example: -->
- <xdoc>changes.xml,navigation.xml</xdoc>
- </moduleExcludes>
-</pre></div><br /></td>
- </tr>
- <tr class="b">
<td><b><a href="#outputEncoding">outputEncoding</a></b></td>
<td><tt>String</tt></td>
- <td><tt>-</tt></td>
+ <td><tt>2.3</tt></td>
<td>Specifies the output encoding.<br /><b>Default value is</b>: <tt>${project.reporting.outputEncoding}</tt>.</td>
</tr>
- <tr class="a">
- <td><b><a href="#reportPlugins">reportPlugins</a></b></td>
- <td><tt>ReportPlugin[]</tt></td>
- <td><tt>3.0-beta-1</tt></td>
- <td>(no description)<br /></td>
- </tr>
<tr class="b">
- <td><b><a href="#repositories">repositories</a></b></td>
- <td><tt>List</tt></td>
- <td><tt>-</tt></td>
- <td>Remote repositories used for the project.<br /></td>
- </tr>
- <tr class="a">
<td><b><a href="#siteDirectory">siteDirectory</a></b></td>
<td><tt>File</tt></td>
- <td><tt>-</tt></td>
+ <td><tt>2.3</tt></td>
<td>Directory containing the site.xml file and the source for apt, fml
and xdoc docs.<br /><b>Default value is</b>: <tt>${basedir}/src/site</tt>.</td>
</tr>
- <tr class="b">
- <td><b><a href="#stagingDirectory">stagingDirectory</a></b></td>
- <td><tt>File</tt></td>
- <td><tt>-</tt></td>
- <td>Staging directory location. This needs to be an absolute path, like
-<tt>C:\stagingArea\myProject\</tt> on Windows or
-<tt>/stagingArea/myProject/</tt> on Unix.<br /></td>
- </tr>
<tr class="a">
+ <td><b><a href="#skipDeploy">skipDeploy</a></b></td>
+ <td><tt>boolean</tt></td>
+ <td><tt>3.0</tt></td>
+ <td>Set this to 'true' to skip site deployment.<br /><b>Default value is</b>: <tt>false</tt>.</td>
+ </tr>
+ <tr class="b">
<td><b><a href="#stagingRepositoryId">stagingRepositoryId</a></b></td>
<td><tt>String</tt></td>
<td><tt>2.0.1</tt></td>
@@ -452,63 +273,33 @@ deployed. This id will be used to lookup
<tt><server></tt> entry from the
<tt>settings.xml</tt>. If a matching
<tt><server></tt> entry is found, its configured
-credentials will be used for authentication.<br /><b>Default value is</b>: <tt>stagingSite</tt>.</td>
+credentials will be used for authentication. If this is not
+specified, then the corresponding value of
+<tt>distributionManagement.site.id</tt> will be taken as
+default, unless this is not defined either then the String
+<tt>"stagingSite"</tt> is used. (<b>Note</b>: until
+v. 2.3 and 3.0-beta-3 the String <tt>"stagingSite"</tt> is
+always used.)<br /></td>
</tr>
- <tr class="b">
+ <tr class="a">
<td><b><a href="#stagingSiteURL">stagingSiteURL</a></b></td>
<td><tt>String</tt></td>
- <td><tt>-</tt></td>
+ <td><tt>2.3</tt></td>
<td>The staged site will be deployed to this URL. If you don't specify
this, the default-value will be
"${project.distributionManagement.site.url}/staging", where
"project" is either the current project or, in a reactor build, the
-top level project in the reactor.<br /></td>
- </tr>
- <tr class="a">
- <td><b><a href="#template">template</a></b></td>
- <td><tt>String</tt></td>
- <td><tt>-</tt></td>
- <td><b>Deprecated.</b> use templateFile or skinning instead<br /></td>
- </tr>
- <tr class="b">
- <td><b><a href="#templateDirectory">templateDirectory</a></b></td>
- <td><tt>File</tt></td>
- <td><tt>-</tt></td>
- <td><b>Deprecated.</b> use templateFile or skinning instead<br /><b>Default value is</b>: <tt>src/site</tt>.</td>
- </tr>
- <tr class="a">
- <td><b><a href="#templateFile">templateFile</a></b></td>
- <td><tt>File</tt></td>
- <td><tt>2.0-beta-5</tt></td>
- <td>The location of a Velocity template file to use. When used, skins
-and the default templates, CSS and images are disabled. It is
-highly recommended that you package this as a skin instead.<br /></td>
- </tr>
- <tr class="b">
- <td><b><a href="#validate">validate</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>2.1.1</tt></td>
- <td>Whether to validate xml input documents. If set to true,
-<b>all</b> input documents in xml format (in particular
-xdoc and fml) will be validated and any error will lead to a build
-failure.<br /><b>Default value is</b>: <tt>false</tt>.</td>
- </tr>
- <tr class="a">
- <td><b><a href="#xdocDirectory">xdocDirectory</a></b></td>
- <td><tt>File</tt></td>
- <td><tt>-</tt></td>
- <td><b>Deprecated.</b> use the standard m2 directory layout<br /><b>Default value is</b>: <tt>${basedir}/xdocs</tt>.</td>
+top level project in the reactor.
+
+<p>Note that even if you specify this plugin parameter you still
+need to indicate ${project.distributionManagement.site.url} at
+least in your top level project in order for relative links between
+modules to be resolved correctly.</p><br /></td>
</tr>
</table>
</div>
<div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
- <p><b><a name="attributes">attributes</a>:</b></p>
- <div>The template properties for rendering the site.</div>
- <ul>
- <li><b>Type</b>: <tt>java.util.Map</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${attributes}</tt></li>
- </ul><hr /><p><b><a name="chmod">chmod</a>:</b></p>
+ <p><b><a name="chmod">chmod</a>:</b></p>
<div>Whether to run the "chmod" command on the remote site after the
deploy. Defaults to "true".</div>
<ul>
@@ -535,177 +326,89 @@ Defaults to "-Rf".</div>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Expression</b>: <tt>${maven.site.chmod.options}</tt></li>
<li><b>Default</b>: <tt>-Rf</tt></li>
- </ul><hr /><p><b><a name="generateReports">generateReports</a>:</b></p>
- <div>Convenience parameter that allows you to disable report generation.</div>
- <ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${generateReports}</tt></li>
- <li><b>Default</b>: <tt>true</tt></li>
- </ul><hr /><p><b><a name="generateSitemap">generateSitemap</a>:</b></p>
- <div>Generate a sitemap. The result will be a "sitemap.html" file at the
-site root.</div>
- <ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Since</b>: <tt>2.1</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${generateSitemap}</tt></li>
- <li><b>Default</b>: <tt>false</tt></li>
- </ul><hr /><p><b><a name="generatedSiteDirectory">generatedSiteDirectory</a>:</b></p>
- <div>Directory containing generated documentation.</div>
+ </ul><hr /><p><b><a name="inputDirectory">inputDirectory</a>:</b></p>
+ <div>Directory containing the generated project sites and report
+distributions.</div>
<ul>
<li><b>Type</b>: <tt>java.io.File</tt></li>
+ <li><b>Since</b>: <tt>2.3</tt></li>
<li><b>Required</b>: <tt>Yes</tt></li>
- <li><b>Expression</b>: <tt>${project.build.directory}/generated-site</tt></li>
+ <li><b>Expression</b>: <tt>${project.reporting.outputDirectory}</tt></li>
</ul><hr /><p><b><a name="inputEncoding">inputEncoding</a>:</b></p>
<div>Specifies the input encoding.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Since</b>: <tt>2.3</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Expression</b>: <tt>${encoding}</tt></li>
<li><b>Default</b>: <tt>${project.build.sourceEncoding}</tt></li>
- </ul><hr /><p><b><a name="localRepository">localRepository</a>:</b></p>
- <div>The local repository.</div>
- <ul>
- <li><b>Type</b>: <tt>org.apache.maven.artifact.repository.ArtifactRepository</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Default</b>: <tt>${localRepository}</tt></li>
</ul><hr /><p><b><a name="locales">locales</a>:</b></p>
<div>A comma separated list of locales supported by Maven. The first
valid token will be the default Locale for this instance of the
Java Virtual Machine.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Since</b>: <tt>2.3</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Expression</b>: <tt>${locales}</tt></li>
- </ul><hr /><p><b><a name="moduleExcludes">moduleExcludes</a>:</b></p>
- <div>Module type exclusion mappings ex: <tt>fml ->
-**/*-m1.fml</tt> (excludes fml files ending in '-m1.fml'
-recursively)
-
-<p></p>The configuration looks like this:
-
-<div><pre>
- <moduleExcludes>
- <moduleType>filename1.ext,**/*sample.ext</moduleType>
- <!-- moduleType can be one of 'apt', 'fml' or 'xdoc'. -->
- <!-- The value is a comma separated list of -->
- <!-- filenames or fileset patterns. -->
- <!-- Here's an example: -->
- <xdoc>changes.xml,navigation.xml</xdoc>
- </moduleExcludes>
-</pre></div></div>
- <ul>
- <li><b>Type</b>: <tt>java.util.Map</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- </ul><hr /><p><b><a name="outputDirectory">outputDirectory</a>:</b></p>
- <div>Directory containing the generated project sites and report
-distributions.</div>
- <ul>
- <li><b>Type</b>: <tt>java.io.File</tt></li>
- <li><b>Required</b>: <tt>Yes</tt></li>
- <li><b>Expression</b>: <tt>${siteOutputDirectory}</tt></li>
- <li><b>Default</b>: <tt>${project.reporting.outputDirectory}</tt></li>
</ul><hr /><p><b><a name="outputEncoding">outputEncoding</a>:</b></p>
<div>Specifies the output encoding.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Since</b>: <tt>2.3</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Expression</b>: <tt>${outputEncoding}</tt></li>
<li><b>Default</b>: <tt>${project.reporting.outputEncoding}</tt></li>
- </ul><hr /><p><b><a name="reportPlugins">reportPlugins</a>:</b></p>
- <div>(no description)</div>
- <ul>
- <li><b>Type</b>: <tt>org.apache.maven.plugins.site.ReportPlugin[]</tt></li>
- <li><b>Since</b>: <tt>3.0-beta-1</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- </ul><hr /><p><b><a name="repositories">repositories</a>:</b></p>
- <div>Remote repositories used for the project.</div>
- <ul>
- <li><b>Type</b>: <tt>java.util.List</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${project.remoteArtifactRepositories}</tt></li>
</ul><hr /><p><b><a name="siteDirectory">siteDirectory</a>:</b></p>
<div>Directory containing the site.xml file and the source for apt, fml
and xdoc docs.</div>
<ul>
<li><b>Type</b>: <tt>java.io.File</tt></li>
+ <li><b>Since</b>: <tt>2.3</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>${basedir}/src/site</tt></li>
- </ul><hr /><p><b><a name="stagingDirectory">stagingDirectory</a>:</b></p>
- <div>Staging directory location. This needs to be an absolute path, like
-<tt>C:\stagingArea\myProject\</tt> on Windows or
-<tt>/stagingArea/myProject/</tt> on Unix.</div>
+ </ul><hr /><p><b><a name="skipDeploy">skipDeploy</a>:</b></p>
+ <div>Set this to 'true' to skip site deployment.</div>
<ul>
- <li><b>Type</b>: <tt>java.io.File</tt></li>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>Since</b>: <tt>3.0</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${stagingDirectory}</tt></li>
+ <li><b>Expression</b>: <tt>${maven.site.deploy.skip}</tt></li>
+ <li><b>Default</b>: <tt>false</tt></li>
</ul><hr /><p><b><a name="stagingRepositoryId">stagingRepositoryId</a>:</b></p>
<div>The identifier of the repository where the staging site will be
deployed. This id will be used to lookup a corresponding
<tt><server></tt> entry from the
<tt>settings.xml</tt>. If a matching
<tt><server></tt> entry is found, its configured
-credentials will be used for authentication.</div>
+credentials will be used for authentication. If this is not
+specified, then the corresponding value of
+<tt>distributionManagement.site.id</tt> will be taken as
+default, unless this is not defined either then the String
+<tt>"stagingSite"</tt> is used. (<b>Note</b>: until
+v. 2.3 and 3.0-beta-3 the String <tt>"stagingSite"</tt> is
+always used.)</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Since</b>: <tt>2.0.1</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Expression</b>: <tt>${stagingRepositoryId}</tt></li>
- <li><b>Default</b>: <tt>stagingSite</tt></li>
</ul><hr /><p><b><a name="stagingSiteURL">stagingSiteURL</a>:</b></p>
<div>The staged site will be deployed to this URL. If you don't specify
this, the default-value will be
"${project.distributionManagement.site.url}/staging", where
"project" is either the current project or, in a reactor build, the
-top level project in the reactor.</div>
+top level project in the reactor.
+
+<p>Note that even if you specify this plugin parameter you still
+need to indicate ${project.distributionManagement.site.url} at
+least in your top level project in order for relative links between
+modules to be resolved correctly.</p></div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Since</b>: <tt>2.3</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Expression</b>: <tt>${stagingSiteURL}</tt></li>
- </ul><hr /><p><b><a name="template">template</a>:</b></p>
- <div><b>Deprecated.</b> use templateFile or skinning instead</div>
- <div>Default template page.</div>
- <ul>
- <li><b>Type</b>: <tt>java.lang.String</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${template}</tt></li>
- </ul><hr /><p><b><a name="templateDirectory">templateDirectory</a>:</b></p>
- <div><b>Deprecated.</b> use templateFile or skinning instead</div>
- <div>Directory containing the template page.</div>
- <ul>
- <li><b>Type</b>: <tt>java.io.File</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${templateDirectory}</tt></li>
- <li><b>Default</b>: <tt>src/site</tt></li>
- </ul><hr /><p><b><a name="templateFile">templateFile</a>:</b></p>
- <div>The location of a Velocity template file to use. When used, skins
-and the default templates, CSS and images are disabled. It is
-highly recommended that you package this as a skin instead.</div>
- <ul>
- <li><b>Type</b>: <tt>java.io.File</tt></li>
- <li><b>Since</b>: <tt>2.0-beta-5</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${templateFile}</tt></li>
- </ul><hr /><p><b><a name="validate">validate</a>:</b></p>
- <div>Whether to validate xml input documents. If set to true,
-<b>all</b> input documents in xml format (in particular
-xdoc and fml) will be validated and any error will lead to a build
-failure.</div>
- <ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Since</b>: <tt>2.1.1</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${validate}</tt></li>
- <li><b>Default</b>: <tt>false</tt></li>
- </ul><hr /><p><b><a name="xdocDirectory">xdocDirectory</a>:</b></p>
- <div><b>Deprecated.</b> use the standard m2 directory layout</div>
- <div>Alternative directory for xdoc source, useful for m1 to m2
-migration</div>
- <ul>
- <li><b>Type</b>: <tt>java.io.File</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Default</b>: <tt>${basedir}/xdocs</tt></li>
</ul>
</div>
</div>
@@ -717,19 +420,13 @@ migration</div>
<hr/>
</div>
<div id="footer">
- <div class="xright">©
- 2002-2010
-
- The Apache Software Foundation
-
-
-
-
-
+ <div class="xright">
+ © 2002-2011
+ The Apache Software Foundation
-
-
- - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
+ - <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>
Modified: websites/production/maventest/content/plugins/maven-site-plugin-latest/stage-mojo.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-site-plugin-latest/stage-mojo.html (original)
+++ websites/production/maventest/content/plugins/maven-site-plugin-latest/stage-mojo.html Tue May 8 12:09:38 2012
@@ -1,18 +1,8 @@
<!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 Jul 30, 2011 -->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
- <title>Maven Site Plugin -
+ <title>
site:stage</title>
<style type="text/css" media="all">
@import url("./css/maven-base.css");
@@ -20,61 +10,43 @@
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta name="Date-Revision-yyyymmdd" content="20110730" />
+ <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" src="http://www.google-analytics.com/urchin.js"></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>
+ <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>
+ >
+ <a href="../index.html">Plugins</a>
+ >
+ <a href="./">Maven Site Plugin 3</a>
+ >
- <div class="xleft">
-
- <a href="http://www.apache.org/" class="externalLink">Apache</a>
- >
-
- <a href="../../index.html">Maven</a>
- >
-
- <a href="../index.html">Plugins</a>
- >
-
- <a href="http://maven.apache.org/plugins/maven-site-plugin-3.0-beta-3" class="externalLink">Maven Site Plugin</a>
- </div>
- <div class="xright">
-
-
-
-
-
-
-
- Last Published: 2010-10-18
- | Version: 3.0-beta-3
+ site:stage
+ </div>
+ <div class="xright">
+ Last Published: 2011-07-30
+ | Version: 3.0
</div>
<div class="clear">
<hr/>
@@ -82,203 +54,117 @@
</div>
<div id="leftColumn">
<div id="navcolumn">
-
-
-
-
-
-
-
-
- <h5>Overview</h5>
- <ul>
-
- <li class="none">
- <a href="index.html">Introduction</a>
- </li>
-
- <li class="none">
- <a href="plugin-info.html">Goals</a>
- </li>
-
- <li class="none">
- <a href="usage.html">Usage</a>
- </li>
-
- <li class="none">
- <a href="faq.html">FAQ</a>
- </li>
-
- <li class="none">
- <a href="migrate.html">Migrate</a>
- </li>
-
- <li class="none">
- <a href="maven-3.html">Maven 3</a>
- </li>
+
+ <h5>Overview</h5>
+ <ul>
+ <li class="none">
+ <a href="index.html">Introduction</a>
+ </li>
+ <li class="none">
+ <a href="plugin-info.html">Goals</a>
+ </li>
+ <li class="none">
+ <a href="usage.html">Usage</a>
+ </li>
+ <li class="none">
+ <a href="faq.html">FAQ</a>
+ </li>
+ <li class="none">
+ <a href="migrate.html">Migrate</a>
+ </li>
+ <li class="none">
+ <a href="maven-3.html">Maven 3</a>
+ </li>
</ul>
- <h5>Configuration</h5>
- <ul>
-
- <li class="none">
- <a href="i18n.html">Internationalization</a>
- </li>
+ <h5>Configuration</h5>
+ <ul>
+ <li class="none">
+ <a href="i18n.html">Internationalization</a>
+ </li>
</ul>
- <h5>Examples</h5>
- <ul>
-
- <li class="none">
- <a href="examples/creating-content.html">Creating Content</a>
- </li>
-
- <li class="none">
- <a href="examples/sitedescriptor.html">Configuring the Site Descriptor</a>
- </li>
-
- <li class="none">
- <a href="examples/configuring-reports.html">Configuring Reports</a>
- </li>
-
- <li class="none">
- <a href="examples/siterun.html">Configuring Site Run</a>
- </li>
-
- <li class="none">
- <a href="examples/templatefile.html">Changing the Template File</a>
- </li>
-
- <li class="none">
- <a href="examples/creatingskins.html">Creating Skins</a>
- </li>
-
- <li class="none">
- <a href="examples/moduleexcludes.html">Excluding Document Formats</a>
- </li>
-
- <li class="none">
- <a href="examples/site-deploy-to-sourceforge.net.html">Deploying to sourceforge.net</a>
- </li>
+ <h5>Examples</h5>
+ <ul>
+ <li class="none">
+ <a href="examples/creating-content.html">Creating Content</a>
+ </li>
+ <li class="none">
+ <a href="examples/sitedescriptor.html">Configuring the Site Descriptor</a>
+ </li>
+ <li class="none">
+ <a href="examples/multimodule.html">Building a multi-module site</a>
+ </li>
+ <li class="none">
+ <a href="examples/configuring-reports.html">Configuring Reports</a>
+ </li>
+ <li class="none">
+ <a href="examples/siterun.html">Configuring Site Run</a>
+ </li>
+ <li class="none">
+ <a href="examples/adding-deploy-protocol.html">Adding a Protocol to Deploy the Site</a>
+ </li>
+ <li class="none">
+ <a href="examples/templatefile.html">Changing the Template File</a>
+ </li>
+ <li class="none">
+ <a href="examples/creatingskins.html">Creating Skins</a>
+ </li>
+ <li class="none">
+ <a href="examples/moduleexcludes.html">Excluding Document Formats</a>
+ </li>
+ <li class="none">
+ <a href="examples/site-deploy-to-sourceforge.net.html">Deploying to sourceforge.net</a>
+ </li>
</ul>
- <h5>Project Documentation</h5>
- <ul>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="collapsed">
- <a href="project-info.html">Project Information</a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="collapsed">
- <a href="project-reports.html">Project Reports</a>
- </li>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="project-info.html">Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="project-reports.html">Project Reports</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="../../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</a>
- </li>
-
- <li class="none">
- <a href="../../mercury/index.html">Mercury</a>
- </li>
-
- <li class="none">
- <a href="../index.html">Plugins</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="../../surefire/index.html">Surefire</a>
- </li>
-
- <li class="none">
- <a href="../../wagon/index.html">Wagon</a>
- </li>
+ <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</a>
+ </li>
+ <li class="none">
+ <a href="../index.html">Plugins</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="../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../wagon/index.html">Wagon</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"></img>
- </a>
+ <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>
<div id="bodyColumn">
<div id="contentBox">
@@ -286,7 +172,7 @@
<div class="section"><h2>site:stage<a name="site:stage"></a></h2>
<p><b>Full name</b>:</p>
- <p>org.apache.maven.plugins:maven-site-plugin:3.0-beta-3:stage</p>
+ <p>org.apache.maven.plugins:maven-site-plugin:3.0:stage</p>
<p><b>Description</b>:</p>
<div>Generates a site in a local staging or mock directory based on the
site URL specified in the
@@ -296,11 +182,12 @@ site URL specified in the
multi module build works.</p></div>
<p><b>Attributes</b>:</p>
<ul>
- <li>Requires a Maven 2.0 project to be executed.</li>
+ <li>Requires a Maven project to be executed.</li>
<li>Requires dependency resolution of artifacts in scope: <tt>test</tt>.</li>
+ <li>Since version: <tt>2.3</tt>.</li>
</ul>
<div class="section"><h3>Required Parameters<a name="Required_Parameters"></a></h3>
- <table class="bodyTable" border="0" align="left">
+ <table class="bodyTable" border="0">
<tr class="a">
<th>Name</th>
<th>Type</th>
@@ -308,22 +195,16 @@ multi module build works.</p></div>
<th>Description</th>
</tr>
<tr class="b">
- <td><b><a href="#generatedSiteDirectory">generatedSiteDirectory</a></b></td>
- <td><tt>File</tt></td>
- <td><tt>-</tt></td>
- <td>Directory containing generated documentation.<br /></td>
- </tr>
- <tr class="a">
- <td><b><a href="#outputDirectory">outputDirectory</a></b></td>
+ <td><b><a href="#inputDirectory">inputDirectory</a></b></td>
<td><tt>File</tt></td>
- <td><tt>-</tt></td>
+ <td><tt>2.3</tt></td>
<td>Directory containing the generated project sites and report
-distributions.<br /><b>Default value is</b>: <tt>${project.reporting.outputDirectory}</tt>.</td>
+distributions.<br /></td>
</tr>
</table>
</div>
<div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
- <table class="bodyTable" border="0" align="left">
+ <table class="bodyTable" border="0">
<tr class="a">
<th>Name</th>
<th>Type</th>
@@ -331,290 +212,159 @@ distributions.<br /><b>Default value is<
<th>Description</th>
</tr>
<tr class="b">
- <td><b><a href="#attributes">attributes</a></b></td>
- <td><tt>Map</tt></td>
- <td><tt>-</tt></td>
- <td>The template properties for rendering the site.<br /></td>
+ <td><b><a href="#chmod">chmod</a></b></td>
+ <td><tt>boolean</tt></td>
+ <td><tt>2.1</tt></td>
+ <td>Whether to run the "chmod" command on the remote site after the
+deploy. Defaults to "true".<br /><b>Default value is</b>: <tt>true</tt>.</td>
</tr>
<tr class="a">
- <td><b><a href="#generateReports">generateReports</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>-</tt></td>
- <td>Convenience parameter that allows you to disable report generation.<br /><b>Default value is</b>: <tt>true</tt>.</td>
+ <td><b><a href="#chmodMode">chmodMode</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>2.1</tt></td>
+ <td>The mode used by the "chmod" command. Only used if chmod = true.
+Defaults to "g+w,a+rX".<br /><b>Default value is</b>: <tt>g+w,a+rX</tt>.</td>
</tr>
<tr class="b">
- <td><b><a href="#generateSitemap">generateSitemap</a></b></td>
- <td><tt>boolean</tt></td>
+ <td><b><a href="#chmodOptions">chmodOptions</a></b></td>
+ <td><tt>String</tt></td>
<td><tt>2.1</tt></td>
- <td>Generate a sitemap. The result will be a "sitemap.html" file at the
-site root.<br /><b>Default value is</b>: <tt>false</tt>.</td>
+ <td>The options used by the "chmod" command. Only used if chmod = true.
+Defaults to "-Rf".<br /><b>Default value is</b>: <tt>-Rf</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#inputEncoding">inputEncoding</a></b></td>
<td><tt>String</tt></td>
- <td><tt>-</tt></td>
+ <td><tt>2.3</tt></td>
<td>Specifies the input encoding.<br /><b>Default value is</b>: <tt>${project.build.sourceEncoding}</tt>.</td>
</tr>
<tr class="b">
- <td><b><a href="#localRepository">localRepository</a></b></td>
- <td><tt>ArtifactRepository</tt></td>
- <td><tt>-</tt></td>
- <td>The local repository.<br /><b>Default value is</b>: <tt>${localRepository}</tt>.</td>
- </tr>
- <tr class="a">
<td><b><a href="#locales">locales</a></b></td>
<td><tt>String</tt></td>
- <td><tt>-</tt></td>
+ <td><tt>2.3</tt></td>
<td>A comma separated list of locales supported by Maven. The first
valid token will be the default Locale for this instance of the
Java Virtual Machine.<br /></td>
</tr>
- <tr class="b">
- <td><b><a href="#moduleExcludes">moduleExcludes</a></b></td>
- <td><tt>Map</tt></td>
- <td><tt>-</tt></td>
- <td>Module type exclusion mappings ex: <tt>fml ->
-**/*-m1.fml</tt> (excludes fml files ending in '-m1.fml'
-recursively)
-
-<p></p>The configuration looks like this:
-
-<div><pre>
- <moduleExcludes>
- <moduleType>filename1.ext,**/*sample.ext</moduleType>
- <!-- moduleType can be one of 'apt', 'fml' or 'xdoc'. -->
- <!-- The value is a comma separated list of -->
- <!-- filenames or fileset patterns. -->
- <!-- Here's an example: -->
- <xdoc>changes.xml,navigation.xml</xdoc>
- </moduleExcludes>
-</pre></div><br /></td>
- </tr>
<tr class="a">
<td><b><a href="#outputEncoding">outputEncoding</a></b></td>
<td><tt>String</tt></td>
- <td><tt>-</tt></td>
+ <td><tt>2.3</tt></td>
<td>Specifies the output encoding.<br /><b>Default value is</b>: <tt>${project.reporting.outputEncoding}</tt>.</td>
</tr>
<tr class="b">
- <td><b><a href="#reportPlugins">reportPlugins</a></b></td>
- <td><tt>ReportPlugin[]</tt></td>
- <td><tt>3.0-beta-1</tt></td>
- <td>(no description)<br /></td>
- </tr>
- <tr class="a">
- <td><b><a href="#repositories">repositories</a></b></td>
- <td><tt>List</tt></td>
- <td><tt>-</tt></td>
- <td>Remote repositories used for the project.<br /></td>
- </tr>
- <tr class="b">
<td><b><a href="#siteDirectory">siteDirectory</a></b></td>
<td><tt>File</tt></td>
- <td><tt>-</tt></td>
+ <td><tt>2.3</tt></td>
<td>Directory containing the site.xml file and the source for apt, fml
and xdoc docs.<br /><b>Default value is</b>: <tt>${basedir}/src/site</tt>.</td>
</tr>
<tr class="a">
- <td><b><a href="#stagingDirectory">stagingDirectory</a></b></td>
- <td><tt>File</tt></td>
- <td><tt>-</tt></td>
- <td>Staging directory location. This needs to be an absolute path, like
-<tt>C:\stagingArea\myProject\</tt> on Windows or
-<tt>/stagingArea/myProject/</tt> on Unix.<br /></td>
- </tr>
- <tr class="b">
- <td><b><a href="#template">template</a></b></td>
- <td><tt>String</tt></td>
- <td><tt>-</tt></td>
- <td><b>Deprecated.</b> use templateFile or skinning instead<br /></td>
- </tr>
- <tr class="a">
- <td><b><a href="#templateDirectory">templateDirectory</a></b></td>
- <td><tt>File</tt></td>
- <td><tt>-</tt></td>
- <td><b>Deprecated.</b> use templateFile or skinning instead<br /><b>Default value is</b>: <tt>src/site</tt>.</td>
- </tr>
- <tr class="b">
- <td><b><a href="#templateFile">templateFile</a></b></td>
- <td><tt>File</tt></td>
- <td><tt>2.0-beta-5</tt></td>
- <td>The location of a Velocity template file to use. When used, skins
-and the default templates, CSS and images are disabled. It is
-highly recommended that you package this as a skin instead.<br /></td>
- </tr>
- <tr class="a">
- <td><b><a href="#validate">validate</a></b></td>
+ <td><b><a href="#skipDeploy">skipDeploy</a></b></td>
<td><tt>boolean</tt></td>
- <td><tt>2.1.1</tt></td>
- <td>Whether to validate xml input documents. If set to true,
-<b>all</b> input documents in xml format (in particular
-xdoc and fml) will be validated and any error will lead to a build
-failure.<br /><b>Default value is</b>: <tt>false</tt>.</td>
+ <td><tt>3.0</tt></td>
+ <td>Set this to 'true' to skip site deployment.<br /><b>Default value is</b>: <tt>false</tt>.</td>
</tr>
<tr class="b">
- <td><b><a href="#xdocDirectory">xdocDirectory</a></b></td>
+ <td><b><a href="#stagingDirectory">stagingDirectory</a></b></td>
<td><tt>File</tt></td>
- <td><tt>-</tt></td>
- <td><b>Deprecated.</b> use the standard m2 directory layout<br /><b>Default value is</b>: <tt>${basedir}/xdocs</tt>.</td>
+ <td><tt>2.3</tt></td>
+ <td>Staging directory location. This needs to be an absolute path, like
+<tt>C:\stagingArea\myProject\</tt> on Windows or
+<tt>/stagingArea/myProject/</tt> on Unix. If this is not
+specified, the site will be staged in
+${project.build.directory}/staging.<br /></td>
</tr>
</table>
</div>
<div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
- <p><b><a name="attributes">attributes</a>:</b></p>
- <div>The template properties for rendering the site.</div>
- <ul>
- <li><b>Type</b>: <tt>java.util.Map</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${attributes}</tt></li>
- </ul><hr /><p><b><a name="generateReports">generateReports</a>:</b></p>
- <div>Convenience parameter that allows you to disable report generation.</div>
+ <p><b><a name="chmod">chmod</a>:</b></p>
+ <div>Whether to run the "chmod" command on the remote site after the
+deploy. Defaults to "true".</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>Since</b>: <tt>2.1</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${generateReports}</tt></li>
+ <li><b>Expression</b>: <tt>${maven.site.chmod}</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr /><p><b><a name="generateSitemap">generateSitemap</a>:</b></p>
- <div>Generate a sitemap. The result will be a "sitemap.html" file at the
-site root.</div>
+ </ul><hr /><p><b><a name="chmodMode">chmodMode</a>:</b></p>
+ <div>The mode used by the "chmod" command. Only used if chmod = true.
+Defaults to "g+w,a+rX".</div>
<ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Since</b>: <tt>2.1</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${generateSitemap}</tt></li>
- <li><b>Default</b>: <tt>false</tt></li>
- </ul><hr /><p><b><a name="generatedSiteDirectory">generatedSiteDirectory</a>:</b></p>
- <div>Directory containing generated documentation.</div>
+ <li><b>Expression</b>: <tt>${maven.site.chmod.mode}</tt></li>
+ <li><b>Default</b>: <tt>g+w,a+rX</tt></li>
+ </ul><hr /><p><b><a name="chmodOptions">chmodOptions</a>:</b></p>
+ <div>The options used by the "chmod" command. Only used if chmod = true.
+Defaults to "-Rf".</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Since</b>: <tt>2.1</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${maven.site.chmod.options}</tt></li>
+ <li><b>Default</b>: <tt>-Rf</tt></li>
+ </ul><hr /><p><b><a name="inputDirectory">inputDirectory</a>:</b></p>
+ <div>Directory containing the generated project sites and report
+distributions.</div>
<ul>
<li><b>Type</b>: <tt>java.io.File</tt></li>
+ <li><b>Since</b>: <tt>2.3</tt></li>
<li><b>Required</b>: <tt>Yes</tt></li>
- <li><b>Expression</b>: <tt>${project.build.directory}/generated-site</tt></li>
+ <li><b>Expression</b>: <tt>${project.reporting.outputDirectory}</tt></li>
</ul><hr /><p><b><a name="inputEncoding">inputEncoding</a>:</b></p>
<div>Specifies the input encoding.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Since</b>: <tt>2.3</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Expression</b>: <tt>${encoding}</tt></li>
<li><b>Default</b>: <tt>${project.build.sourceEncoding}</tt></li>
- </ul><hr /><p><b><a name="localRepository">localRepository</a>:</b></p>
- <div>The local repository.</div>
- <ul>
- <li><b>Type</b>: <tt>org.apache.maven.artifact.repository.ArtifactRepository</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Default</b>: <tt>${localRepository}</tt></li>
</ul><hr /><p><b><a name="locales">locales</a>:</b></p>
<div>A comma separated list of locales supported by Maven. The first
valid token will be the default Locale for this instance of the
Java Virtual Machine.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Since</b>: <tt>2.3</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Expression</b>: <tt>${locales}</tt></li>
- </ul><hr /><p><b><a name="moduleExcludes">moduleExcludes</a>:</b></p>
- <div>Module type exclusion mappings ex: <tt>fml ->
-**/*-m1.fml</tt> (excludes fml files ending in '-m1.fml'
-recursively)
-
-<p></p>The configuration looks like this:
-
-<div><pre>
- <moduleExcludes>
- <moduleType>filename1.ext,**/*sample.ext</moduleType>
- <!-- moduleType can be one of 'apt', 'fml' or 'xdoc'. -->
- <!-- The value is a comma separated list of -->
- <!-- filenames or fileset patterns. -->
- <!-- Here's an example: -->
- <xdoc>changes.xml,navigation.xml</xdoc>
- </moduleExcludes>
-</pre></div></div>
- <ul>
- <li><b>Type</b>: <tt>java.util.Map</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- </ul><hr /><p><b><a name="outputDirectory">outputDirectory</a>:</b></p>
- <div>Directory containing the generated project sites and report
-distributions.</div>
- <ul>
- <li><b>Type</b>: <tt>java.io.File</tt></li>
- <li><b>Required</b>: <tt>Yes</tt></li>
- <li><b>Expression</b>: <tt>${siteOutputDirectory}</tt></li>
- <li><b>Default</b>: <tt>${project.reporting.outputDirectory}</tt></li>
</ul><hr /><p><b><a name="outputEncoding">outputEncoding</a>:</b></p>
<div>Specifies the output encoding.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Since</b>: <tt>2.3</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Expression</b>: <tt>${outputEncoding}</tt></li>
<li><b>Default</b>: <tt>${project.reporting.outputEncoding}</tt></li>
- </ul><hr /><p><b><a name="reportPlugins">reportPlugins</a>:</b></p>
- <div>(no description)</div>
- <ul>
- <li><b>Type</b>: <tt>org.apache.maven.plugins.site.ReportPlugin[]</tt></li>
- <li><b>Since</b>: <tt>3.0-beta-1</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- </ul><hr /><p><b><a name="repositories">repositories</a>:</b></p>
- <div>Remote repositories used for the project.</div>
- <ul>
- <li><b>Type</b>: <tt>java.util.List</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${project.remoteArtifactRepositories}</tt></li>
</ul><hr /><p><b><a name="siteDirectory">siteDirectory</a>:</b></p>
<div>Directory containing the site.xml file and the source for apt, fml
and xdoc docs.</div>
<ul>
<li><b>Type</b>: <tt>java.io.File</tt></li>
+ <li><b>Since</b>: <tt>2.3</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>${basedir}/src/site</tt></li>
- </ul><hr /><p><b><a name="stagingDirectory">stagingDirectory</a>:</b></p>
- <div>Staging directory location. This needs to be an absolute path, like
-<tt>C:\stagingArea\myProject\</tt> on Windows or
-<tt>/stagingArea/myProject/</tt> on Unix.</div>
- <ul>
- <li><b>Type</b>: <tt>java.io.File</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${stagingDirectory}</tt></li>
- </ul><hr /><p><b><a name="template">template</a>:</b></p>
- <div><b>Deprecated.</b> use templateFile or skinning instead</div>
- <div>Default template page.</div>
- <ul>
- <li><b>Type</b>: <tt>java.lang.String</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${template}</tt></li>
- </ul><hr /><p><b><a name="templateDirectory">templateDirectory</a>:</b></p>
- <div><b>Deprecated.</b> use templateFile or skinning instead</div>
- <div>Directory containing the template page.</div>
- <ul>
- <li><b>Type</b>: <tt>java.io.File</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${templateDirectory}</tt></li>
- <li><b>Default</b>: <tt>src/site</tt></li>
- </ul><hr /><p><b><a name="templateFile">templateFile</a>:</b></p>
- <div>The location of a Velocity template file to use. When used, skins
-and the default templates, CSS and images are disabled. It is
-highly recommended that you package this as a skin instead.</div>
- <ul>
- <li><b>Type</b>: <tt>java.io.File</tt></li>
- <li><b>Since</b>: <tt>2.0-beta-5</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${templateFile}</tt></li>
- </ul><hr /><p><b><a name="validate">validate</a>:</b></p>
- <div>Whether to validate xml input documents. If set to true,
-<b>all</b> input documents in xml format (in particular
-xdoc and fml) will be validated and any error will lead to a build
-failure.</div>
+ </ul><hr /><p><b><a name="skipDeploy">skipDeploy</a>:</b></p>
+ <div>Set this to 'true' to skip site deployment.</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Since</b>: <tt>2.1.1</tt></li>
+ <li><b>Since</b>: <tt>3.0</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${validate}</tt></li>
+ <li><b>Expression</b>: <tt>${maven.site.deploy.skip}</tt></li>
<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr /><p><b><a name="xdocDirectory">xdocDirectory</a>:</b></p>
- <div><b>Deprecated.</b> use the standard m2 directory layout</div>
- <div>Alternative directory for xdoc source, useful for m1 to m2
-migration</div>
+ </ul><hr /><p><b><a name="stagingDirectory">stagingDirectory</a>:</b></p>
+ <div>Staging directory location. This needs to be an absolute path, like
+<tt>C:\stagingArea\myProject\</tt> on Windows or
+<tt>/stagingArea/myProject/</tt> on Unix. If this is not
+specified, the site will be staged in
+${project.build.directory}/staging.</div>
<ul>
<li><b>Type</b>: <tt>java.io.File</tt></li>
+ <li><b>Since</b>: <tt>2.3</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
- <li><b>Default</b>: <tt>${basedir}/xdocs</tt></li>
+ <li><b>Expression</b>: <tt>${stagingDirectory}</tt></li>
</ul>
</div>
</div>
@@ -626,19 +376,13 @@ migration</div>
<hr/>
</div>
<div id="footer">
- <div class="xright">©
- 2002-2010
-
- The Apache Software Foundation
-
-
-
-
-
+ <div class="xright">
+ © 2002-2011
+ The Apache Software Foundation
-
-
- - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
+ - <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>