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 [15/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/examples/configuring-reports.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/configuring-reports.html (original)
+++ websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/configuring-reports.html Tue May 8 12:09:38 2012
@@ -1,80 +1,52 @@
<!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 - Configuring Reports</title>
+ <title>Configuring Reports</title>
<style type="text/css" media="all">
@import url("../css/maven-base.css");
@import url("../css/maven-theme.css");
@import url("../css/site.css");
</style>
<link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
- <meta name="author" content="Dennis Lundberg" />
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta name="author" content="Dennis Lundberg" />
+ <meta name="Date-Creation-yyyymmdd" content="20090308" />
+ <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>
+ >
+ Configuring Reports
+ </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">
- <strong>Configuring Reports</strong>
- </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">
+ <strong>Configuring Reports</strong>
+ </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">
@@ -294,26 +180,21 @@
</plugins>
</reporting>
...
-</project></pre></div><p>If you have included the appropriate <tt><menu ref="reports"/></tt> tag in your <a href="./sitedescriptor.html">site descriptor</a>, then when you regenerate the site those items will appear in a menu called "Project Reports".</p><p><b>Note:</b> Many report plugins provide a parameter called <tt>outputDirectory</tt> or similar to specify the destination for their report outputs. This parameter is only relevant if the report plugin is run standalone, i.e. by invocation directly from the command line. In constrast, when reports are generated as part of the site, the configuration of the Maven Site Plugin will determine the effective output directory to ensure that all reports end up in a common location.</p><p>Check out the <i>reporting</i> section of the <a class="externalLink" href="http://maven.apache.org/plugins/">plugins page</a>, for a list of available reporting plugins.</p><!-- TODO: explain report sets --></div>
+</project>
+</pre></div><p>If you have included the appropriate <tt><menu ref="reports"/></tt> tag in your <a href="./sitedescriptor.html">site descriptor</a>, then when you regenerate the site those items will appear in a menu called "Project Reports".</p><p><b>Note:</b> Many report plugins provide a parameter called <tt>outputDirectory</tt> or similar to specify the destination for their report outputs. This parameter is only relevant if the report plugin is run standalone, i.e. by invocation directly from the command line. In constrast, when reports are generated as part of the site, the configuration of the Maven Site Plugin will determine the effective output directory to ensure that all reports end up in a common location.</p><p>Check out the <i>reporting</i> section of the <a class="externalLink" href="http://maven.apache.org/plugins/">plugins page</a>, for a list of available reporting plugins.</p><!-- TODO: explain report sets --></div>
</div>
</div>
<div class="clear">
<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/examples/creating-content.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/creating-content.html (original)
+++ websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/creating-content.html Tue May 8 12:09:38 2012
@@ -1,80 +1,52 @@
<!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 - Creating Content</title>
+ <title>Creating Content</title>
<style type="text/css" media="all">
@import url("../css/maven-base.css");
@import url("../css/maven-theme.css");
@import url("../css/site.css");
</style>
<link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
- <meta name="author" content="Dennis Lundberg" />
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta name="author" content="Dennis Lundberg" />
+ <meta name="Date-Creation-yyyymmdd" content="20090308" />
+ <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>
+ >
+ Creating Content
+ </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">
- <strong>Creating Content</strong>
- </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">
+ <strong>Creating Content</strong>
+ </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">
@@ -294,7 +180,8 @@
+- xdoc/
| +- other.xml
|
- +- site.xml</pre></div><p>The <tt>${basedir}/src/site</tt> directory which contains a site descriptor along with various directories corresponding to the supported document formats. Let's take a look at examples of the various document formats.</p><p>The APT format ("Almost Plain Text") is a wiki-like format that allows you to write simple, structured documents (like this one) very quickly. A full reference of the <a class="externalLink" href="http://maven.apache.org/doxia/references/apt-format.html"> APT Format</a> is available.</p><p>The FML format is the FAQ format. This is the same that were used in Maven 1.x. For more info about the <a class="externalLink" href="http://maven.apache.org/doxia/references/fml-format.html">FML Format</a> check the <a class="externalLink" href="http://maven.apache.org/doxia/">Doxia</a> site.</p><p>The XDoc format is the same as <a class="externalLink" href="http://maven.apache.org/maven-1.x/using/site.html"> used in Maven 1.x
</a>. A reference for the <a class="externalLink" href="http://maven.apache.org/doxia/references/xdoc-format.html"> XDoc Format</a> is available.</p><p>Other formats are available, but at this point these 3 are the best tested. There are also several possible output formats, but currently only XHTML is available.</p><p>Note that all of the above is optional - just one index file is required in one of the input trees. The paths under each format will be merged together to form the root directory of the site. After running '<tt>mvn site:site</tt>' on the example above you will end up with this in your <tt>target</tt> directory:</p><div><pre>+- target/
+ +- site.xml
+</pre></div><p>The <tt>${basedir}/src/site</tt> directory which contains a site descriptor along with various directories corresponding to the supported document formats. Let's take a look at examples of the various document formats.</p><p>The APT format ("Almost Plain Text") is a wiki-like format that allows you to write simple, structured documents (like this one) very quickly. A full reference of the <a class="externalLink" href="http://maven.apache.org/doxia/references/apt-format.html"> APT Format</a> is available.</p><p>The FML format is the FAQ format. This is the same that were used in Maven 1.x. For more info about the <a class="externalLink" href="http://maven.apache.org/doxia/references/fml-format.html">FML Format</a> check the <a class="externalLink" href="http://maven.apache.org/doxia/">Doxia</a> site.</p><p>The XDoc format is the same as <a class="externalLink" href="http://maven.apache.org/maven-1.x/using/site.html"> used in Maven 1.x</a>. A reference
for the <a class="externalLink" href="http://maven.apache.org/doxia/references/xdoc-format.html"> XDoc Format</a> is available.</p><p>Other formats are available, but at this point these 3 are the best tested. There are also several possible output formats, but currently only XHTML is available.</p><p>Note that all of the above is optional - just one index file is required in one of the input trees. The paths under each format will be merged together to form the root directory of the site. After running '<tt>mvn site:site</tt>' on the example above you will end up with this in your <tt>target</tt> directory:</p><div><pre>+- target/
+- site/
+- css/
|
@@ -303,26 +190,29 @@
+- index.html
+- general.html
+- faq.html
- +- other.html</pre></div><p>This means that <tt>/src/site/apt/index.apt</tt> will be available in the site as <tt>/index.html</tt>. So, in <a href="./sitedescriptor.html"> your site descriptor</a> you might link to <tt>/index.html</tt> and <tt>/other.html</tt>, where the source of these two files would be <tt>/src/site/apt/index.apt</tt> and <tt>/src/site/xdoc/other.xdoc</tt>.</p><p>The <tt>css</tt> and <tt>images</tt> directories contain stylesheets and images from the skin being used. You can read more about skins in <a href="./sitedescriptor.html">the site descriptor documentation</a>.</p><div class="section"><h3>Adding Extra Resources<a name="Adding_Extra_Resources"></a></h3><p>You can add any arbitrary resource to your site by including them in a <tt>resources</tt> directory as shown below. Additional CSS files can be picked up when they are placed in the <tt>css</tt> directory within the <tt>resources</tt> directory.</p><div><pre>+- src/
+ +- other.html
+</pre></div><p>This means that <tt>/src/site/apt/index.apt</tt> will be available in the site as <tt>/index.html</tt>. So, in <a href="./sitedescriptor.html"> your site descriptor</a> you might link to <tt>/index.html</tt> and <tt>/other.html</tt>, where the source of these two files would be <tt>/src/site/apt/index.apt</tt> and <tt>/src/site/xdoc/other.xdoc</tt>.</p><p>The <tt>css</tt> and <tt>images</tt> directories contain stylesheets and images from the skin being used. You can read more about skins in <a href="./sitedescriptor.html">the site descriptor documentation</a>.</p><div class="section"><h3>Adding Extra Resources<a name="Adding_Extra_Resources"></a></h3><p>You can add any arbitrary resource to your site by including them in a <tt>resources</tt> directory as shown below. Additional CSS files can be picked up when they are placed in the <tt>css</tt> directory within the <tt>resources</tt> directory.</p><div><pre>+- src/
+- site/
+- resources/
+- css/
| +- site.css
|
+- images/
- +- pic1.jpg</pre></div><p>The file <tt>site.css</tt> will be added to the default XHTML output, so it can be used to adjust the default Maven stylesheets if desired.</p><p>The file <tt>pic1.jpg</tt> will be available via a relative reference to the <tt>images</tt> directory from any page in your site.</p></div><div class="section"><h3>Filtering<a name="Filtering"></a></h3><p><b>Note:</b> This feature is available in version 2.0-beta-6 or later of the Site Plugin.</p><p>To filter properties into any supported documentation format, add a <tt>.vm</tt> extension to the filename.</p><p>For example, the module for the Maven website contains a <a class="externalLink" href="http://svn.apache.org/repos/asf/maven/site/trunk/src/site/apt/download.apt.vm"><tt>src/site/apt/download.apt.vm</tt></a> file, which uses the expression <tt>${currentVersion}</tt> to filter in a property set in the <a class="externalLink" href="http://svn.apache.org/repos/asf/maven/site/trunk/pom.xml"
>POM</a>.</p><p><b>Note:</b> <a class="externalLink" href="http://velocity.apache.org/">Velocity</a> is used to apply the filtering. Because Velocity uses a dot-notation internally you can <b>not</b> use dots in your properties.</p><p>If you declare these properties in your POM</p><div class="source"><pre> <properties>
+ +- pic1.jpg
+</pre></div><p>The file <tt>site.css</tt> will be added to the default XHTML output, so it can be used to adjust the default Maven stylesheets if desired.</p><p>The file <tt>pic1.jpg</tt> will be available via a relative reference to the <tt>images</tt> directory from any page in your site.</p></div><div class="section"><h3>Filtering<a name="Filtering"></a></h3><p><b>Note:</b> This feature is available in version 2.0-beta-6 or later of the Site Plugin.</p><p>To filter properties into any supported documentation format, add a <tt>.vm</tt> extension to the filename.</p><p>For example, the module for the Maven website contains a <a class="externalLink" href="http://svn.apache.org/repos/asf/maven/site/trunk/src/site/apt/download.apt.vm"><tt>src/site/apt/download.apt.vm</tt></a> file, which uses the expression <tt>${currentVersion}</tt> to filter in a property set in the <a class="externalLink" href="http://svn.apache.org/repos/asf/maven/site/trunk/pom.xml">POM</a>.</p><p><b>Note
:</b> <a class="externalLink" href="http://velocity.apache.org/">Velocity</a> is used to apply the filtering. Because Velocity uses a dot-notation internally you can <b>not</b> use dots in your properties.</p><p>If you declare these properties in your POM</p><div class="source"><pre> <properties>
<!-- This will not work because the name of the property has a dot in it -->
<my.property>My value</my.property>
<!-- This will work because the name of the property has no dot in it -->
<myProperty>My other value</myProperty>
- </properties></pre></div><p>and then use the expression <tt>${my.property}</tt> in your document, it will <b>not</b> work. If you instead use the expression <tt>${myProperty}</tt> it will work just fine.</p></div><div class="section"><h3>Internationalization<a name="Internationalization"></a></h3><p>Internationalization in Maven is very simple, as long as the reports you are using have that particular locale defined. For an overview of supported languages and instructions on how to add further languages, please see the related article <a href="../i18n.html"> Internationalization</a>.</p><p>To enable multiple locales, or languages, add a configuration similar to the following to your POM:</p><div><pre><project>
+ </properties>
+</pre></div><p>and then use the expression <tt>${my.property}</tt> in your document, it will <b>not</b> work. If you instead use the expression <tt>${myProperty}</tt> it will work just fine.</p></div><div class="section"><h3>Internationalization<a name="Internationalization"></a></h3><p>Internationalization in Maven is very simple, as long as the reports you are using have that particular locale defined. For an overview of supported languages and instructions on how to add further languages, please see the related article <a href="../i18n.html"> Internationalization</a>.</p><p>To enable multiple locales, or languages, add a configuration similar to the following to your POM:</p><div><pre><project>
...
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
- <version>3.0-beta-3</version>
+ <version>3.0</version>
<configuration>
<locales>en,fr</locales>
</configuration>
@@ -330,7 +220,8 @@
</plugins>
</build>
...
-</project></pre></div><p>This will generate both an English and a French version of the site. If <tt>en</tt> is your current locale, then it will be generated at the root of the site, with a copy of the French translation of the site in the <tt>fr/</tt> subdirectory.</p><p>To add your own content for that translation instead of using the default, create a subdirectory with that locale's name in your site directory and create a new site descriptor with the name of the locale in the file name. For example:</p><div><pre>+- src/
+</project>
+</pre></div><p>This will generate both an English and a French version of the site. If <tt>en</tt> is your current locale, then it will be generated at the root of the site, with a copy of the French translation of the site in the <tt>fr/</tt> subdirectory.</p><p>To add your own content for that translation instead of using the default, create a subdirectory with that locale's name in your site directory and create a new site descriptor with the name of the locale in the file name. For example:</p><div><pre>+- src/
+- site/
+- apt/
| +- index.apt (Default version)
@@ -340,26 +231,21 @@
| +- index.apt (French version)
|
+- site.xml (Default site descriptor)
- +- site_fr.xml (French site descriptor)</pre></div><p>With one site descriptor per language, the translated site(s) can evolve independently.</p></div></div>
+ +- site_fr.xml (French site descriptor)
+</pre></div><p>With one site descriptor per language, the translated site(s) can evolve independently.</p></div></div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
- <div class="xright">©
- 2002-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/examples/creatingskins.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/creatingskins.html (original)
+++ websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/creatingskins.html Tue May 8 12:09:38 2012
@@ -1,81 +1,53 @@
<!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 - Creating Skins</title>
+ <title>Creating Skins</title>
<style type="text/css" media="all">
@import url("../css/maven-base.css");
@import url("../css/maven-theme.css");
@import url("../css/site.css");
</style>
<link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
- <meta name="author" content="Brett Porter
+ <meta name="author" content="Brett Porter
Dennis Lundberg" />
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta name="Date-Creation-yyyymmdd" content="20090308" />
+ <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>
+ >
+ Creating Skins
+ </div>
+ <div class="xright">
+ Last Published: 2011-07-30
+ | Version: 3.0
</div>
<div class="clear">
<hr/>
@@ -83,203 +55,117 @@ Dennis Lundberg" />
</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">
- <strong>Creating Skins</strong>
- </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">
+ <strong>Creating Skins</strong>
+ </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">
@@ -290,19 +176,13 @@ Dennis Lundberg" />
<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/examples/moduleexcludes.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/moduleexcludes.html (original)
+++ websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/moduleexcludes.html Tue May 8 12:09:38 2012
@@ -1,80 +1,52 @@
<!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 - Excluding Document Formats</title>
+ <title>Excluding Document Formats</title>
<style type="text/css" media="all">
@import url("../css/maven-base.css");
@import url("../css/maven-theme.css");
@import url("../css/site.css");
</style>
<link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
- <meta name="author" content="Maria Odea Ching" />
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta name="author" content="Maria Odea Ching" />
+ <meta name="Date-Creation-yyyymmdd" content="20090308" />
+ <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>
+ >
+ Excluding Document Formats
+ </div>
+ <div class="xright">
+ Last Published: 2011-07-30
+ | Version: 3.0
</div>
<div class="clear">
<hr/>
@@ -82,207 +54,121 @@
</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">
- <strong>Excluding Document Formats</strong>
- </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">
+ <strong>Excluding Document Formats</strong>
+ </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">
- <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements. See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership. The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied. See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/referen
ces/apt-format.html --><div class="section"><h2>Excluding Document Formats<a name="Excluding_Document_Formats"></a></h2><p>To exclude specific document formats from the generated site, you can use the <tt>excludeModules</tt> parameter.</p><p>For example, you have the following site content in your POM</p><div class="source"><pre>Module1
+ <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements. See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership. The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied. See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/referen
ces/apt-format.html --><div class="section"><h2>Excluding Document Formats<a name="Excluding_Document_Formats"></a></h2><p>To exclude specific document formats from the generated site, you can use the <tt>moduleExcludes</tt> parameter.</p><p>For example, you have the following site content in your POM</p><div class="source"><pre>Module1
|-- src
| |-- main
| `-- site
@@ -290,41 +176,39 @@
| | `-- sample-apt.apt
| `-- fml
| `-- sample-fml.fml
-`-- pom.xml</pre></div><p>and you want to exclude all the documents in the fml format from the generated site, you need to set the following in your POM and then execute "<tt>mvn site</tt>".</p><div class="source"><pre><project>
+`-- pom.xml
+</pre></div><p>and you want to exclude all the documents in the fml format from the generated site, you need to set the following in your POM and then execute "<tt>mvn site</tt>".</p><div class="source"><pre><project>
...
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
- <version>3.0-beta-3</version>
+ <version>3.0</version>
<configuration>
- <excludeModules>fml</excludeModules>
+ <moduleExcludes>
+ <fml>*.fml</fml>
+ </moduleExcludes>
</configuration>
</plugin>
</plugins>
</build>
...
-</project></pre></div><p>You will see that no <tt>sample-fml.html</tt> will be present in the generated site.</p></div>
+</project>
+</pre></div><p>You will see that no <tt>sample-fml.html</tt> will be present in the generated site.</p><p>See the documentation of the <a href="../site-mojo.html#moduleExcludes">moduleExcludes</a> Mojo parameter for more details.</p></div>
</div>
</div>
<div class="clear">
<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>