You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by mi...@apache.org on 2022/04/27 21:24:52 UTC
svn commit: r1900341 [17/36] - in /maven/website/components/plugins-archives/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/deploy/ api...
Modified: maven/website/components/plugins-archives/maven-site-plugin-LATEST/jar-mojo.html
==============================================================================
--- maven/website/components/plugins-archives/maven-site-plugin-LATEST/jar-mojo.html (original)
+++ maven/website/components/plugins-archives/maven-site-plugin-LATEST/jar-mojo.html Wed Apr 27 21:24:50 2022
@@ -1,55 +1,62 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from target\generated-site\xdoc/jar-mojo.xml at 2022-04-16
- | Rendered using Apache Maven Fluido Skin 1.7
+ | Generated by Apache Maven Doxia Site Renderer 1.11.1 from target\generated-site\xdoc/jar-mojo.xml at 2022-04-27
+ | Rendered using Apache Maven Fluido Skin 1.10.0
-->
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="UTF-8" />
- <meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20220416" />
- <meta http-equiv="Content-Language" content="en" />
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
+ <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" />
<title>Apache Maven Site Plugin – site:jar</title>
- <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.10.0.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
- <script type="text/javascript" src="./js/apache-maven-fluido-1.7.min.js"></script>
- <!-- Google Analytics -->
- <script type="text/javascript">
- var _gaq = _gaq || [];
- _gaq.push(['_setAccount', 'UA-140879-1']);
- _gaq.push(['_trackPageview']);
- (function() {
- var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
- ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
- var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
- })();
- </script>
+ <script src="./js/apache-maven-fluido-1.10.0.min.js"></script>
+<!-- Matomo -->
+<script>
+ var _paq = window._paq = window._paq || [];
+ /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
+ /* We explicitly disable cookie tracking to avoid privacy issues */
+ _paq.push(['disableCookies']);
+ _paq.push(['trackPageView']);
+ _paq.push(['enableLinkTracking']);
+ (function() {
+ var u="//analytics.apache.org/";
+ _paq.push(['setTrackerUrl', u+'matomo.php']);
+ _paq.push(['setSiteId', '3']);
+ var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
+ g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
+ })();
+</script>
+<!-- End Matomo Code -->
</head>
<body class="topBarDisabled">
<div class="container-fluid">
- <div id="banner">
- <div class="pull-left"><a href="https://www.apache.org/" id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven Site Plugin"/></a></div>
- <div class="pull-right"><a href="../../" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt=""/></a></div>
- <div class="clear"><hr/></div>
- </div>
+ <header>
+ <div id="banner">
+ <div class="pull-left"><a href="https://www.apache.org/" id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven Site Plugin"/></a></div>
+ <div class="pull-right"><a href="../../" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt=""/></a></div>
+ <div class="clear"><hr/></div>
+ </div>
- <div id="breadcrumbs">
- <ul class="breadcrumb">
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
<li class=""><a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li>
<li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li>
<li class=""><a href="../index.html" title="Plugins">Plugins</a><span class="divider">/</span></li>
<li class=""><a href="index.html" title="Apache Maven Site Plugin">Apache Maven Site Plugin</a><span class="divider">/</span></li>
<li class="active ">site:jar</li>
- <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2022-04-16</li>
- <li id="projectVersion" class="pull-right">Version: 3.12.0</li>
- </ul>
- </div>
+ <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2022-04-27</li>
+ <li id="projectVersion" class="pull-right">Version: 4.0.0-M1</li>
+ </ul>
+ </div>
+ </header>
<div class="row-fluid">
- <div id="leftColumn" class="span2">
- <div class="well sidebar-nav">
- <ul class="nav nav-list">
- <li class="nav-header">Overview</li>
+ <header id="leftColumn" class="span2">
+ <nav class="well sidebar-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Overview</li>
<li><a href="index.html" title="Introduction"><span class="none"></span>Introduction</a></li>
<li><a href="plugin-info.html" title="Goals"><span class="none"></span>Goals</a></li>
<li><a href="usage.html" title="Usage"><span class="none"></span>Usage</a></li>
@@ -58,28 +65,28 @@
<li><a href="migrate.html" title="Migrate"><span class="none"></span>Migrate</a></li>
<li><a href="http://www.apache.org/licenses/" class="externalLink" title="License"><span class="none"></span>License</a></li>
<li><a href="download.html" title="Download"><span class="none"></span>Download</a></li>
- <li class="nav-header">Examples</li>
+ <li class="nav-header">Examples</li>
<li><a href="examples/creating-content.html" title="Creating Content"><span class="none"></span>Creating Content</a></li>
<li><a href="examples/sitedescriptor.html" title="Configuring the Site Descriptor"><span class="none"></span>Configuring the Site Descriptor</a></li>
<li><a href="examples/multimodule.html" title="Building a multi-module site"><span class="none"></span>Building a multi-module site</a></li>
<li><a href="examples/siterun.html" title="Configuring Site Run"><span class="none"></span>Configuring Site Run</a></li>
<li><a href="examples/moduleexcludes.html" title="Excluding Document Formats"><span class="none"></span>Excluding Document Formats</a></li>
- <li class="nav-header">Reports</li>
+ <li class="nav-header">Reports</li>
<li><a href="examples/configuring-reports.html" title="Configuring Reports"><span class="none"></span>Configuring Reports</a></li>
<li><a href="i18n.html" title="Reports Internationalization"><span class="none"></span>Reports Internationalization</a></li>
- <li class="nav-header">Site Template</li>
- <li><a href="examples/templatefile.html" title="Changing the Template File"><span class="none"></span>Changing the Template File</a></li>
+ <li class="nav-header">Site Template</li>
<li><a href="examples/creatingskins.html" title="Creating Skins"><span class="none"></span>Creating Skins</a></li>
- <li class="nav-header">Deploying</li>
+ <li class="nav-header">Deploying</li>
<li><a href="examples/adding-deploy-protocol.html" title="Adding a Protocol to Deploy the Site"><span class="none"></span>Adding a Protocol to Deploy the Site</a></li>
<li><a href="examples/site-deploy-to-sourceforge.net.html" title="Deploying to sourceforge.net"><span class="none"></span>Deploying to sourceforge.net</a></li>
- <li class="nav-header">Project Documentation</li>
+ <li class="nav-header">Project Documentation</li>
<li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li>
<li><a href="project-reports.html" title="Project Reports"><span class="icon-chevron-right"></span>Project Reports</a></li>
- <li class="nav-header">Maven Projects</li>
+ <li class="nav-header">Maven Projects</li>
<li><a href="../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li>
<li><a href="../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li>
<li><a href="../../doxia/index.html" title="Doxia"><span class="none"></span>Doxia</a></li>
+ <li><a href="../../extensions/index.html" title="Extensions"><span class="none"></span>Extensions</a></li>
<li><a href="../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li>
<li><a href="../../ref/current" title="Maven"><span class="none"></span>Maven</a></li>
<li><a href="../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li>
@@ -92,40 +99,41 @@
<li><a href="../../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li>
<li><a href="../../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li>
<li><a href="../../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li>
- <li class="nav-header">ASF</li>
+ <li class="nav-header">ASF</li>
<li><a href="https://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li>
<li><a href="https://www.apache.org/foundation/" class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li>
<li><a href="https://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li>
<li><a href="https://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks"><span class="none"></span>Thanks</a></li>
-</ul>
+ </ul>
+ </nav>
+ <div class="well sidebar-nav">
<form id="search-form" action="https://www.google.com/search" method="get" >
<input value="maven.apache.org/plugins/maven-site-plugin/" name="sitesearch" type="hidden"/>
<input class="search-query" name="q" id="query" type="text" />
</form>
-<script type="text/javascript">asyncJs( 'https://cse.google.com/brand?form=search-form' )</script>
- <hr />
- <div id="poweredBy">
- <div class="clear"></div>
- <div class="clear"></div>
- <div id="twitter">
+<script>asyncJs( 'https://cse.google.com/brand?form=search-form' )</script>
+ <hr />
+ <div id="poweredBy">
+ <div class="clear"></div>
+ <div id="twitter" style="border:none; margin-top: 10px">
<a href="https://twitter.com/ASFMavenProject" class="twitter-follow-button" data-show-count="false" data-align="left" data-size="medium" data-show-screen-name="true" data-lang="en">Follow ASFMavenProject</a>
- <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
+ <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
</div>
- <div class="clear"></div>
- <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
</div>
</div>
- </div>
- <div id="bodyColumn" class="span10" >
+ </header>
+ <main id="bodyColumn" class="span10" >
- <div class="section">
+ <section>
<h2><a name="site:jar"></a>site:jar</h2>
<p><b>Full name</b>:</p>
-<p>org.apache.maven.plugins:maven-site-plugin:3.12.0:jar</p>
+<p>org.apache.maven.plugins:maven-site-plugin:4.0.0-M1:jar</p>
<p><b>Description</b>:</p>
@@ -140,14 +148,15 @@ repository.</div>
<li>Executes only as a reportSet (reporting goal).</li>
-<li>Requires dependency resolution of artifacts in scope: <tt>test</tt>.</li>
+<li>Requires dependency resolution of artifacts in scope: <code>test</code>.</li>
+
+<li>The goal is not marked as thread-safe and thus does not support parallel builds.</li>
-<li>Since version: <tt>2.0-beta-6</tt>.</li>
+<li>Since version: <code>2.0-beta-6</code>.</li>
-<li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <tt>package</tt>.</li>
+<li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <code>package</code>.</li>
</ul>
-
-<div class="section">
+ <section>
<h3><a name="Required_Parameters"></a>Required Parameters</h3>
<table class="table table-striped" border="0">
@@ -165,30 +174,29 @@ repository.</div>
<tr class="b">
-<td><tt><a href="#finalName"><finalName></a></tt></td>
+<td align="left"><code><a href="#finalName"><finalName></a></code></td>
-<td><tt>String</tt></td>
+<td><code>String</code></td>
-<td><tt>2.0-beta-6</tt></td>
+<td><code>2.0-beta-6</code></td>
<td>Specifies the filename that will be used for the generated jar
-file. Please note that "-site" will be appended to the file name.<br /><b>User property is</b>: <tt>project.build.finalName</tt>.<br /></td>
+file. Please note that "-site" will be appended to the file name.<br /><b>User property is</b>: <code>project.build.finalName</code>.<br /></td>
</tr>
<tr class="a">
-<td><tt><a href="#jarOutputDirectory"><jarOutputDirectory></a></tt></td>
+<td align="left"><code><a href="#jarOutputDirectory"><jarOutputDirectory></a></code></td>
-<td><tt>String</tt></td>
+<td><code>String</code></td>
-<td><tt>2.0-beta-6</tt></td>
+<td><code>2.0-beta-6</code></td>
-<td>Specifies the directory where the generated jar file will be put.<br /><b>User property is</b>: <tt>project.build.directory</tt>.<br /></td>
+<td>Specifies the directory where the generated jar file will be put.<br /><b>User property is</b>: <code>project.build.directory</code>.<br /></td>
</tr>
</table>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<table class="table table-striped" border="0">
@@ -206,11 +214,11 @@ file. Please note that "-site"
<tr class="b">
-<td><tt><a href="#archive"><archive></a></tt></td>
+<td align="left"><code><a href="#archive"><archive></a></code></td>
-<td><tt>MavenArchiveConfiguration</tt></td>
+<td><code>MavenArchiveConfiguration</code></td>
-<td><tt>3.1</tt></td>
+<td><code>3.1</code></td>
<td>The archive configuration to use. See <a class="externalLink" href="http://maven.apache.org/shared/maven-archiver/index.html">Maven
Archiver Reference</a>.<br /></td>
@@ -218,11 +226,11 @@ Archiver Reference</a>.<br /></td>
<tr class="a">
-<td><tt><a href="#archiveExcludes"><archiveExcludes></a></tt></td>
+<td align="left"><code><a href="#archiveExcludes"><archiveExcludes></a></code></td>
-<td><tt>String[]</tt></td>
+<td><code>String[]</code></td>
-<td><tt>3.1</tt></td>
+<td><code>3.1</code></td>
<td>List of files to exclude. Specified as file set patterns which are
relative to the input directory whose contents is being packaged
@@ -231,11 +239,11 @@ into the JAR.<br /></td>
<tr class="b">
-<td><tt><a href="#archiveIncludes"><archiveIncludes></a></tt></td>
+<td align="left"><code><a href="#archiveIncludes"><archiveIncludes></a></code></td>
-<td><tt>String[]</tt></td>
+<td><code>String[]</code></td>
-<td><tt>3.1</tt></td>
+<td><code>3.1</code></td>
<td>List of files to include. Specified as file set patterns which are
relative to the input directory whose contents is being packaged
@@ -244,22 +252,22 @@ into the JAR.<br /></td>
<tr class="a">
-<td><tt><a href="#attach"><attach></a></tt></td>
+<td align="left"><code><a href="#attach"><attach></a></code></td>
-<td><tt>boolean</tt></td>
+<td><code>boolean</code></td>
-<td><tt>2.0-beta-6</tt></td>
+<td><code>2.0-beta-6</code></td>
-<td>Specifies whether to attach the generated artifact to the project.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>site.attach</tt>.<br /></td>
+<td>Specifies whether to attach the generated artifact to the project.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>site.attach</code>.<br /></td>
</tr>
<tr class="b">
-<td><tt><a href="#attributes"><attributes></a></tt></td>
+<td align="left"><code><a href="#attributes"><attributes></a></code></td>
-<td><tt>Map</tt></td>
+<td><code>Map</code></td>
-<td><tt>2.0-beta-6</tt></td>
+<td><code>2.0-beta-6</code></td>
<td>Additional template properties for rendering the site. See <a href="/doxia/doxia-sitetools/doxia-site-renderer/">Doxia Site
Renderer</a>.<br /></td>
@@ -267,90 +275,90 @@ Renderer</a>.<br /></td>
<tr class="a">
-<td><tt><a href="#generateProjectInfo"><generateProjectInfo></a></tt></td>
+<td align="left"><code><a href="#generateProjectInfo"><generateProjectInfo></a></code></td>
-<td><tt>boolean</tt></td>
+<td><code>boolean</code></td>
-<td><tt>2.3</tt></td>
+<td><code>2.3</code></td>
<td>Whether to generate the summary page for project reports:
-project-info.html.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>generateProjectInfo</tt>.<br /></td>
+project-info.html.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>generateProjectInfo</code>.<br /></td>
</tr>
<tr class="b">
-<td><tt><a href="#generateReports"><generateReports></a></tt></td>
+<td align="left"><code><a href="#generateReports"><generateReports></a></code></td>
-<td><tt>boolean</tt></td>
+<td><code>boolean</code></td>
-<td><tt>2.0-beta-6</tt></td>
+<td><code>2.0-beta-6</code></td>
-<td>Convenience parameter that allows you to disable report generation.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>generateReports</tt>.<br /></td>
+<td>Convenience parameter that allows you to disable report generation.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>generateReports</code>.<br /></td>
</tr>
<tr class="a">
-<td><tt><a href="#generateSitemap"><generateSitemap></a></tt></td>
+<td align="left"><code><a href="#generateSitemap"><generateSitemap></a></code></td>
-<td><tt>boolean</tt></td>
+<td><code>boolean</code></td>
-<td><tt>2.1</tt></td>
+<td><code>2.1</code></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>.<br /><b>User property is</b>: <tt>generateSitemap</tt>.<br /></td>
+site root.<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>generateSitemap</code>.<br /></td>
</tr>
<tr class="b">
-<td><tt><a href="#generatedSiteDirectory"><generatedSiteDirectory></a></tt></td>
+<td align="left"><code><a href="#generatedSiteDirectory"><generatedSiteDirectory></a></code></td>
-<td><tt>File</tt></td>
+<td><code>File</code></td>
-<td><tt>2.0-beta-6</tt></td>
+<td><code>2.0-beta-6</code></td>
<td>Directory containing generated documentation in source format
(Doxia supported markup). This is used to pick up other source docs
that might have been generated at build time (by reports or any
other build time mean). This directory is expected to have the same
-structure as <tt>siteDirectory</tt> (ie. one directory per
+structure as <code>siteDirectory</code> (ie. one directory per
Doxia-source-supported markup types). todo should we deprecate in
favour of reports directly using Doxia Sink API, without this Doxia
-source intermediate step?<br /><b>Default value is</b>: <tt>${project.build.directory}/generated-site</tt>.<br /><b>Alias is</b>: <tt>workingDirectory</tt>.</td>
+source intermediate step?<br /><b>Default value is</b>: <code>${project.build.directory}/generated-site</code>.<br /><b>Alias is</b>: <code>workingDirectory</code>.</td>
</tr>
<tr class="a">
-<td><tt><a href="#inputEncoding"><inputEncoding></a></tt></td>
+<td align="left"><code><a href="#inputEncoding"><inputEncoding></a></code></td>
-<td><tt>String</tt></td>
+<td><code>String</code></td>
-<td><tt>2.3</tt></td>
+<td><code>2.3</code></td>
-<td>Specifies the input encoding.<br /><b>Default value is</b>: <tt>${project.build.sourceEncoding}</tt>.<br /><b>User property is</b>: <tt>encoding</tt>.<br /></td>
+<td>Specifies the input encoding.<br /><b>Default value is</b>: <code>${project.build.sourceEncoding}</code>.<br /><b>User property is</b>: <code>encoding</code>.<br /></td>
</tr>
<tr class="b">
-<td><tt><a href="#locales"><locales></a></tt></td>
+<td align="left"><code><a href="#locales"><locales></a></code></td>
-<td><tt>String</tt></td>
+<td><code>String</code></td>
-<td><tt>2.3</tt></td>
+<td><code>2.3</code></td>
<td>A comma separated list of locales to render. The first valid token
-will be the default Locale for this site.<br /><b>Default value is</b>: <tt>en</tt>.<br /><b>User property is</b>: <tt>locales</tt>.<br /></td>
+will be the default Locale for this site.<br /><b>Default value is</b>: <code>en</code>.<br /><b>User property is</b>: <code>locales</code>.<br /></td>
</tr>
<tr class="a">
-<td><tt><a href="#moduleExcludes"><moduleExcludes></a></tt></td>
+<td align="left"><code><a href="#moduleExcludes"><moduleExcludes></a></code></td>
-<td><tt>Map</tt></td>
+<td><code>Map</code></td>
-<td><tt>2.0-beta-6</tt></td>
+<td><code>2.0-beta-6</code></td>
-<td>Module type exclusion mappings ex: <tt>fml ->
-**/*-m1.fml</tt> (excludes fml files ending in '-m1.fml'
+<td>Module type exclusion mappings ex: <code>fml ->
+**/*-m1.fml</code> (excludes fml files ending in '-m1.fml'
recursively) The configuration looks like this:
<div>
@@ -368,136 +376,122 @@ recursively) The configuration looks lik
<tr class="b">
-<td><tt><a href="#outputDirectory"><outputDirectory></a></tt></td>
+<td align="left"><code><a href="#outputDirectory"><outputDirectory></a></code></td>
-<td><tt>File</tt></td>
+<td><code>File</code></td>
-<td><tt>2.0-beta-6</tt></td>
+<td><code>2.0-beta-6</code></td>
<td>Directory where the project sites and report distributions will be
-generated (as html/css/...).<br /><b>Default value is</b>: <tt>${project.reporting.outputDirectory}</tt>.<br /><b>User property is</b>: <tt>siteOutputDirectory</tt>.<br /></td>
+generated (as html/css/...).<br /><b>Default value is</b>: <code>${project.reporting.outputDirectory}</code>.<br /><b>User property is</b>: <code>siteOutputDirectory</code>.<br /></td>
</tr>
<tr class="a">
-<td><tt><a href="#outputEncoding"><outputEncoding></a></tt></td>
+<td align="left"><code><a href="#outputEncoding"><outputEncoding></a></code></td>
-<td><tt>String</tt></td>
+<td><code>String</code></td>
-<td><tt>2.3</tt></td>
+<td><code>2.3</code></td>
-<td>Specifies the output encoding.<br /><b>Default value is</b>: <tt>${project.reporting.outputEncoding}</tt>.<br /><b>User property is</b>: <tt>outputEncoding</tt>.<br /></td>
+<td>Specifies the output encoding.<br /><b>Default value is</b>: <code>${project.reporting.outputEncoding}</code>.<br /><b>User property is</b>: <code>outputEncoding</code>.<br /></td>
</tr>
<tr class="b">
-<td><tt><a href="#outputTimestamp"><outputTimestamp></a></tt></td>
+<td align="left"><code><a href="#outputTimestamp"><outputTimestamp></a></code></td>
-<td><tt>String</tt></td>
+<td><code>String</code></td>
-<td><tt>3.9.0</tt></td>
+<td><code>3.9.0</code></td>
<td>Timestamp for reproducible output archive entries, either formatted
-as ISO 8601 <tt>yyyy-MM-dd'T'HH:mm:ssXXX</tt> or as an int
-representing seconds since the epoch (like <a class="externalLink" href="https://reproducible-builds.org/docs/source-date-epoch/">SOURCE_DATE_EPOCH</a>).<br /><b>Default value is</b>: <tt>${project.build.outputTimestamp}</tt>.<br /></td>
+as ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ssXXX</code> or as an int
+representing seconds since the epoch (like <a class="externalLink" href="https://reproducible-builds.org/docs/source-date-epoch/">SOURCE_DATE_EPOCH</a>).<br /><b>Default value is</b>: <code>${project.build.outputTimestamp}</code>.<br /></td>
</tr>
<tr class="a">
-<td><tt><a href="#relativizeDecorationLinks"><relativizeDecorationLinks></a></tt></td>
+<td align="left"><code><a href="#relativizeDecorationLinks"><relativizeDecorationLinks></a></code></td>
-<td><tt>boolean</tt></td>
+<td><code>boolean</code></td>
-<td><tt>2.3</tt></td>
+<td><code>2.3</code></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>.<br /><b>User property is</b>: <tt>relativizeDecorationLinks</tt>.<br /></td>
+to false, or if the project has no URL defined.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>relativizeDecorationLinks</code>.<br /></td>
</tr>
<tr class="b">
-<td><tt><a href="#saveProcessedContent"><saveProcessedContent></a></tt></td>
+<td align="left"><code><a href="#saveProcessedContent"><saveProcessedContent></a></code></td>
-<td><tt>boolean</tt></td>
+<td><code>boolean</code></td>
-<td><tt>3.5</tt></td>
+<td><code>3.5</code></td>
<td>Whether to save Velocity processed Doxia content
-(<tt>*.<ext>.vm</tt>) to
-<tt>${generatedSiteDirectory}/processed</tt>.<br /></td>
+(<code>*.<ext>.vm</code>) to
+<code>${generatedSiteDirectory}/processed</code>.<br /></td>
</tr>
<tr class="a">
-<td><tt><a href="#siteDirectory"><siteDirectory></a></tt></td>
+<td align="left"><code><a href="#siteDirectory"><siteDirectory></a></code></td>
-<td><tt>File</tt></td>
+<td><code>File</code></td>
-<td><tt>2.3</tt></td>
+<td><code>2.3</code></td>
-<td>Directory containing the <tt>site.xml</tt> file and the source
+<td>Directory containing the <code>site.xml</code> file and the source
for hand written docs (one directory per Doxia-source-supported
markup types): see <a href="/doxia/references/index.html">Doxia
-Markup Languages References</a>).<br /><b>Default value is</b>: <tt>${basedir}/src/site</tt>.<br /></td>
+Markup Languages References</a>).<br /><b>Default value is</b>: <code>${basedir}/src/site</code>.<br /></td>
</tr>
<tr class="b">
-<td><tt><a href="#skip"><skip></a></tt></td>
+<td align="left"><code><a href="#skip"><skip></a></code></td>
-<td><tt>boolean</tt></td>
+<td><code>boolean</code></td>
-<td><tt>3.0</tt></td>
+<td><code>3.0</code></td>
-<td>Set this to 'true' to skip site generation and staging.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>maven.site.skip</tt>.<br /></td>
+<td>Set this to 'true' to skip site generation and staging.<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>maven.site.skip</code>.<br /></td>
</tr>
<tr class="a">
-<td><tt><a href="#templateFile"><templateFile></a></tt></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>2.0-beta-5</tt></td>
-
-<td><b>Deprecated.</b> Upcoming major Doxia version removes support for template files in
-favor of skins.<br /><b>User property is</b>: <tt>templateFile</tt>.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><tt><a href="#validate"><validate></a></tt></td>
+<td align="left"><code><a href="#validate"><validate></a></code></td>
-<td><tt>boolean</tt></td>
+<td><code>boolean</code></td>
-<td><tt>2.1.1</tt></td>
+<td><code>2.1.1</code></td>
<td>Whether to validate xml input documents. If set to true,
<b>all</b> input documents in xml format (in particular
xdoc and fml) will be validated and any error will lead to a build
-failure.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>validate</tt>.<br /></td>
+failure.<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>validate</code>.<br /></td>
</tr>
-<tr class="a">
+<tr class="b">
-<td><tt><a href="#xdocDirectory"><xdocDirectory></a></tt></td>
+<td align="left"><code><a href="#xdocDirectory"><xdocDirectory></a></code></td>
-<td><tt>File</tt></td>
+<td><code>File</code></td>
-<td><tt>2.0-beta-6</tt></td>
+<td><code>2.0-beta-6</code></td>
-<td><b>Deprecated.</b> use the standard m2 directory layout<br /><b>Default value is</b>: <tt>${basedir}/xdocs</tt>.<br /></td>
+<td><b>Deprecated.</b> use the standard m2 directory layout<br /><b>Default value is</b>: <code>${basedir}/xdocs</code>.<br /></td>
</tr>
</table>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="Parameter_Details"></a>Parameter Details</h3>
-
-<div class="section">
+ <section>
<h4><a name="a.3Carchive.3E"></a><b><a name="archive"><archive></a></b></h4>
<div>The archive configuration to use. See <a class="externalLink" href="http://maven.apache.org/shared/maven-archiver/index.html">Maven
@@ -505,13 +499,12 @@ Archiver Reference</a>.</div>
<ul>
-<li><b>Type</b>: <tt>org.apache.maven.archiver.MavenArchiveConfiguration</tt></li>
+<li><b>Type</b>: <code>org.apache.maven.archiver.MavenArchiveConfiguration</code></li>
-<li><b>Since</b>: <tt>3.1</tt></li>
+<li><b>Since</b>: <code>3.1</code></li>
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr /></div>
-<div class="section">
+<li><b>Required</b>: <code>No</code></li>
+ </ul><hr /></section><section>
<h4><a name="a.3CarchiveExcludes.3E"></a><b><a name="archiveExcludes"><archiveExcludes></a></b></h4>
<div>List of files to exclude. Specified as file set patterns which are
@@ -520,13 +513,12 @@ into the JAR.</div>
<ul>
-<li><b>Type</b>: <tt>java.lang.String[]</tt></li>
+<li><b>Type</b>: <code>java.lang.String[]</code></li>
-<li><b>Since</b>: <tt>3.1</tt></li>
+<li><b>Since</b>: <code>3.1</code></li>
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr /></div>
-<div class="section">
+<li><b>Required</b>: <code>No</code></li>
+ </ul><hr /></section><section>
<h4><a name="a.3CarchiveIncludes.3E"></a><b><a name="archiveIncludes"><archiveIncludes></a></b></h4>
<div>List of files to include. Specified as file set patterns which are
@@ -535,30 +527,28 @@ into the JAR.</div>
<ul>
-<li><b>Type</b>: <tt>java.lang.String[]</tt></li>
+<li><b>Type</b>: <code>java.lang.String[]</code></li>
-<li><b>Since</b>: <tt>3.1</tt></li>
+<li><b>Since</b>: <code>3.1</code></li>
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr /></div>
-<div class="section">
+<li><b>Required</b>: <code>No</code></li>
+ </ul><hr /></section><section>
<h4><a name="a.3Cattach.3E"></a><b><a name="attach"><attach></a></b></h4>
<div>Specifies whether to attach the generated artifact to the project.</div>
<ul>
-<li><b>Type</b>: <tt>boolean</tt></li>
+<li><b>Type</b>: <code>boolean</code></li>
-<li><b>Since</b>: <tt>2.0-beta-6</tt></li>
+<li><b>Since</b>: <code>2.0-beta-6</code></li>
-<li><b>Required</b>: <tt>No</tt></li>
+<li><b>Required</b>: <code>No</code></li>
-<li><b>User Property</b>: <tt>site.attach</tt></li>
+<li><b>User Property</b>: <code>site.attach</code></li>
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr /></div>
-<div class="section">
+<li><b>Default</b>: <code>true</code></li>
+ </ul><hr /></section><section>
<h4><a name="a.3Cattributes.3E"></a><b><a name="attributes"><attributes></a></b></h4>
<div>Additional template properties for rendering the site. See <a href="/doxia/doxia-sitetools/doxia-site-renderer/">Doxia Site
@@ -566,13 +556,12 @@ Renderer</a>.</div>
<ul>
-<li><b>Type</b>: <tt>java.util.Map</tt></li>
+<li><b>Type</b>: <code>java.util.Map</code></li>
-<li><b>Since</b>: <tt>2.0-beta-6</tt></li>
+<li><b>Since</b>: <code>2.0-beta-6</code></li>
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr /></div>
-<div class="section">
+<li><b>Required</b>: <code>No</code></li>
+ </ul><hr /></section><section>
<h4><a name="a.3CfinalName.3E"></a><b><a name="finalName"><finalName></a></b></h4>
<div>Specifies the filename that will be used for the generated jar
@@ -580,15 +569,14 @@ file. Please note that "-site"
<ul>
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
+<li><b>Type</b>: <code>java.lang.String</code></li>
-<li><b>Since</b>: <tt>2.0-beta-6</tt></li>
+<li><b>Since</b>: <code>2.0-beta-6</code></li>
-<li><b>Required</b>: <tt>Yes</tt></li>
+<li><b>Required</b>: <code>Yes</code></li>
-<li><b>User Property</b>: <tt>project.build.finalName</tt></li>
- </ul><hr /></div>
-<div class="section">
+<li><b>User Property</b>: <code>project.build.finalName</code></li>
+ </ul><hr /></section><section>
<h4><a name="a.3CgenerateProjectInfo.3E"></a><b><a name="generateProjectInfo"><generateProjectInfo></a></b></h4>
<div>Whether to generate the summary page for project reports:
@@ -596,34 +584,32 @@ project-info.html.</div>
<ul>
-<li><b>Type</b>: <tt>boolean</tt></li>
+<li><b>Type</b>: <code>boolean</code></li>
-<li><b>Since</b>: <tt>2.3</tt></li>
+<li><b>Since</b>: <code>2.3</code></li>
-<li><b>Required</b>: <tt>No</tt></li>
+<li><b>Required</b>: <code>No</code></li>
-<li><b>User Property</b>: <tt>generateProjectInfo</tt></li>
+<li><b>User Property</b>: <code>generateProjectInfo</code></li>
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr /></div>
-<div class="section">
+<li><b>Default</b>: <code>true</code></li>
+ </ul><hr /></section><section>
<h4><a name="a.3CgenerateReports.3E"></a><b><a name="generateReports"><generateReports></a></b></h4>
<div>Convenience parameter that allows you to disable report generation.</div>
<ul>
-<li><b>Type</b>: <tt>boolean</tt></li>
+<li><b>Type</b>: <code>boolean</code></li>
-<li><b>Since</b>: <tt>2.0-beta-6</tt></li>
+<li><b>Since</b>: <code>2.0-beta-6</code></li>
-<li><b>Required</b>: <tt>No</tt></li>
+<li><b>Required</b>: <code>No</code></li>
-<li><b>User Property</b>: <tt>generateReports</tt></li>
+<li><b>User Property</b>: <code>generateReports</code></li>
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr /></div>
-<div class="section">
+<li><b>Default</b>: <code>true</code></li>
+ </ul><hr /></section><section>
<h4><a name="a.3CgenerateSitemap.3E"></a><b><a name="generateSitemap"><generateSitemap></a></b></h4>
<div>Generate a sitemap. The result will be a "sitemap.html" file at the
@@ -631,73 +617,69 @@ site root.</div>
<ul>
-<li><b>Type</b>: <tt>boolean</tt></li>
+<li><b>Type</b>: <code>boolean</code></li>
-<li><b>Since</b>: <tt>2.1</tt></li>
+<li><b>Since</b>: <code>2.1</code></li>
-<li><b>Required</b>: <tt>No</tt></li>
+<li><b>Required</b>: <code>No</code></li>
-<li><b>User Property</b>: <tt>generateSitemap</tt></li>
+<li><b>User Property</b>: <code>generateSitemap</code></li>
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr /></div>
-<div class="section">
+<li><b>Default</b>: <code>false</code></li>
+ </ul><hr /></section><section>
<h4><a name="a.3CgeneratedSiteDirectory.3E"></a><b><a name="generatedSiteDirectory"><generatedSiteDirectory></a></b></h4>
<div>Directory containing generated documentation in source format
(Doxia supported markup). This is used to pick up other source docs
that might have been generated at build time (by reports or any
other build time mean). This directory is expected to have the same
-structure as <tt>siteDirectory</tt> (ie. one directory per
+structure as <code>siteDirectory</code> (ie. one directory per
Doxia-source-supported markup types). todo should we deprecate in
favour of reports directly using Doxia Sink API, without this Doxia
source intermediate step?</div>
<ul>
-<li><b>Type</b>: <tt>java.io.File</tt></li>
+<li><b>Type</b>: <code>java.io.File</code></li>
-<li><b>Since</b>: <tt>2.0-beta-6</tt></li>
+<li><b>Since</b>: <code>2.0-beta-6</code></li>
-<li><b>Required</b>: <tt>No</tt></li>
+<li><b>Required</b>: <code>No</code></li>
-<li><b>Default</b>: <tt>${project.build.directory}/generated-site</tt></li>
+<li><b>Default</b>: <code>${project.build.directory}/generated-site</code></li>
-<li><b>Alias</b>: <tt>workingDirectory</tt></li>
- </ul><hr /></div>
-<div class="section">
+<li><b>Alias</b>: <code>workingDirectory</code></li>
+ </ul><hr /></section><section>
<h4><a name="a.3CinputEncoding.3E"></a><b><a name="inputEncoding"><inputEncoding></a></b></h4>
<div>Specifies the input encoding.</div>
<ul>
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
+<li><b>Type</b>: <code>java.lang.String</code></li>
-<li><b>Since</b>: <tt>2.3</tt></li>
+<li><b>Since</b>: <code>2.3</code></li>
-<li><b>Required</b>: <tt>No</tt></li>
+<li><b>Required</b>: <code>No</code></li>
-<li><b>User Property</b>: <tt>encoding</tt></li>
+<li><b>User Property</b>: <code>encoding</code></li>
-<li><b>Default</b>: <tt>${project.build.sourceEncoding}</tt></li>
- </ul><hr /></div>
-<div class="section">
+<li><b>Default</b>: <code>${project.build.sourceEncoding}</code></li>
+ </ul><hr /></section><section>
<h4><a name="a.3CjarOutputDirectory.3E"></a><b><a name="jarOutputDirectory"><jarOutputDirectory></a></b></h4>
<div>Specifies the directory where the generated jar file will be put.</div>
<ul>
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
+<li><b>Type</b>: <code>java.lang.String</code></li>
-<li><b>Since</b>: <tt>2.0-beta-6</tt></li>
+<li><b>Since</b>: <code>2.0-beta-6</code></li>
-<li><b>Required</b>: <tt>Yes</tt></li>
+<li><b>Required</b>: <code>Yes</code></li>
-<li><b>User Property</b>: <tt>project.build.directory</tt></li>
- </ul><hr /></div>
-<div class="section">
+<li><b>User Property</b>: <code>project.build.directory</code></li>
+ </ul><hr /></section><section>
<h4><a name="a.3Clocales.3E"></a><b><a name="locales"><locales></a></b></h4>
<div>A comma separated list of locales to render. The first valid token
@@ -705,21 +687,20 @@ will be the default Locale for this site
<ul>
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
+<li><b>Type</b>: <code>java.lang.String</code></li>
-<li><b>Since</b>: <tt>2.3</tt></li>
+<li><b>Since</b>: <code>2.3</code></li>
-<li><b>Required</b>: <tt>No</tt></li>
+<li><b>Required</b>: <code>No</code></li>
-<li><b>User Property</b>: <tt>locales</tt></li>
+<li><b>User Property</b>: <code>locales</code></li>
-<li><b>Default</b>: <tt>en</tt></li>
- </ul><hr /></div>
-<div class="section">
+<li><b>Default</b>: <code>en</code></li>
+ </ul><hr /></section><section>
<h4><a name="a.3CmoduleExcludes.3E"></a><b><a name="moduleExcludes"><moduleExcludes></a></b></h4>
-<div>Module type exclusion mappings ex: <tt>fml ->
-**/*-m1.fml</tt> (excludes fml files ending in '-m1.fml'
+<div>Module type exclusion mappings ex: <code>fml ->
+**/*-m1.fml</code> (excludes fml files ending in '-m1.fml'
recursively) The configuration looks like this:
<div>
@@ -736,13 +717,12 @@ recursively) The configuration looks lik
<ul>
-<li><b>Type</b>: <tt>java.util.Map</tt></li>
+<li><b>Type</b>: <code>java.util.Map</code></li>
-<li><b>Since</b>: <tt>2.0-beta-6</tt></li>
+<li><b>Since</b>: <code>2.0-beta-6</code></li>
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr /></div>
-<div class="section">
+<li><b>Required</b>: <code>No</code></li>
+ </ul><hr /></section><section>
<h4><a name="a.3CoutputDirectory.3E"></a><b><a name="outputDirectory"><outputDirectory></a></b></h4>
<div>Directory where the project sites and report distributions will be
@@ -750,51 +730,48 @@ generated (as html/css/...).</div>
<ul>
-<li><b>Type</b>: <tt>java.io.File</tt></li>
+<li><b>Type</b>: <code>java.io.File</code></li>
-<li><b>Since</b>: <tt>2.0-beta-6</tt></li>
+<li><b>Since</b>: <code>2.0-beta-6</code></li>
-<li><b>Required</b>: <tt>No</tt></li>
+<li><b>Required</b>: <code>No</code></li>
-<li><b>User Property</b>: <tt>siteOutputDirectory</tt></li>
+<li><b>User Property</b>: <code>siteOutputDirectory</code></li>
-<li><b>Default</b>: <tt>${project.reporting.outputDirectory}</tt></li>
- </ul><hr /></div>
-<div class="section">
+<li><b>Default</b>: <code>${project.reporting.outputDirectory}</code></li>
+ </ul><hr /></section><section>
<h4><a name="a.3CoutputEncoding.3E"></a><b><a name="outputEncoding"><outputEncoding></a></b></h4>
<div>Specifies the output encoding.</div>
<ul>
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
+<li><b>Type</b>: <code>java.lang.String</code></li>
-<li><b>Since</b>: <tt>2.3</tt></li>
+<li><b>Since</b>: <code>2.3</code></li>
-<li><b>Required</b>: <tt>No</tt></li>
+<li><b>Required</b>: <code>No</code></li>
-<li><b>User Property</b>: <tt>outputEncoding</tt></li>
+<li><b>User Property</b>: <code>outputEncoding</code></li>
-<li><b>Default</b>: <tt>${project.reporting.outputEncoding}</tt></li>
- </ul><hr /></div>
-<div class="section">
+<li><b>Default</b>: <code>${project.reporting.outputEncoding}</code></li>
+ </ul><hr /></section><section>
<h4><a name="a.3CoutputTimestamp.3E"></a><b><a name="outputTimestamp"><outputTimestamp></a></b></h4>
<div>Timestamp for reproducible output archive entries, either formatted
-as ISO 8601 <tt>yyyy-MM-dd'T'HH:mm:ssXXX</tt> or as an int
+as ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ssXXX</code> or as an int
representing seconds since the epoch (like <a class="externalLink" href="https://reproducible-builds.org/docs/source-date-epoch/">SOURCE_DATE_EPOCH</a>).</div>
<ul>
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
+<li><b>Type</b>: <code>java.lang.String</code></li>
-<li><b>Since</b>: <tt>3.9.0</tt></li>
+<li><b>Since</b>: <code>3.9.0</code></li>
-<li><b>Required</b>: <tt>No</tt></li>
+<li><b>Required</b>: <code>No</code></li>
-<li><b>Default</b>: <tt>${project.build.outputTimestamp}</tt></li>
- </ul><hr /></div>
-<div class="section">
+<li><b>Default</b>: <code>${project.build.outputTimestamp}</code></li>
+ </ul><hr /></section><section>
<h4><a name="a.3CrelativizeDecorationLinks.3E"></a><b><a name="relativizeDecorationLinks"><relativizeDecorationLinks></a></b></h4>
<div>Make links in the site descriptor relative to the project URL. By
@@ -805,87 +782,63 @@ to false, or if the project has no URL d
<ul>
-<li><b>Type</b>: <tt>boolean</tt></li>
+<li><b>Type</b>: <code>boolean</code></li>
-<li><b>Since</b>: <tt>2.3</tt></li>
+<li><b>Since</b>: <code>2.3</code></li>
-<li><b>Required</b>: <tt>No</tt></li>
+<li><b>Required</b>: <code>No</code></li>
-<li><b>User Property</b>: <tt>relativizeDecorationLinks</tt></li>
+<li><b>User Property</b>: <code>relativizeDecorationLinks</code></li>
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr /></div>
-<div class="section">
+<li><b>Default</b>: <code>true</code></li>
+ </ul><hr /></section><section>
<h4><a name="a.3CsaveProcessedContent.3E"></a><b><a name="saveProcessedContent"><saveProcessedContent></a></b></h4>
<div>Whether to save Velocity processed Doxia content
-(<tt>*.<ext>.vm</tt>) to
-<tt>${generatedSiteDirectory}/processed</tt>.</div>
+(<code>*.<ext>.vm</code>) to
+<code>${generatedSiteDirectory}/processed</code>.</div>
<ul>
-<li><b>Type</b>: <tt>boolean</tt></li>
+<li><b>Type</b>: <code>boolean</code></li>
-<li><b>Since</b>: <tt>3.5</tt></li>
+<li><b>Since</b>: <code>3.5</code></li>
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr /></div>
-<div class="section">
+<li><b>Required</b>: <code>No</code></li>
+ </ul><hr /></section><section>
<h4><a name="a.3CsiteDirectory.3E"></a><b><a name="siteDirectory"><siteDirectory></a></b></h4>
-<div>Directory containing the <tt>site.xml</tt> file and the source
+<div>Directory containing the <code>site.xml</code> file and the source
for hand written docs (one directory per Doxia-source-supported
markup types): see <a href="/doxia/references/index.html">Doxia
Markup Languages References</a>).</div>
<ul>
-<li><b>Type</b>: <tt>java.io.File</tt></li>
+<li><b>Type</b>: <code>java.io.File</code></li>
-<li><b>Since</b>: <tt>2.3</tt></li>
+<li><b>Since</b>: <code>2.3</code></li>
-<li><b>Required</b>: <tt>No</tt></li>
+<li><b>Required</b>: <code>No</code></li>
-<li><b>Default</b>: <tt>${basedir}/src/site</tt></li>
- </ul><hr /></div>
-<div class="section">
+<li><b>Default</b>: <code>${basedir}/src/site</code></li>
+ </ul><hr /></section><section>
<h4><a name="a.3Cskip.3E"></a><b><a name="skip"><skip></a></b></h4>
<div>Set this to 'true' to skip site generation and staging.</div>
<ul>
-<li><b>Type</b>: <tt>boolean</tt></li>
+<li><b>Type</b>: <code>boolean</code></li>
-<li><b>Since</b>: <tt>3.0</tt></li>
+<li><b>Since</b>: <code>3.0</code></li>
-<li><b>Required</b>: <tt>No</tt></li>
+<li><b>Required</b>: <code>No</code></li>
-<li><b>User Property</b>: <tt>maven.site.skip</tt></li>
+<li><b>User Property</b>: <code>maven.site.skip</code></li>
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr /></div>
-<div class="section">
-<h4><a name="a.3CtemplateFile.3E"></a><b><a name="templateFile"><templateFile></a></b></h4>
-
-<div><b>Deprecated.</b> Upcoming major Doxia version removes support for template files in
-favor of skins.</div>
-
-<div>The location of a Velocity template file to use. When used, skins
-and the default templates, CSS and images are disabled. It is
-highly recommended that you package this as a skin instead.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Since</b>: <tt>2.0-beta-5</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>templateFile</tt></li>
- </ul><hr /></div>
-<div class="section">
+<li><b>Default</b>: <code>false</code></li>
+ </ul><hr /></section><section>
<h4><a name="a.3Cvalidate.3E"></a><b><a name="validate"><validate></a></b></h4>
<div>Whether to validate xml input documents. If set to true,
@@ -895,17 +848,16 @@ failure.</div>
<ul>
-<li><b>Type</b>: <tt>boolean</tt></li>
+<li><b>Type</b>: <code>boolean</code></li>
-<li><b>Since</b>: <tt>2.1.1</tt></li>
+<li><b>Since</b>: <code>2.1.1</code></li>
-<li><b>Required</b>: <tt>No</tt></li>
+<li><b>Required</b>: <code>No</code></li>
-<li><b>User Property</b>: <tt>validate</tt></li>
+<li><b>User Property</b>: <code>validate</code></li>
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr /></div>
-<div class="section">
+<li><b>Default</b>: <code>false</code></li>
+ </ul><hr /></section><section>
<h4><a name="a.3CxdocDirectory.3E"></a><b><a name="xdocDirectory"><xdocDirectory></a></b></h4>
<div><b>Deprecated.</b> use the standard m2 directory layout</div>
@@ -915,30 +867,35 @@ migration</div>
<ul>
-<li><b>Type</b>: <tt>java.io.File</tt></li>
+<li><b>Type</b>: <code>java.io.File</code></li>
-<li><b>Since</b>: <tt>2.0-beta-6</tt></li>
+<li><b>Since</b>: <code>2.0-beta-6</code></li>
-<li><b>Required</b>: <tt>No</tt></li>
+<li><b>Required</b>: <code>No</code></li>
-<li><b>Default</b>: <tt>${basedir}/xdocs</tt></li>
+<li><b>Default</b>: <code>${basedir}/xdocs</code></li>
</ul>
- </div></div>
- </div>
+ </section></section>
+ </section>
- </div>
+ </main>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
- <p>Copyright ©2002–2022
-<a href="https://www.apache.org/">The Apache Software Foundation</a>.
-All rights reserved.</p>
+ <p>© 2002–2022
+<a href="https://www.apache.org/">The Apache Software Foundation</a>
+</p>
</div>
</div>
</footer>
+<script>
+ if(anchors) {
+ anchors.add();
+ }
+</script>
</body>
</html>
\ No newline at end of file