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 Sat Feb 11 20:41:49 2023 @@ -1,7 +1,9 @@ <!DOCTYPE html> + + <!-- - | Generated by Apache Maven Doxia Site Renderer 1.11.1 from target\generated-site\xdoc/jar-mojo.xml at 2022-12-02 - | Rendered using Apache Maven Fluido Skin 1.10.0 + | Generated by Apache Maven Doxia Site Renderer 1.11.1 from target\generated-site\xdoc/jar-mojo.xml at 2023-02-11 + | Rendered using Apache Maven Fluido Skin 1.11.2 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> @@ -9,46 +11,46 @@ <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.10.0.min.css" /> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.11.2.min.css" /> <link rel="stylesheet" href="./css/site.css" /> <link rel="stylesheet" href="./css/print.css" media="print" /> - <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 --> + <script src="./js/apache-maven-fluido-1.11.2.min.js"></script> + + <!-- Matomo --> + <script> + var _paq = window._paq = window._paq || []; + _paq.push(['disableCookies']); + _paq.push(['trackPageView']); + _paq.push(['enableLinkTracking']); + + (function() { + var u="https://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"> <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="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven Site Plugin" style="" /></a></div> + <div class="pull-right"><a href="../../" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> <div class="clear"><hr/></div> </div> <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><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> + <li><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> + <li><a href="../index.html" title="Plugins">Plugins</a><span class="divider">/</span></li> + <li><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-12-02</li> - <li id="projectVersion" class="pull-right">Version: 4.0.0-M4</li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-11</li> + <li id="projectVersion" class="pull-right">Version: 4.0.0-M5</li> </ul> </div> </header> @@ -102,23 +104,14 @@ <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://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink" title="Data Privacy"><span class="none"></span>Data Privacy</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> </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>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>!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> <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> @@ -133,12 +126,11 @@ <p><b>Full name</b>:</p> -<p>org.apache.maven.plugins:maven-site-plugin:4.0.0-M4:jar</p> +<p>org.apache.maven.plugins:maven-site-plugin:4.0.0-M5:jar</p> <p><b>Description</b>:</p> -<div>Bundles the site output into a JAR so that it can be deployed to a -repository.</div> +<div>Bundles the site output into a JAR so that it can be deployed to a repository.</div> <p><b>Attributes</b>:</p> @@ -178,10 +170,9 @@ repository.</div> <td><code>String</code></td> -<td><code>2.0-beta-6</code></td> +<td><code>-</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>: <code>project.build.finalName</code>.<br /></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>: <code>project.build.finalName</code>.<br /></td> </tr> <tr class="a"> @@ -190,7 +181,7 @@ file. Please note that "-site" <td><code>String</code></td> -<td><code>2.0-beta-6</code></td> +<td><code>-</code></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> @@ -220,8 +211,7 @@ file. Please note that "-site" <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> +<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> </tr> <tr class="a"> @@ -232,9 +222,7 @@ Archiver Reference</a>.<br /></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 -into the JAR.<br /></td> +<td>List of files to exclude. Specified as file set patterns which are relative to the input directory whose contents is being packaged into the JAR.<br /></td> </tr> <tr class="b"> @@ -245,9 +233,7 @@ into the JAR.<br /></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 -into the JAR.<br /></td> +<td>List of files to include. Specified as file set patterns which are relative to the input directory whose contents is being packaged into the JAR.<br /></td> </tr> <tr class="a"> @@ -256,7 +242,7 @@ into the JAR.<br /></td> <td><code>boolean</code></td> -<td><code>2.0-beta-6</code></td> +<td><code>-</code></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> @@ -265,65 +251,55 @@ into the JAR.<br /></td> <td align="left"><code><a href="#attributes"><attributes></a></code></td> -<td><code>Map</code></td> +<td><code>Map<String,Object></code></td> -<td><code>2.0-beta-6</code></td> +<td><code>-</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> +<td>Additional template properties for rendering the site. See Doxia Site Renderer.<br /></td> </tr> <tr class="a"> -<td align="left"><code><a href="#generateProjectInfo"><generateProjectInfo></a></code></td> +<td align="left"><code><a href="#generatedSiteDirectory"><generatedSiteDirectory></a></code></td> -<td><code>boolean</code></td> +<td><code>File</code></td> -<td><code>2.3</code></td> +<td><code>-</code></td> -<td>Whether to generate the summary page for project reports: -project-info.html.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>generateProjectInfo</code>.<br /></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 <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>: <code>${project.build.directory}/generated-site</code>.<br /><b>Alias is</b>: <code>workingDirectory</code>.</td> </tr> <tr class="b"> -<td align="left"><code><a href="#generateReports"><generateReports></a></code></td> +<td align="left"><code><a href="#generateProjectInfo"><generateProjectInfo></a></code></td> <td><code>boolean</code></td> -<td><code>2.0-beta-6</code></td> +<td><code>2.3</code></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> +<td>Whether to generate the summary page for project reports: 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="a"> -<td align="left"><code><a href="#generateSitemap"><generateSitemap></a></code></td> +<td align="left"><code><a href="#generateReports"><generateReports></a></code></td> <td><code>boolean</code></td> -<td><code>2.1</code></td> +<td><code>-</code></td> -<td>Generate a sitemap. The result will be a "sitemap.html" file at the -site root.<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>generateSitemap</code>.<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="b"> -<td align="left"><code><a href="#generatedSiteDirectory"><generatedSiteDirectory></a></code></td> +<td align="left"><code><a href="#generateSitemap"><generateSitemap></a></code></td> -<td><code>File</code></td> +<td><code>boolean</code></td> -<td><code>2.0-beta-6</code></td> +<td><code>2.1</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 <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>: <code>${project.build.directory}/generated-site</code>.<br /><b>Alias is</b>: <code>workingDirectory</code>.</td> +<td>Generate a sitemap. The result will be a "sitemap.html" file at the 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="a"> @@ -345,21 +321,20 @@ source intermediate step?<br /><b>Defaul <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>: <code>default</code>.<br /><b>User property is</b>: <code>locales</code>.<br /></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>: <code>default</code>.<br /><b>User property is</b>: <code>locales</code>.<br /></td> </tr> <tr class="a"> <td align="left"><code><a href="#moduleExcludes"><moduleExcludes></a></code></td> -<td><code>Map</code></td> +<td><code>Map<String,String></code></td> -<td><code>2.0-beta-6</code></td> +<td><code>-</code></td> -<td>Module type exclusion mappings ex: <code>fml -> -**/*-m1.fml</code> (excludes fml files ending in '-m1.fml' -recursively) The configuration looks like this: +<td>Module type exclusion mappings ex: <code>fml -> **/*-m1.fml</code> (excludes fml files ending in '-m1.fml' recursively) + +<p></p> The configuration looks like this: <div> <pre> @@ -380,10 +355,9 @@ recursively) The configuration looks lik <td><code>File</code></td> -<td><code>2.0-beta-6</code></td> +<td><code>-</code></td> -<td>Directory where the project sites and report distributions will be -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> +<td>Directory where the project sites and report distributions will be 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"> @@ -405,9 +379,7 @@ generated (as html/css/...).<br /><b>Def <td><code>3.9.0</code></td> -<td>Timestamp for reproducible output archive entries, either formatted -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> +<td>Timestamp for reproducible output archive entries, either formatted 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"> @@ -418,11 +390,9 @@ representing seconds since the epoch (li <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>: <code>true</code>.<br /><b>User property is</b>: <code>relativizeDecorationLinks</code>.<br /></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. + +<p></p> 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>: <code>true</code>.<br /><b>User property is</b>: <code>relativizeDecorationLinks</code>.<br /></td> </tr> <tr class="b"> @@ -433,9 +403,7 @@ to false, or if the project has no URL d <td><code>3.5</code></td> -<td>Whether to save Velocity processed Doxia content -(<code>*.<ext>.vm</code>) to -<code>${generatedSiteDirectory}/processed</code>.<br /></td> +<td>Whether to save Velocity processed Doxia content (<code>*.<ext>.vm</code>) to <code>${generatedSiteDirectory}/processed</code>.<br /></td> </tr> <tr class="a"> @@ -446,10 +414,7 @@ to false, or if the project has no URL d <td><code>2.3</code></td> -<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>: <code>${basedir}/src/site</code>.<br /></td> +<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 Doxia Markup Languages References).<br /><b>Default value is</b>: <code>${basedir}/src/site</code>.<br /></td> </tr> <tr class="b"> @@ -471,10 +436,7 @@ Markup Languages References</a>).<br />< <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>: <code>false</code>.<br /><b>User property is</b>: <code>validate</code>.<br /></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>: <code>false</code>.<br /><b>User property is</b>: <code>validate</code>.<br /></td> </tr> <tr class="b"> @@ -483,9 +445,9 @@ failure.<br /><b>Default value is</b>: < <td><code>File</code></td> -<td><code>2.0-beta-6</code></td> +<td><code>-</code></td> -<td><b>Deprecated.</b> use the standard m2 directory layout<br /><b>Default value is</b>: <code>${basedir}/xdocs</code>.<br /></td> +<td><b>Deprecated.</b> Alternative directory for xdoc source, useful for m1 to m2 migration<br /><b>Default value is</b>: <code>${basedir}/xdocs</code>.<br /></td> </tr> </table> </section> @@ -494,8 +456,7 @@ failure.<br /><b>Default value is</b>: < <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 -Archiver Reference</a>.</div> +<div>The archive configuration to use. See <a class="externalLink" href="http://maven.apache.org/shared/maven-archiver/index.html";>Maven Archiver Reference</a>.</div> <ul> @@ -507,9 +468,7 @@ Archiver Reference</a>.</div> </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 -relative to the input directory whose contents is being packaged -into the JAR.</div> +<div>List of files to exclude. Specified as file set patterns which are relative to the input directory whose contents is being packaged into the JAR.</div> <ul> @@ -521,9 +480,7 @@ into the JAR.</div> </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 -relative to the input directory whose contents is being packaged -into the JAR.</div> +<div>List of files to include. Specified as file set patterns which are relative to the input directory whose contents is being packaged into the JAR.</div> <ul> @@ -541,8 +498,6 @@ into the JAR.</div> <li><b>Type</b>: <code>boolean</code></li> -<li><b>Since</b>: <code>2.0-beta-6</code></li> - <li><b>Required</b>: <code>No</code></li> <li><b>User Property</b>: <code>site.attach</code></li> @@ -551,36 +506,43 @@ into the JAR.</div> </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 -Renderer</a>.</div> +<div>Additional template properties for rendering the site. See Doxia Site Renderer.</div> <ul> -<li><b>Type</b>: <code>java.util.Map</code></li> - -<li><b>Since</b>: <code>2.0-beta-6</code></li> +<li><b>Type</b>: <code>java.util.Map<java.lang.String, java.lang.Object></code></li> <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 -file. Please note that "-site" will be appended to the file name.</div> +<div>Specifies the filename that will be used for the generated jar file. Please note that "-site" will be appended to the file name.</div> <ul> <li><b>Type</b>: <code>java.lang.String</code></li> -<li><b>Since</b>: <code>2.0-beta-6</code></li> - <li><b>Required</b>: <code>Yes</code></li> <li><b>User Property</b>: <code>project.build.finalName</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 <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>: <code>java.io.File</code></li> + +<li><b>Required</b>: <code>No</code></li> + +<li><b>Default</b>: <code>${project.build.directory}/generated-site</code></li> + +<li><b>Alias</b>: <code>workingDirectory</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: -project-info.html.</div> +<div>Whether to generate the summary page for project reports: project-info.html.</div> <ul> @@ -602,8 +564,6 @@ project-info.html.</div> <li><b>Type</b>: <code>boolean</code></li> -<li><b>Since</b>: <code>2.0-beta-6</code></li> - <li><b>Required</b>: <code>No</code></li> <li><b>User Property</b>: <code>generateReports</code></li> @@ -612,8 +572,7 @@ project-info.html.</div> </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 -site root.</div> +<div>Generate a sitemap. The result will be a "sitemap.html" file at the site root.</div> <ul> @@ -627,29 +586,6 @@ site root.</div> <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 <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>: <code>java.io.File</code></li> - -<li><b>Since</b>: <code>2.0-beta-6</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>Default</b>: <code>${project.build.directory}/generated-site</code></li> - -<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> @@ -674,16 +610,13 @@ source intermediate step?</div> <li><b>Type</b>: <code>java.lang.String</code></li> -<li><b>Since</b>: <code>2.0-beta-6</code></li> - <li><b>Required</b>: <code>Yes</code></li> <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 -will be the default Locale for this site.</div> +<div>A comma separated list of locales to render. The first valid token will be the default Locale for this site.</div> <ul> @@ -699,9 +632,9 @@ will be the default Locale for this site </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: <code>fml -> -**/*-m1.fml</code> (excludes fml files ending in '-m1.fml' -recursively) The configuration looks like this: +<div>Module type exclusion mappings ex: <code>fml -> **/*-m1.fml</code> (excludes fml files ending in '-m1.fml' recursively) + +<p></p> The configuration looks like this: <div> <pre> @@ -717,23 +650,18 @@ recursively) The configuration looks lik <ul> -<li><b>Type</b>: <code>java.util.Map</code></li> - -<li><b>Since</b>: <code>2.0-beta-6</code></li> +<li><b>Type</b>: <code>java.util.Map<java.lang.String, java.lang.String></code></li> <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 -generated (as html/css/...).</div> +<div>Directory where the project sites and report distributions will be generated (as html/css/...).</div> <ul> <li><b>Type</b>: <code>java.io.File</code></li> -<li><b>Since</b>: <code>2.0-beta-6</code></li> - <li><b>Required</b>: <code>No</code></li> <li><b>User Property</b>: <code>siteOutputDirectory</code></li> @@ -758,9 +686,7 @@ generated (as html/css/...).</div> </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 <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> +<div>Timestamp for reproducible output archive entries, either formatted 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> @@ -774,11 +700,9 @@ representing seconds since the epoch (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 -default, any absolute links that appear in the site descriptor, -e.g. banner hrefs, breadcrumbs, menu links, etc., will be made -relative to project.url. Links will not be changed if this is set -to false, or if the project has no URL defined.</div> +<div>Make links in the site descriptor relative to the project URL. By default, any absolute links that appear in the site descriptor, e.g. banner hrefs, breadcrumbs, menu links, etc., will be made relative to project.url. + +<p></p> Links will not be changed if this is set to false, or if the project has no URL defined.</div> <ul> @@ -794,9 +718,7 @@ to false, or if the project has no URL d </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 -(<code>*.<ext>.vm</code>) to -<code>${generatedSiteDirectory}/processed</code>.</div> +<div>Whether to save Velocity processed Doxia content (<code>*.<ext>.vm</code>) to <code>${generatedSiteDirectory}/processed</code>.</div> <ul> @@ -808,10 +730,7 @@ to false, or if the project has no URL d </ul><hr /></section><section> <h4><a name="a.3CsiteDirectory.3E"></a><b><a name="siteDirectory"><siteDirectory></a></b></h4> -<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> +<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 Doxia Markup Languages References).</div> <ul> @@ -841,10 +760,7 @@ Markup Languages References</a>).</div> </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, -<b>all</b> input documents in xml format (in particular -xdoc and fml) will be validated and any error will lead to a build -failure.</div> +<div>Whether to validate xml input documents. If set to true, <b>all</b> input documents in xml format (in particular xdoc and fml) will be validated and any error will lead to a build failure.</div> <ul> @@ -862,15 +778,12 @@ failure.</div> <div><b>Deprecated.</b> use the standard m2 directory layout</div> -<div>Alternative directory for xdoc source, useful for m1 to m2 -migration</div> +<div>Alternative directory for xdoc source, useful for m1 to m2 migration</div> <ul> <li><b>Type</b>: <code>java.io.File</code></li> -<li><b>Since</b>: <code>2.0-beta-6</code></li> - <li><b>Required</b>: <code>No</code></li> <li><b>Default</b>: <code>${basedir}/xdocs</code></li> @@ -886,7 +799,7 @@ migration</div> <footer> <div class="container-fluid"> <div class="row-fluid"> - <p>© 2002–2022 + <p>© 2002–2023 <a href="https://www.apache.org/";>The Apache Software Foundation</a> </p> </div>
