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 [24/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/site-mojo.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-site-plugin-latest/site-mojo.html (original)
+++ websites/production/maventest/content/plugins/maven-site-plugin-latest/site-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:site</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="http://maven.apache.org/plugins/maven-site-plugin-3.0-beta-3" class="externalLink">Maven Site Plugin</a>
- </div>
- <div class="xright">
-
-
-
-
-
-
+ <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>
+ >
- Last Published: 2010-10-18
- | Version: 3.0-beta-3
+ site:site
+ </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:site<a name="site:site"></a></h2>
<p><b>Full name</b>:</p>
- <p>org.apache.maven.plugins:maven-site-plugin:3.0-beta-3:site</p>
+ <p>org.apache.maven.plugins:maven-site-plugin:3.0:site</p>
<p><b>Description</b>:</p>
<div>Generates the site for a single project.
@@ -294,34 +180,11 @@
will <b>not</b> work.</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>
</ul>
- <div class="section"><h3>Required Parameters<a name="Required_Parameters"></a></h3>
- <table class="bodyTable" border="0" align="left">
- <tr class="a">
- <th>Name</th>
- <th>Type</th>
- <th>Since</th>
- <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><tt>File</tt></td>
- <td><tt>-</tt></td>
- <td>Directory containing the generated project sites and report
-distributions.<br /><b>Default value is</b>: <tt>${project.reporting.outputDirectory}</tt>.</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>
@@ -335,18 +198,32 @@ distributions.<br /><b>Default value is<
<td>The template properties for rendering the site.<br /></td>
</tr>
<tr class="a">
+ <td><b><a href="#generateProjectInfo">generateProjectInfo</a></b></td>
+ <td><tt>boolean</tt></td>
+ <td><tt>2.3</tt></td>
+ <td>Whether to generate the summary page for project reports:
+project-info.html.<br /><b>Default value is</b>: <tt>true</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="b">
+ <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="#generatedSiteDirectory">generatedSiteDirectory</a></b></td>
+ <td><tt>File</tt></td>
+ <td><tt>-</tt></td>
+ <td>Directory containing generated documentation. This is used to pick
+up other source docs that might have been generated at build time.<br /><b>Default value is</b>: <tt>${project.build.directory}/generated-site</tt>.</td>
+ </tr>
<tr class="a">
<td><b><a href="#inputEncoding">inputEncoding</a></b></td>
<td><tt>String</tt></td>
@@ -354,12 +231,6 @@ site root.<br /><b>Default value is</b>:
<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>
@@ -367,7 +238,7 @@ site root.<br /><b>Default value is</b>:
valid token will be the default Locale for this instance of the
Java Virtual Machine.<br /></td>
</tr>
- <tr class="b">
+ <tr class="a">
<td><b><a href="#moduleExcludes">moduleExcludes</a></b></td>
<td><tt>Map</tt></td>
<td><tt>-</tt></td>
@@ -388,6 +259,13 @@ recursively)
</moduleExcludes>
</pre></div><br /></td>
</tr>
+ <tr class="b">
+ <td><b><a href="#outputDirectory">outputDirectory</a></b></td>
+ <td><tt>File</tt></td>
+ <td><tt>-</tt></td>
+ <td>Directory where the project sites and report distributions will be
+generated.<br /><b>Default value is</b>: <tt>${project.reporting.outputDirectory}</tt>.</td>
+ </tr>
<tr class="a">
<td><b><a href="#outputEncoding">outputEncoding</a></b></td>
<td><tt>String</tt></td>
@@ -395,16 +273,20 @@ recursively)
<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="#relativizeDecorationLinks">relativizeDecorationLinks</a></b></td>
+ <td><tt>boolean</tt></td>
+ <td><tt>2.3</tt></td>
+ <td>Make links in the site descriptor relative to the project URL. By
+default, any absolute links that appear in the site descriptor,
+e.g. banner hrefs, breadcrumbs, menu links, etc., will be made
+relative to project.url. Links will not be changed if this is set
+to false, or if the project has no URL defined.<br /><b>Default value is</b>: <tt>true</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="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>
+ <td>Report plugins (Maven 3).<br /></td>
</tr>
<tr class="b">
<td><b><a href="#siteDirectory">siteDirectory</a></b></td>
@@ -414,18 +296,24 @@ recursively)
and xdoc docs.<br /><b>Default value is</b>: <tt>${basedir}/src/site</tt>.</td>
</tr>
<tr class="a">
+ <td><b><a href="#skip">skip</a></b></td>
+ <td><tt>boolean</tt></td>
+ <td><tt>3.0</tt></td>
+ <td>Set this to 'true' to skip site generation.<br /><b>Default value is</b>: <tt>false</tt>.</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="b">
+ <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="a">
+ <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>
@@ -433,7 +321,7 @@ and xdoc docs.<br /><b>Default value is<
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">
+ <tr class="a">
<td><b><a href="#validate">validate</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>2.1.1</tt></td>
@@ -442,7 +330,7 @@ highly recommended that you package this
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">
+ <tr class="b">
<td><b><a href="#xdocDirectory">xdocDirectory</a></b></td>
<td><tt>File</tt></td>
<td><tt>-</tt></td>
@@ -456,7 +344,15 @@ failure.<br /><b>Default value is</b>: <
<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="generateProjectInfo">generateProjectInfo</a>:</b></p>
+ <div>Whether to generate the summary page for project reports:
+project-info.html.</div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>Since</b>: <tt>2.3</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${generateProjectInfo}</tt></li>
+ <li><b>Default</b>: <tt>true</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>
@@ -474,11 +370,12 @@ site root.</div>
<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>
+ <div>Directory containing generated documentation. This is used to pick
+up other source docs that might have been generated at build time.</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>${project.build.directory}/generated-site</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Default</b>: <tt>${project.build.directory}/generated-site</tt></li>
</ul><hr /><p><b><a name="inputEncoding">inputEncoding</a>:</b></p>
<div>Specifies the input encoding.</div>
<ul>
@@ -486,12 +383,6 @@ site root.</div>
<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
@@ -521,11 +412,11 @@ recursively)
<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>
+ <div>Directory where the project sites and report distributions will be
+generated.</div>
<ul>
<li><b>Type</b>: <tt>java.io.File</tt></li>
- <li><b>Required</b>: <tt>Yes</tt></li>
+ <li><b>Required</b>: <tt>No</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>
@@ -535,18 +426,24 @@ distributions.</div>
<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><hr /><p><b><a name="relativizeDecorationLinks">relativizeDecorationLinks</a>:</b></p>
+ <div>Make links in the site descriptor relative to the project URL. By
+default, any absolute links that appear in the site descriptor,
+e.g. banner hrefs, breadcrumbs, menu links, etc., will be made
+relative to project.url. Links will not be changed if this is set
+to false, or if the project has no URL defined.</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>Type</b>: <tt>boolean</tt></li>
+ <li><b>Since</b>: <tt>2.3</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>
+ <li><b>Expression</b>: <tt>${relativizeDecorationLinks}</tt></li>
+ <li><b>Default</b>: <tt>true</tt></li>
+ </ul><hr /><p><b><a name="reportPlugins">reportPlugins</a>:</b></p>
+ <div>Report plugins (Maven 3).</div>
<ul>
- <li><b>Type</b>: <tt>java.util.List</tt></li>
+ <li><b>Type</b>: <tt>org.apache.maven.reporting.exec.ReportPlugin[]</tt></li>
+ <li><b>Since</b>: <tt>3.0-beta-1</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>
@@ -554,6 +451,14 @@ and xdoc docs.</div>
<li><b>Type</b>: <tt>java.io.File</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="skip">skip</a>:</b></p>
+ <div>Set this to 'true' to skip site generation.</div>
+ <ul>
+ <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>${maven.site.skip}</tt></li>
+ <li><b>Default</b>: <tt>false</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>
@@ -608,19 +513,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/source-repository.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-site-plugin-latest/source-repository.html (original)
+++ websites/production/maventest/content/plugins/maven-site-plugin-latest/source-repository.html Tue May 8 12:09:38 2012
@@ -1,79 +1,50 @@
<!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 - Source Repository</title>
+ <title>Source Repository</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 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="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
+ <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>
+ >
+ Source Repository
+ </div>
+ <div class="xright">
+ Last Published: 2011-07-30
+ | Version: 3.0
</div>
<div class="clear">
<hr/>
@@ -81,253 +52,156 @@
</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="expanded">
- <a href="project-info.html">Project Information</a>
+ <h5>Project Documentation</h5>
<ul>
-
- <li class="none">
- <a href="index.html">About</a>
- </li>
-
- <li class="none">
- <a href="integration.html">Continuous Integration</a>
- </li>
-
- <li class="none">
- <a href="dependencies.html">Dependencies</a>
- </li>
-
- <li class="none">
- <a href="issue-tracking.html">Issue Tracking</a>
- </li>
-
- <li class="none">
- <a href="mail-lists.html">Mailing Lists</a>
- </li>
-
- <li class="none">
- <a href="plugin-management.html">Plugin Management</a>
- </li>
-
- <li class="none">
- <a href="license.html">Project License</a>
- </li>
-
- <li class="none">
- <a href="plugins.html">Project Plugins</a>
- </li>
-
- <li class="none">
- <a href="project-summary.html">Project Summary</a>
- </li>
-
- <li class="none">
- <a href="team-list.html">Project Team</a>
- </li>
-
- <li class="none">
- <strong>Source Repository</strong>
- </li>
+ <li class="expanded">
+ <a href="project-info.html">Project Information</a>
+ <ul>
+ <li class="none">
+ <strong>Source Repository</strong>
+ </li>
+ <li class="none">
+ <a href="distribution-management.html">Distribution Management</a>
+ </li>
+ <li class="none">
+ <a href="dependencies.html">Dependencies</a>
+ </li>
+ <li class="none">
+ <a href="plugin-management.html">Plugin Management</a>
+ </li>
+ <li class="none">
+ <a href="integration.html">Continuous Integration</a>
+ </li>
+ <li class="none">
+ <a href="project-summary.html">Project Summary</a>
+ </li>
+ <li class="none">
+ <a href="mail-lists.html">Mailing Lists</a>
+ </li>
+ <li class="none">
+ <a href="plugins.html">Project Plugins</a>
+ </li>
+ <li class="none">
+ <a href="team-list.html">Project Team</a>
+ </li>
+ <li class="none">
+ <a href="license.html">Project License</a>
+ </li>
+ <li class="none">
+ <a href="issue-tracking.html">Issue Tracking</a>
+ </li>
</ul>
</li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="collapsed">
- <a href="project-reports.html">Project Reports</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">
- <div class="section"><h2>Overview<a name="Overview"></a></h2><a name="Overview"></a><p>This project uses <a class="externalLink" href="http://subversion.apache.org/">Subversion</a> to manage its source code. Instructions on Subversion use can be found at <a class="externalLink" href="http://svnbook.red-bean.com/">http://svnbook.red-bean.com/</a>.</p></div><div class="section"><h2>Web Access<a name="Web_Access"></a></h2><a name="Web_Access"></a><p>The following is a link to the online source repository.</p><div class="source"><pre><a class="externalLink" href="http://svn.apache.org/viewvc/maven/plugins/tags/maven-site-plugin-3.0-beta-3">http://svn.apache.org/viewvc/maven/plugins/tags/maven-site-plugin-3.0-beta-3</a></pre></div></div><div class="section"><h2>Anonymous access<a name="Anonymous_access"></a></h2><a name="Anonymous_access"></a><p>The source can be checked out anonymously from SVN with this command:</p><div class="source"><pre>$ svn checkout http://svn.apac
he.org/repos/asf/maven/plugins/tags/maven-site-plugin-3.0-beta-3 maven-site-plugin</pre></div></div><div class="section"><h2>Developer access<a name="Developer_access"></a></h2><a name="Developer_access"></a><p>Everyone can access the Subversion repository via HTTP, but Committers must checkout the Subversion repository via HTTPS.</p><div class="source"><pre>$ svn checkout https://svn.apache.org/repos/asf/maven/plugins/tags/maven-site-plugin-3.0-beta-3 maven-site-plugin</pre></div><p>To commit changes to the repository, execute the following command to commit your changes (svn will prompt you for your password)</p><div class="source"><pre>$ svn commit --username your-username -m "A message"</pre></div></div><div class="section"><h2>Access from behind a firewall<a name="Access_from_behind_a_firewall"></a></h2><a name="Access_from_behind_a_firewall"></a><p>For those users who are stuck behind a corporate firewall which is blocking HTTP access to the Subversion reposi
tory, you can try to access it via the developer connection:</p><div class="source"><pre>$ svn checkout https://svn.apache.org/repos/asf/maven/plugins/tags/maven-site-plugin-3.0-beta-3 maven-site-plugin</pre></div></div><div class="section"><h2>Access through a proxy<a name="Access_through_a_proxy"></a></h2><a name="Access_through_a_proxy"></a><p>The Subversion client can go through a proxy, if you configure it to do so. First, edit your "servers" configuration file to indicate which proxy to use. The file's location depends on your operating system. On Linux or Unix it is located in the directory "~/.subversion". On Windows it is in "%APPDATA%\Subversion". (Try "echo %APPDATA%", note this is a hidden directory.)</p><p>There are comments in the file explaining what to do. If you don't have that file, get the latest Subversion client and run any command; this will cause the configuration directory and template files to be created.</p><p
>Example: Edit the 'servers' file and add something like:</p><div class="source"><pre>[global]
+ <div class="section"><h2>Overview<a name="Overview"></a></h2><a name="Overview"></a><p>This project uses <a class="externalLink" href="http://subversion.apache.org/">Subversion</a> to manage its source code. Instructions on Subversion use can be found at <a class="externalLink" href="http://svnbook.red-bean.com/">http://svnbook.red-bean.com/</a>.</p></div><div class="section"><h2>Web Access<a name="Web_Access"></a></h2><a name="Web_Access"></a><p>The following is a link to the online source repository.</p><div class="source"><pre><a class="externalLink" href="http://svn.apache.org/viewvc/maven/plugins/tags/maven-site-plugin-3.0">http://svn.apache.org/viewvc/maven/plugins/tags/maven-site-plugin-3.0</a></pre></div></div><div class="section"><h2>Anonymous access<a name="Anonymous_access"></a></h2><a name="Anonymous_access"></a><p>The source can be checked out anonymously from SVN with this command:</p><div class="source"><pre>$ svn checkout http://svn.apache.org/repos/a
sf/maven/plugins/tags/maven-site-plugin-3.0 maven-site-plugin</pre></div></div><div class="section"><h2>Developer access<a name="Developer_access"></a></h2><a name="Developer_access"></a><p>Everyone can access the Subversion repository via HTTP, but Committers must checkout the Subversion repository via HTTPS.</p><div class="source"><pre>$ svn checkout https://svn.apache.org/repos/asf/maven/plugins/tags/maven-site-plugin-3.0 maven-site-plugin</pre></div><p>To commit changes to the repository, execute the following command to commit your changes (svn will prompt you for your password)</p><div class="source"><pre>$ svn commit --username your-username -m "A message"</pre></div></div><div class="section"><h2>Access from behind a firewall<a name="Access_from_behind_a_firewall"></a></h2><a name="Access_from_behind_a_firewall"></a><p>For those users who are stuck behind a corporate firewall which is blocking HTTP access to the Subversion repository, you can try to access
it via the developer connection:</p><div class="source"><pre>$ svn checkout https://svn.apache.org/repos/asf/maven/plugins/tags/maven-site-plugin-3.0 maven-site-plugin</pre></div></div><div class="section"><h2>Access through a proxy<a name="Access_through_a_proxy"></a></h2><a name="Access_through_a_proxy"></a><p>The Subversion client can go through a proxy, if you configure it to do so. First, edit your "servers" configuration file to indicate which proxy to use. The file's location depends on your operating system. On Linux or Unix it is located in the directory "~/.subversion". On Windows it is in "%APPDATA%\Subversion". (Try "echo %APPDATA%", note this is a hidden directory.)</p><p>There are comments in the file explaining what to do. If you don't have that file, get the latest Subversion client and run any command; this will cause the configuration directory and template files to be created.</p><p>Example: Edit the 'servers' file a
nd add something like:</p><div class="source"><pre>[global]
http-proxy-host = your.proxy.name
http-proxy-port = 3128
</pre></div></div>
@@ -337,19 +211,13 @@ http-proxy-port = 3128
<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>