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 [13/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/examples/creating-content.html
==============================================================================
--- maven/website/components/plugins-archives/maven-site-plugin-LATEST/examples/creating-content.html (original)
+++ maven/website/components/plugins-archives/maven-site-plugin-LATEST/examples/creating-content.html Wed Apr 27 21:24:50 2022
@@ -1,57 +1,64 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from src\site\apt/examples\creating-content.apt.vm at 2022-04-16
- | Rendered using Apache Maven Fluido Skin 1.7
+ | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src\site\apt/examples\creating-content.apt.vm 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="viewport" content="width=device-width, initial-scale=1" />
+ <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" />
<meta name="author" content="Dennis Lundberg" />
- <meta name="Date-Creation-yyyymmdd" content="20090308" />
- <meta name="Date-Revision-yyyymmdd" content="20220416" />
- <meta http-equiv="Content-Language" content="en" />
+ <meta name="date" content="2009-03-08" />
<title>Apache Maven Site Plugin – Creating Content</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 ">Creating Content <a href="https://github.com/apache/maven-site-plugin/tree/maven-site-plugin-3.12.0/src\site\apt/examples\creating-content.apt.vm"><img src="../images/accessories-text-editor.png" title="Edit" /></a></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 class="active ">Creating Content <a href="https://github.com/apache/maven-site-plugin/tree/maven-site-plugin-4.0.0-M1/src\site\apt/examples\creating-content.apt.vm"><img src="../images/accessories-text-editor.png" title="Edit" /></a></li>
+ <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>
@@ -60,28 +67,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 class="active"><a href="#"><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>
@@ -94,33 +101,34 @@
<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" >
-<div class="section">
+ </header>
+ <main id="bodyColumn" class="span10" >
+<section>
<h2><a name="Creating_Content"></a>Creating Content</h2>
<p>Now it's time to create some content for your site. In Maven 2, the site content is structured by format, as there are several formats supported.</p>
<ul>
@@ -129,8 +137,7 @@
<li><a href="#Filtering">Filtering</a>
<ul>
<li><a href="#Common_Issues_and_Workarounds">Common Issues and Workarounds</a></li></ul></li>
-<li><a href="#Internationalization">Internationalization</a></li></ul>
-<div class="section">
+<li><a href="#Internationalization">Internationalization</a></li></ul><section>
<h3><a name="Documentation_formats"></a>Documentation formats</h3>
<p>Here's an example of a directory structure for a site:</p>
<div>
@@ -157,14 +164,14 @@
|
+- 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 <code>${basedir}/src/site</code> 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>
<ul>
<li>APT: 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 href="/doxia/references/apt-format.html"> APT Format</a> is available.</li>
<li>FML: The FML format is the FAQ format. This is the same that were used in Maven 1.x. For more info about the <a href="/doxia/references/fml-format.html">FML Format</a> check the <a href="/doxia/">Doxia</a> site.</li>
<li>XDoc: The XDoc format is the same as <a href="/maven-1.x/using/site.html"> used in Maven 1.x</a>. A reference for the <a href="/doxia/references/xdoc-format.html"> XDoc Format</a> is available.</li>
<li>Markdown (since maven-site-plugin 3.3): <a class="externalLink" href="http://en.wikipedia.org/wiki/Markdown"> Markdown</a> is a widespread Markup language.</li></ul>
<p>Other formats are available, but the above four are recognized by default by the site plugin. Any other document format for which a Doxia parser exists can be used as well (see the list of <a href="/doxia/references/index.html">Doxia Markup Languages</a>), but in this case you need to add the corresponding Doxia dependency to your site plugin configuration, as explained in the last paragraph. Note that Doxia also supports several output formats, the site plugin only creates XHTML5.</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>
+<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 '<code>mvn site:site</code>' on the example above you will end up with this in your <code>target</code> directory:</p>
<div>
<pre>+- target/
+- site/
@@ -179,11 +186,10 @@
+- xhtml-too.html
+- xhtml5-content.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>
-<div class="section">
+<p>This means that <code>/src/site/apt/index.apt</code> will be available in the site as <code>/index.html</code>. So, in <a href="./sitedescriptor.html"> your site descriptor</a> you might link to <code>/index.html</code> and <code>/other.html</code>, where the source of these two files would be <code>/src/site/apt/index.apt</code> and <code>/src/site/xdoc/other.xdoc</code>.</p>
+<p>The <code>css</code> and <code>images</code> 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></section><section>
<h3><a name="Adding_Extra_Resources"></a>Adding Extra Resources</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>
+<p>You can add any arbitrary resource to your site by including them in a <code>resources</code> directory as shown below. Additional CSS files can be picked up when they are placed in the <code>css</code> directory within the <code>resources</code> directory.</p>
<div>
<pre>+- src/
+- site/
@@ -194,25 +200,22 @@
+- images/
+- pic1.jpg
</pre></div>
-<p>The file <tt>site.css</tt> will be added to the default XHTML5 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">
+<p>The file <code>site.css</code> will be added to the default XHTML5 output, so it can be used to adjust the default Maven stylesheets if desired.</p>
+<p>The file <code>pic1.jpg</code> will be available via a relative reference to the <code>images</code> directory from any page in your site.</p></section><section>
<h3><a name="Filtering"></a>Filtering</h3>
-<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/content/xdoc/download.xml.vm"><tt>content/xdoc/download.xml.vm</tt></a> file, which uses the expression <tt>${currentStableVersion}</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>To filter properties into any supported documentation format, add a <code>.vm</code> 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/content/xdoc/download.xml.vm"><code>content/xdoc/download.xml.vm</code></a> file, which uses the expression <code>${currentStableVersion}</code> 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/">Apache Velocity</a> is used to apply the filtering.</p>
<p>Some properties are defined by default: see <a href="/doxia/doxia-sitetools/doxia-site-renderer/#Velocity_processing"> Doxia Site Renderer's Velocity processing reference</a> for more information. For a complete usage overview, see Velocity's <a class="externalLink" href="http://velocity.apache.org/engine/devel/user-guide.html">user guide</a>.</p>
-<p>Since version 3.5, you can save processed markup by setting <tt>saveProcessedContent</tt> to <tt>true</tt>: see <a href="../site-mojo.html#saveProcessedContent">corresponding documentation</a> for more details.</p>
-<div class="section">
+<p>Since version 3.5, you can save processed markup by setting <code>saveProcessedContent</code> to <code>true</code>: see <a href="../site-mojo.html#saveProcessedContent">corresponding documentation</a> for more details.</p><section>
<h4><a name="Common_Issues_and_Workarounds"></a>Common Issues and Workarounds</h4>
<ul>
<li><b>dotted properties</b>:
-<p>As Velocity uses a dot-notation to traverse beans, you <b>cannot</b> use dotted properties defined in <tt><properties></tt> directly.</p>
-<p>It is generally advised to access properties by using the <tt>$context</tt> tool: e.g., with <tt>$context.get("my.property")</tt>.</p></li>
+<p>As Velocity uses a dot-notation to traverse beans, you <b>cannot</b> use dotted properties defined in <code><properties></code> directly.</p>
+<p>It is generally advised to access properties by using the <code>$context</code> tool: e.g., with <code>$context.get("my.property")</code>.</p></li>
<li><b>Markdown conflict with Velocity on ## syntax</b>:
-<p>Since <tt>##</tt> denotes a <a class="externalLink" href="http://velocity.apache.org/engine/1.7/vtl-reference.html#single-line-comments">single line comment</a> in Velocity, Markdown headers using this syntax are suppressed from generated content.</p>
-<p>You can use <a class="externalLink" href="http://velocity.apache.org/engine/1.7/vtl-reference.html#unparsed-content">unparsed content syntax</a> <tt>#[[##]]#</tt> or <a class="externalLink" href="http://velocity.apache.org/tools/2.0/apidocs/org/apache/velocity/tools/generic/EscapeTool.html">escape tool</a> like <tt>${esc.h}${esc.h}</tt>.</p></li></ul></div></div>
-<div class="section">
+<p>Since <code>##</code> denotes a <a class="externalLink" href="http://velocity.apache.org/engine/1.7/vtl-reference.html#single-line-comments">single line comment</a> in Velocity, Markdown headers using this syntax are suppressed from generated content.</p>
+<p>You can use <a class="externalLink" href="http://velocity.apache.org/engine/1.7/vtl-reference.html#unparsed-content">unparsed content syntax</a> <code>#[[##]]#</code> or <a class="externalLink" href="http://velocity.apache.org/tools/2.0/apidocs/org/apache/velocity/tools/generic/EscapeTool.html">escape tool</a> like <code>${esc.h}${esc.h}</code>.</p></li></ul></section></section><section>
<h3><a name="Internationalization"></a>Internationalization</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>
@@ -223,7 +226,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
- <version>3.12.0</version>
+ <version>4.0.0-M1</version>
<configuration>
<locales>en,fr</locales>
</configuration>
@@ -233,7 +236,7 @@
...
</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>This will generate both an English and a French version of the site. If <code>en</code> 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 <code>fr/</code> 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/
@@ -248,19 +251,24 @@
+- 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>
- </div>
+<p>With one site descriptor per language, the translated site(s) can evolve independently.</p></section></section>
+ </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
Modified: maven/website/components/plugins-archives/maven-site-plugin-LATEST/examples/creatingskins.html
==============================================================================
--- maven/website/components/plugins-archives/maven-site-plugin-LATEST/examples/creatingskins.html (original)
+++ maven/website/components/plugins-archives/maven-site-plugin-LATEST/examples/creatingskins.html Wed Apr 27 21:24:50 2022
@@ -1,58 +1,65 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from src\site\apt/examples\creatingskins.apt at 2022-04-16
- | Rendered using Apache Maven Fluido Skin 1.7
+ | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src\site\apt/examples\creatingskins.apt 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="viewport" content="width=device-width, initial-scale=1" />
+ <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" />
<meta name="author" content="Brett Porter
Dennis Lundberg" />
- <meta name="Date-Creation-yyyymmdd" content="20090308" />
- <meta name="Date-Revision-yyyymmdd" content="20220416" />
- <meta http-equiv="Content-Language" content="en" />
+ <meta name="date" content="2009-03-08" />
<title>Apache Maven Site Plugin – Creating Skins</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 ">Creating Skins <a href="https://github.com/apache/maven-site-plugin/tree/maven-site-plugin-3.12.0/src\site\apt/examples\creatingskins.apt"><img src="../images/accessories-text-editor.png" title="Edit" /></a></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 class="active ">Creating Skins <a href="https://github.com/apache/maven-site-plugin/tree/maven-site-plugin-4.0.0-M1/src\site\apt/examples\creatingskins.apt"><img src="../images/accessories-text-editor.png" title="Edit" /></a></li>
+ <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>
@@ -61,28 +68,28 @@ Dennis Lundberg" />
<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 class="active"><a href="#"><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>
@@ -95,72 +102,73 @@ Dennis Lundberg" />
<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" >
-<div class="section">
+ </header>
+ <main id="bodyColumn" class="span10" >
+<section>
<h2><a name="Creating_Skins"></a>Creating Skins</h2>
<p>If you want to tune the way your site looks, you can use a custom skin to provide your own CSS stylesheets. If that is still not enough, you can even tweak the output templates that Maven uses to generate the site documentation.</p>
-<p>For an in-depth discussion of site customization, please have a look at <a class="externalLink" href="http://books.sonatype.com/mvnref-book/reference/site-generation.html"> Maven: The Complete Reference, Chapter 10. Site Generation</a> provided by Sonatype.</p>
-<div class="section">
+<p>For an in-depth discussion of site customization, please have a look at <a class="externalLink" href="http://books.sonatype.com/mvnref-book/reference/site-generation.html"> Maven: The Complete Reference, Chapter 10. Site Generation</a> provided by Sonatype.</p><section>
<h3><a name="About"></a>About</h3>
<p>A skin contains the following elements:</p>
<ul>
<li>Resources to copy into each project (such as images used by the CSS)</li>
<li>A couple of CSS files, containing the visual styling</li>
-<li>An optional Velocity template in <tt>/META-INF/maven/site.vm</tt> for an alternate HTML rendering of the site (by default, <a href="/doxia/doxia-sitetools/doxia-site-renderer/">Doxia Site Renderer</a>'s <a class="externalLink" href="https://github.com/apache/maven-doxia-sitetools/blob/master/doxia-site-renderer/src/main/resources/org/apache/maven/doxia/siterenderer/resources/default-site.vm"><tt>default-site.vm</tt></a> is used</li>
-<li>Since Maven Site Plugin 3.5, an optional <a href="/doxia/doxia-sitetools/doxia-skin-model/index.html">skin descriptor</a> in <tt>/META-INF/maven/skin.xml</tt> containing meta-data about the skin</li></ul></div>
-<div class="section">
+<li>An optional Velocity template in <code>/META-INF/maven/site.vm</code> for an alternate HTML rendering of the site (by default, <a href="/doxia/doxia-sitetools/doxia-site-renderer/">Doxia Site Renderer</a>'s <a class="externalLink" href="https://github.com/apache/maven-doxia-sitetools/blob/master/doxia-site-renderer/src/main/resources/org/apache/maven/doxia/siterenderer/resources/default-site.vm"><code>default-site.vm</code></a> is used</li>
+<li>Since Maven Site Plugin 3.5, an optional <a href="/doxia/doxia-sitetools/doxia-skin-model/index.html">skin descriptor</a> in <code>/META-INF/maven/skin.xml</code> containing meta-data about the skin</li></ul></section><section>
<h3><a name="Maven_Site_Skin_Archetype"></a>Maven Site Skin Archetype</h3>
-<p><a href="/archetypes/maven-archetype-site-skin/"><tt>maven-archetype-site-skin</tt> archetype</a> can be used to easily create a complete new skin project, including its dedicated <tt>/META-INF/maven/site.vm</tt>.</p></div>
-<div class="section">
+<p><a href="/archetypes/maven-archetype-site-skin/"><code>maven-archetype-site-skin</code> archetype</a> can be used to easily create a complete new skin project, including its dedicated <code>/META-INF/maven/site.vm</code>.</p></section><section>
<h3><a name="Building"></a>Building</h3>
-<p>A skin is built like any other JAR - with a <tt>packaging</tt> of <tt>jar</tt>. No additional plugins are needed.</p>
-<p>Resources should be put in the normal <tt>src/main/resources</tt> directory.</p>
-<p>Once the JAR is built and deployed, it can be used by projects.</p></div>
-<div class="section">
+<p>A skin is built like any other JAR - with a <code>packaging</code> of <code>jar</code>. No additional plugins are needed.</p>
+<p>Resources should be put in the normal <code>src/main/resources</code> directory.</p>
+<p>Once the JAR is built and deployed, it can be used by projects.</p></section><section>
<h3><a name="Constructing_the_CSS"></a>Constructing the CSS</h3>
-<p>If you are interested in constructing your own CSS, it is recommended that you copy the file <a class="externalLink" href="https://github.com/apache/maven-default-skin/tree/master/src/main/resources/css/maven-theme.css"><tt>maven-theme.css</tt></a> from Maven Default Skin and modify it to suit your needs.</p></div>
-<div class="section">
+<p>If you are interested in constructing your own CSS, it is recommended that you copy the file <a class="externalLink" href="https://github.com/apache/maven-default-skin/tree/master/src/main/resources/css/maven-theme.css"><code>maven-theme.css</code></a> from Maven Default Skin and modify it to suit your needs.</p></section><section>
<h3><a name="Customizing_the_HTML_Output_with_a_Velocity_Template"></a>Customizing the HTML Output with a Velocity Template</h3>
-<p>The format of the Velocity template is currently out of scope for this document. To attempt this, start by copying <tt><a class="externalLink" href="https://github.com/apache/maven-doxia-sitetools/blob/master/doxia-site-renderer/src/main/resources/org/apache/maven/doxia/siterenderer/resources/default-site.vm">default-site.vm</a></tt> to <tt>src/main/resources/META-INF/maven/site.vm</tt> in your project and then modify it to your needs.</p>
+<p>The format of the Velocity template is currently out of scope for this document. To attempt this, start by copying <code><a class="externalLink" href="https://github.com/apache/maven-doxia-sitetools/blob/master/doxia-site-renderer/src/main/resources/org/apache/maven/doxia/siterenderer/resources/default-site.vm">default-site.vm</a></code> to <code>src/main/resources/META-INF/maven/site.vm</code> in your project and then modify it to your needs.</p>
<p>For more information about how to write Velocity templates see the <a class="externalLink" href="http://velocity.apache.org/engine/releases/velocity-1.7/user-guide.html">Velocity User Guide</a> and <a class="externalLink" href="http://velocity.apache.org/engine/releases/velocity-1.7/vtl-reference-guide.html">Velocity Template Language Reference Guide</a>.</p>
-<p>Notice that Velocity 1.7 is used since Maven Site Plugin 3.5, but version 1.5 was used previously.</p></div></div>
- </div>
+<p>Notice that Velocity 1.7 is used since Maven Site Plugin 3.5, but version 1.5 was used previously.</p></section></section>
+ </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
Modified: maven/website/components/plugins-archives/maven-site-plugin-LATEST/examples/moduleexcludes.html
==============================================================================
--- maven/website/components/plugins-archives/maven-site-plugin-LATEST/examples/moduleexcludes.html (original)
+++ maven/website/components/plugins-archives/maven-site-plugin-LATEST/examples/moduleexcludes.html Wed Apr 27 21:24:50 2022
@@ -1,57 +1,64 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from src\site\apt/examples\moduleexcludes.apt.vm at 2022-04-16
- | Rendered using Apache Maven Fluido Skin 1.7
+ | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src\site\apt/examples\moduleexcludes.apt.vm 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="viewport" content="width=device-width, initial-scale=1" />
+ <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" />
<meta name="author" content="Maria Odea Ching" />
- <meta name="Date-Creation-yyyymmdd" content="20090308" />
- <meta name="Date-Revision-yyyymmdd" content="20220416" />
- <meta http-equiv="Content-Language" content="en" />
+ <meta name="date" content="2009-03-08" />
<title>Apache Maven Site Plugin – Excluding Document Formats</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 ">Excluding Document Formats <a href="https://github.com/apache/maven-site-plugin/tree/maven-site-plugin-3.12.0/src\site\apt/examples\moduleexcludes.apt.vm"><img src="../images/accessories-text-editor.png" title="Edit" /></a></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 class="active ">Excluding Document Formats <a href="https://github.com/apache/maven-site-plugin/tree/maven-site-plugin-4.0.0-M1/src\site\apt/examples\moduleexcludes.apt.vm"><img src="../images/accessories-text-editor.png" title="Edit" /></a></li>
+ <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>
@@ -60,28 +67,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 class="active"><a href="#"><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>
@@ -94,35 +101,36 @@
<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" >
-<div class="section">
+ </header>
+ <main id="bodyColumn" class="span10" >
+<section>
<h2><a name="Excluding_Document_Formats"></a>Excluding Document Formats</h2>
-<p>To exclude specific document formats from the generated site, you can use the <tt>moduleExcludes</tt> parameter.</p>
+<p>To exclude specific document formats from the generated site, you can use the <code>moduleExcludes</code> parameter.</p>
<p>For example, you have the following site content in your POM</p>
<div>
<pre>Module1
@@ -135,7 +143,7 @@
| `-- 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>
+<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 "<code>mvn site</code>".</p>
<div class="source"><pre class="prettyprint linenums"><project>
...
<build>
@@ -143,7 +151,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
- <version>3.12.0</version>
+ <version>4.0.0-M1</version>
<configuration>
<moduleExcludes>
<fml>*.fml</fml>
@@ -155,20 +163,25 @@
...
</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>
+<p>You will see that no <code>sample-fml.html</code> 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></section>
+ </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
Modified: maven/website/components/plugins-archives/maven-site-plugin-LATEST/examples/multimodule.html
==============================================================================
--- maven/website/components/plugins-archives/maven-site-plugin-LATEST/examples/multimodule.html (original)
+++ maven/website/components/plugins-archives/maven-site-plugin-LATEST/examples/multimodule.html Wed Apr 27 21:24:50 2022
@@ -1,61 +1,68 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from src\site\apt/examples\multimodule.apt at 2022-04-16
- | Rendered using Apache Maven Fluido Skin 1.7
+ | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src\site\apt/examples\multimodule.apt 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="viewport" content="width=device-width, initial-scale=1" />
+ <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" />
<meta name="author" content="Vincent Siveton
vincent.siveton@gmail.com
Maria Odea Ching
Dennis Lundberg
Lukas Theussl" />
- <meta name="Date-Creation-yyyymmdd" content="20110118" />
- <meta name="Date-Revision-yyyymmdd" content="20220416" />
- <meta http-equiv="Content-Language" content="en" />
+ <meta name="date" content="2011-01-18" />
<title>Apache Maven Site Plugin – Multi-module Sites</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 ">Multi-module Sites <a href="https://github.com/apache/maven-site-plugin/tree/maven-site-plugin-3.12.0/src\site\apt/examples\multimodule.apt"><img src="../images/accessories-text-editor.png" title="Edit" /></a></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 class="active ">Multi-module Sites <a href="https://github.com/apache/maven-site-plugin/tree/maven-site-plugin-4.0.0-M1/src\site\apt/examples\multimodule.apt"><img src="../images/accessories-text-editor.png" title="Edit" /></a></li>
+ <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>
@@ -64,28 +71,28 @@ Lukas Theussl" />
<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 class="active"><a href="#"><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>
@@ -98,53 +105,52 @@ Lukas Theussl" />
<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" >
-<div class="section">
+ </header>
+ <main id="bodyColumn" class="span10" >
+<section>
<h2><a name="Building_multi-module_sites"></a>Building multi-module sites</h2>
-<p>When running <tt>mvn site</tt> on a top level project, Maven will build all sites for every module defined in the <tt>modules</tt> section of the pom individually. Note that each site is generated in each individual project's target location. As a result, relative links between different modules will NOT work. They will however work when you deploy or stage the site.</p>
-<div class="section">
+<p>When running <code>mvn site</code> on a top level project, Maven will build all sites for every module defined in the <code>modules</code> section of the pom individually. Note that each site is generated in each individual project's target location. As a result, relative links between different modules will NOT work. They will however work when you deploy or stage the site.</p><section>
<h3><a name="Staging_and_deploying"></a>Staging and deploying</h3>
-<p>To preview the whole tree of a multi-module site, you can use the <tt><a href="../stage-mojo.html">site:stage</a></tt> goal. This will copy individual sites to their proper place at the staging location.</p>
-<p><tt><a href="../deploy-mojo.html">site:deploy</a></tt> does the same thing as <tt>site:stage</tt>, but uses the url defined in the <tt><distributionManagement></tt> element of the pom as deployment location. This is usually a remote url, but both remote protocols like <tt>scp</tt> and local protocols like <tt>file</tt> are supported.</p>
-<p>Finally, <tt><a href="../stage-deploy-mojo.html">site:stage-deploy</a></tt> does the same thing as <tt>site:deploy</tt> but uses the <tt>stagingDirectory</tt> parameter as deployment location. This can be used to deploy the site to a remote staging area (<tt>site:stage</tt> is always local).</p>
+<p>To preview the whole tree of a multi-module site, you can use the <code><a href="../stage-mojo.html">site:stage</a></code> goal. This will copy individual sites to their proper place at the staging location.</p>
+<p><code><a href="../deploy-mojo.html">site:deploy</a></code> does the same thing as <code>site:stage</code>, but uses the url defined in the <code><distributionManagement></code> element of the pom as deployment location. This is usually a remote url, but both remote protocols like <code>scp</code> and local protocols like <code>file</code> are supported.</p>
+<p>Finally, <code><a href="../stage-deploy-mojo.html">site:stage-deploy</a></code> does the same thing as <code>site:deploy</code> but uses the <code>stagingDirectory</code> parameter as deployment location. This can be used to deploy the site to a remote staging area (<code>site:stage</code> is always local).</p>
<p><b>Notes:</b></p>
<ul>
-<li>If subprojects inherit the (distribution) site URL from a parent POM, they will automatically append their <i>artifactId</i> to form their effective deployment location. This goes for both the project url and the url defined in the <tt><distributionManagement></tt> element of the pom.</li>
-<li>If your multi-module tree does not follow the Maven conventions, or if module directories are named differently than module artifacts, you have to specify the url's for <b>each</b> child project. See also <tt><a href="../faq.html#Use_of_url">How does the Site Plugin use the <url> element in the POM?</a></tt>.</li>
+<li>If subprojects inherit the (distribution) site URL from a parent POM, they will automatically append their <i>artifactId</i> to form their effective deployment location. This goes for both the project url and the url defined in the <code><distributionManagement></code> element of the pom.</li>
+<li>If your multi-module tree does not follow the Maven conventions, or if module directories are named differently than module artifacts, you have to specify the url's for <b>each</b> child project. See also <code><a href="../faq.html#Use_of_url">How does the Site Plugin use the <url> element in the POM?</a></code>.</li>
<li>The pom.xml of the topmost project in a multi-module build must define the distributionManagement URL element (called "rootURL" hereafter). The rootURL must be the topmost distributionManagement URL in the multi-module project, implying that any distributionManagement URL defined within another project in a multimodule build must start with the rootURL and append unique paths (to be situated "below" the rootURL).</li>
<li>All projects in multi-module builds must define unique distributionManagement url elements, below/under the root distributionManagement URL in terms of URL path.</li>
-<li>If the artifactId and module name (i.e. directory name) are not identical for any project within a multi-module build, the distributionManagement URL element must be defined in the pom.xml file in the project.</li></ul></div>
-<div class="section">
+<li>If the artifactId and module name (i.e. directory name) are not identical for any project within a multi-module build, the distributionManagement URL element must be defined in the pom.xml file in the project.</li></ul></section><section>
<h3><a name="Inheritance"></a>Inheritance</h3>
-<p>Site descriptors are inherited along the same lines as project descriptors are. If you want your project's site descriptor to be inherited, you need to attach it to the project's main artifact. You use the <tt><a href="../attach-descriptor-mojo.html">site:attach-descriptor</a></tt> goal to attach the site descriptor to your project's main artifact.</p>
+<p>Site descriptors are inherited along the same lines as project descriptors are. If you want your project's site descriptor to be inherited, you need to attach it to the project's main artifact. You use the <code><a href="../attach-descriptor-mojo.html">site:attach-descriptor</a></code> goal to attach the site descriptor to your project's main artifact.</p>
<p>In Maven 3 you must attach the site descriptor yourself, even for projects with packaging set to "pom".</p>
<p>By default, all the parent descriptor settings are inherited with the only exception of menus, see below. From the body, the links and breadcrumbs accumulate to contain all the parent's site descriptor links and breadcrumbs. If the parent contains some breadcrumb and the inheriting site descriptor doesn't, a breadcrumb with the current site descriptor's name will be added automatically.</p>
-<p>However, it is possible to inherit menus as well. To do so, use the <tt>inherit</tt> attribute in the site descriptor. This can be either <tt>top</tt> or <tt>bottom</tt>, indicating where the inherited menu will be placed. For example:</p>
+<p>However, it is possible to inherit menus as well. To do so, use the <code>inherit</code> attribute in the site descriptor. This can be either <code>top</code> or <code>bottom</code>, indicating where the inherited menu will be placed. For example:</p>
<div class="source"><pre class="prettyprint linenums"><project>
...
<body>
@@ -156,8 +162,7 @@ Lukas Theussl" />
</body>
...
</project>
-</pre></div></div>
-<div class="section">
+</pre></div></section><section>
<h3><a name="Aggregate_Reports"></a>Aggregate Reports</h3>
<p>Some reports can be run against the sum of every modules: these are aggregate reports. This is the case of maven-javadoc-plugin, maven-jxr-plugin or maven-checkstyle-plugin.</p>
<p>To benefit from aggregate reports, you must configure a reportSet in the parent pom, and turn inheritance off to avoid the aggregate report to be run in modules. For example, with maven-jxr-report:</p>
@@ -183,19 +188,24 @@ Lukas Theussl" />
</reporting>
...
</project>
-</pre></div></div></div>
- </div>
+</pre></div></section></section>
+ </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