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 [14/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/site-deploy-to-sourceforge.net.html
==============================================================================
--- maven/website/components/plugins-archives/maven-site-plugin-LATEST/examples/site-deploy-to-sourceforge.net.html (original)
+++ maven/website/components/plugins-archives/maven-site-plugin-LATEST/examples/site-deploy-to-sourceforge.net.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\site-deploy-to-sourceforge.net.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\site-deploy-to-sourceforge.net.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="Barrie Treloar" />
- <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 – Deploying to sourceforge.net</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 ">Deploying to sourceforge.net <a href="https://github.com/apache/maven-site-plugin/tree/maven-site-plugin-3.12.0/src\site\apt/examples\site-deploy-to-sourceforge.net.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 ">Deploying to sourceforge.net <a href="https://github.com/apache/maven-site-plugin/tree/maven-site-plugin-4.0.0-M1/src\site\apt/examples\site-deploy-to-sourceforge.net.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>
@@ -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><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 class="active"><a href="#"><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,45 +101,45 @@
<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="Deploying_to_sourceforge.net"></a>Deploying to sourceforge.net</h2>
-<p>This <a class="externalLink" href="http://sourceforge.net/community/forum/topic.php?id=3518&page">sf.net announcement</a> indicates that the new hostname for project web file management has changed. The new hostname for file management is: <tt>web.sourceforge.net</tt> and the new accepted methods are: SFTP, SCP, rsync over SSH. Unfortunately <tt>web.sourceforge.net</tt> also has a restricted shell environment and does not allow remote commands to be executed.</p>
-<p>In addition shell access to <tt>shell.sourceforge.net</tt> now requires the creation of a shell before it can be accessed.</p>
-<p>Both of these mean that if you attempt to deploy your site without following these steps you will get an error.</p>
-<div class="section">
+<p>This <a class="externalLink" href="http://sourceforge.net/community/forum/topic.php?id=3518&page">sf.net announcement</a> indicates that the new hostname for project web file management has changed. The new hostname for file management is: <code>web.sourceforge.net</code> and the new accepted methods are: SFTP, SCP, rsync over SSH. Unfortunately <code>web.sourceforge.net</code> also has a restricted shell environment and does not allow remote commands to be executed.</p>
+<p>In addition shell access to <code>shell.sourceforge.net</code> now requires the creation of a shell before it can be accessed.</p>
+<p>Both of these mean that if you attempt to deploy your site without following these steps you will get an error.</p><section>
<h3><a name="Quick_Start"></a>Quick Start</h3>
<ul>
-<li>Create a shell on <tt>shell.sourceforge.net</tt> with your username and project group
+<li>Create a shell on <code>shell.sourceforge.net</code> with your username and project group
<div>
<pre>ssh -t <username>,<project name>@shell.sf.net create
</pre></div></li>
-<li>Use <tt>shell.sourceforge.net</tt> (instead of <tt>web.sourceforge.net</tt>) in you site URL
+<li>Use <code>shell.sourceforge.net</code> (instead of <code>web.sourceforge.net</code>) in you site URL
<div class="source"><pre class="prettyprint linenums"> ...
<distributionManagement>
...
@@ -142,13 +149,11 @@
</site>
</distributionManagement>
</pre></div></li>
-<li>Run <tt>mvn site:deploy</tt></li>
-<li>Verify that you have a working web site by opening a browser to <tt>http://your_project.sf.net</tt></li></ul></div>
-<div class="section">
+<li>Run <code>mvn site:deploy</code></li>
+<li>Verify that you have a working web site by opening a browser to <code>http://your_project.sf.net</code></li></ul></section><section>
<h3><a name="Detailed_Instructions_with_Examples"></a>Detailed Instructions with Examples</h3>
-<p>The following examples will use the <tt>qifcon</tt> project and the user <tt>barrie</tt>. Substitute these with your own project name and user name.</p>
-<div class="section">
-<h4><a name="Create_a_shell_on_shell.sourceforge.net_with_your_username_and_project_group"></a>Create a shell on <tt>shell.sourceforge.net</tt> with your username and project group</h4>
+<p>The following examples will use the <code>qifcon</code> project and the user <code>barrie</code>. Substitute these with your own project name and user name.</p><section>
+<h4><a name="Create_a_shell_on_shell.sourceforge.net_with_your_username_and_project_group"></a>Create a shell on <code>shell.sourceforge.net</code> with your username and project group</h4>
<div>
<pre>$ ssh -t barrie,qifcon@shell.sf.net create
barrie,qifcon@shell.sf.net's password:
@@ -162,10 +167,9 @@ Use the "shutdown" command to
For path information and login help, type "sf-help".
-bash-3.2$
-</pre></div></div>
-<div class="section">
-<h4><a name="Use_shell.sourceforge.net_.28instead_of_web.sourceforge.net.29_in_you_site_URL"></a>Use <tt>shell.sourceforge.net</tt> (instead of <tt>web.sourceforge.net</tt>) in you site URL</h4>
-<p>In the project's <tt>pom.xml</tt>:</p>
+</pre></div></section><section>
+<h4><a name="Use_shell.sourceforge.net_.28instead_of_web.sourceforge.net.29_in_you_site_URL"></a>Use <code>shell.sourceforge.net</code> (instead of <code>web.sourceforge.net</code>) in you site URL</h4>
+<p>In the project's <code>pom.xml</code>:</p>
<div class="source"><pre class="prettyprint linenums"> ...
<distributionManagement>
...
@@ -175,9 +179,8 @@ For path information and login help, typ
</site>
</distributionManagement>
...
-</pre></div></div>
-<div class="section">
-<h4><a name="Run_mvn_site:deploy"></a>Run <tt>mvn site:deploy</tt></h4>
+</pre></div></section><section>
+<h4><a name="Run_mvn_site:deploy"></a>Run <code>mvn site:deploy</code></h4>
<div>
<pre>C:\ide\Finance\qifcon\site>mvn site:deploy
[INFO] Scanning for projects...
@@ -207,20 +210,17 @@ scp://shell.sourceforge.net/home/groups/
[INFO] Finished at: Sat Nov 08 08:09:40 CST 2008
[INFO] Final Memory: 6M/11M
[INFO] ------------------------------------------------------------------------
-</pre></div></div>
-<div class="section">
+</pre></div></section><section>
<h4><a name="Verify_you_have_a_working_web_site"></a>Verify you have a working web site</h4>
-<p>Open a browser to <tt>http://qifcon.sf.net</tt>.</p></div></div>
-<div class="section">
-<h3><a name="Troubleshooting"></a>Troubleshooting</h3>
-<div class="section">
-<h4><a name="Trying_to_deploy_to_web.sourceforge.net"></a>Trying to deploy to <tt>web.sourceforge.net</tt></h4>
-<p>The accepted methods for deploying to <tt>web.sourceforge.net</tt> are: SFTP, SCP, rsync over SSH.</p>
+<p>Open a browser to <code>http://qifcon.sf.net</code>.</p></section></section><section>
+<h3><a name="Troubleshooting"></a>Troubleshooting</h3><section>
+<h4><a name="Trying_to_deploy_to_web.sourceforge.net"></a>Trying to deploy to <code>web.sourceforge.net</code></h4>
+<p>The accepted methods for deploying to <code>web.sourceforge.net</code> are: SFTP, SCP, rsync over SSH.</p>
<p>This will mean that the zipped archive created by Wagon can be uploaded, but the commands that Wagon uses to create directories, unzip and chmod files will fail silently.</p>
<p>There are two types of failures:</p>
<ol style="list-style-type: decimal">
<li>No such file or directory
-<p>This will occur if you are deploying into a subdirectory that does not yet exist. The cause is that the <tt>mkdir</tt> command has failed silently.</p>
+<p>This will occur if you are deploying into a subdirectory that does not yet exist. The cause is that the <code>mkdir</code> command has failed silently.</p>
<p>An example of this error:</p>
<div>
<pre>C:\ide\Finance\qifcon\site>mvn site:deploy
@@ -253,7 +253,7 @@ Embedded error: SCP terminated with erro
[INFO] ------------------------------------------------------------------------
</pre></div></li>
<li>Unable to unzip the zip file created by Wagon
-<p>If the directory exists then the Wagon zip file can be uploaded and <tt>site:deploy</tt> will appear to succeed, but the web site will not work since the Wagon zip file can not be unzipped.</p>
+<p>If the directory exists then the Wagon zip file can be uploaded and <code>site:deploy</code> will appear to succeed, but the web site will not work since the Wagon zip file can not be unzipped.</p>
<div>
<pre>C:\ide\Finance\qifcon\site>mvn site:deploy
[INFO] Scanning for projects...
@@ -283,10 +283,9 @@ scp://web.sourceforge.net/home/groups/q/
[INFO] Finished at: Sat Nov 08 07:51:04 CST 2008
[INFO] Final Memory: 6M/11M
[INFO] ------------------------------------------------------------------------
-</pre></div></li></ol></div>
-<div class="section">
+</pre></div></li></ol></section><section>
<h4><a name="No_shell_created_error"></a>No shell created error</h4>
-<p>If you try to run <tt>ssh</tt> without first creating a shell you will get the following error:</p>
+<p>If you try to run <code>ssh</code> without first creating a shell you will get the following error:</p>
<div>
<pre>$ ssh barrie,qifcon@shell.sf.net
barrie,qifcon@shell.sf.net's password:
@@ -304,19 +303,24 @@ ready for use. An example create that e
ssh -t USER,PROJECT@shell.sourceforge.net create
Connection to shell.sf.net closed.
-</pre></div></div></div></div>
- </div>
+</pre></div></section></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/sitedescriptor.html
==============================================================================
--- maven/website/components/plugins-archives/maven-site-plugin-LATEST/examples/sitedescriptor.html (original)
+++ maven/website/components/plugins-archives/maven-site-plugin-LATEST/examples/sitedescriptor.html Wed Apr 27 21:24:50 2022
@@ -1,60 +1,67 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from src\site\apt/examples\sitedescriptor.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\sitedescriptor.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" />
- <meta name="Date-Creation-yyyymmdd" content="20110814" />
- <meta name="Date-Revision-yyyymmdd" content="20220416" />
- <meta http-equiv="Content-Language" content="en" />
+ <meta name="date" content="2011-08-14" />
<title>Apache Maven Site Plugin – Configuring the Site Descriptor</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 ">Configuring the Site Descriptor <a href="https://github.com/apache/maven-site-plugin/tree/maven-site-plugin-3.12.0/src\site\apt/examples\sitedescriptor.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 ">Configuring the Site Descriptor <a href="https://github.com/apache/maven-site-plugin/tree/maven-site-plugin-4.0.0-M1/src\site\apt/examples\sitedescriptor.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>
@@ -63,28 +70,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 class="active"><a href="#"><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>
@@ -97,35 +104,36 @@ 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="Configuring_the_Site_Descriptor"></a>Configuring the Site Descriptor</h2>
-<p>You can create your own site descriptor for your project when you want to override the navigation tree for the site. For example, aside from the generated reports you want to add additional content to your site. In order for it to be accessible in the generated site, you must configure your site descriptor. You create the site descriptor in a file called <tt>site.xml</tt> which should be located in your <tt>src/site</tt> directory.</p>
+<p>You can create your own site descriptor for your project when you want to override the navigation tree for the site. For example, aside from the generated reports you want to add additional content to your site. In order for it to be accessible in the generated site, you must configure your site descriptor. You create the site descriptor in a file called <code>site.xml</code> which should be located in your <code>src/site</code> directory.</p>
<p>There is a <a href="/doxia/doxia-sitetools/doxia-decoration-model/decoration.html">reference documentation for the site descriptor</a> available with its XML Schema.</p>
<p>Have a look at the <a class="externalLink" href="https://github.com/apache/maven-site-plugin/blob/master/src/site/site.xml">site descriptor for Maven Site Plugin</a> for a real life example.</p>
<ul>
@@ -143,16 +151,14 @@ Dennis Lundberg" />
<li><a href="#Custom_content">Custom content</a></li>
<li><a href="#Skinning">Skinning</a></li>
<li><a href="#Custom_Properties">Custom Properties</a></li>
-<li><a href="#Expressions">Expressions</a></li></ul>
-<div class="section">
+<li><a href="#Expressions">Expressions</a></li></ul><section>
<h3><a name="Title"></a>Title</h3>
-<p>The title of each generated page will be a combination of the <i>site title</i> and the title of the current page. By default the Site Plugin will use the value of the <tt><name></tt> element from your <tt>pom.xml</tt> file as the site title. The complete title for this page is "Maven Site Plugin - Configuring the Site Descriptor".</p>
-<p>If you want to use a different site title, but do not want to change the <tt><name></tt> element in your <tt>pom.xml</tt>, you can configure this in your <tt>site.xml</tt>, like this:</p>
+<p>The title of each generated page will be a combination of the <i>site title</i> and the title of the current page. By default the Site Plugin will use the value of the <code><name></code> element from your <code>pom.xml</code> file as the site title. The complete title for this page is "Maven Site Plugin - Configuring the Site Descriptor".</p>
+<p>If you want to use a different site title, but do not want to change the <code><name></code> element in your <code>pom.xml</code>, you can configure this in your <code>site.xml</code>, like this:</p>
<div class="source"><pre class="prettyprint linenums"><project name="My Site Title">
...
</project>
-</pre></div></div>
-<div class="section">
+</pre></div></section><section>
<h3><a name="Banner"></a>Banner</h3>
<p>You can include some logos on top of your site, using the following syntax:</p>
<div class="source"><pre class="prettyprint linenums"><project>
@@ -169,45 +175,42 @@ Dennis Lundberg" />
...
</project>
</pre></div>
-<p>Refer to the site descriptor <a href="/doxia/doxia-sitetools/doxia-decoration-model/decoration.html">reference</a> for a complete tag description.</p></div>
-<div class="section">
+<p>Refer to the site descriptor <a href="/doxia/doxia-sitetools/doxia-decoration-model/decoration.html">reference</a> for a complete tag description.</p></section><section>
<h3><a name="Publish_Date"></a>Publish Date</h3>
-<p>With the out-of-the-box Velocity template, the position of the "Last Published" date is configurable. By default, the position is on the left but you can change it. To do this, you can add a <tt><publishDate></tt> element to your <tt>site.xml</tt> like the following:</p>
+<p>With the out-of-the-box Velocity template, the position of the "Last Published" date is configurable. By default, the position is on the left but you can change it. To do this, you can add a <code><publishDate></code> element to your <code>site.xml</code> like the following:</p>
<div class="source"><pre class="prettyprint linenums"><project>
...
<publishDate position="right"/>
...
</project>
</pre></div>
-<p>The <tt>position</tt> attribute can have one of these values: <tt>left</tt>, <tt>right</tt>, <tt>navigation-top</tt>, <tt>navigation-bottom</tt>, <tt>bottom</tt>.</p>
-<p>If you want hide the publish date, you can use this in your <tt>site.xml</tt>:</p>
+<p>The <code>position</code> attribute can have one of these values: <code>left</code>, <code>right</code>, <code>navigation-top</code>, <code>navigation-bottom</code>, <code>bottom</code>.</p>
+<p>If you want hide the publish date, you can use this in your <code>site.xml</code>:</p>
<div class="source"><pre class="prettyprint linenums"><project>
...
<publishDate position="none"/>
...
</project>
</pre></div>
-<p>The format of the "Last Published" date is the ISO extended date format that is <a class="externalLink" href="http://www.w3.org/QA/Tips/iso-date">recommended by the W3C</a>. Because the web has an international, cross-cultural audience it is recommended to <i>not</i> change the date format. There is however a <tt>format</tt> attribute to the <tt><publishDate></tt> element that can be used if you really need a different date format.</p></div>
-<div class="section">
+<p>The format of the "Last Published" date is the ISO extended date format that is <a class="externalLink" href="http://www.w3.org/QA/Tips/iso-date">recommended by the W3C</a>. Because the web has an international, cross-cultural audience it is recommended to <i>not</i> change the date format. There is however a <code>format</code> attribute to the <code><publishDate></code> element that can be used if you really need a different date format.</p></section><section>
<h3><a name="Version"></a>Version</h3>
-<p>You can show the "Version" of your project on the site, by adding a <tt><version></tt> element to your <tt>site.xml</tt> like this:</p>
+<p>You can show the "Version" of your project on the site, by adding a <code><version></code> element to your <code>site.xml</code> like this:</p>
<div class="source"><pre class="prettyprint linenums"><project>
...
<version position="right"/>
...
</project>
</pre></div>
-<p>The <tt>position</tt> attribute can have the same values as the <tt>publishDate</tt> attribute, see above. If the <tt>position</tt> attribute is omitted, the default value is <tt>left</tt>.</p>
-<p>If you want hide the version, you can use this in your <tt>site.xml</tt>:</p>
+<p>The <code>position</code> attribute can have the same values as the <code>publishDate</code> attribute, see above. If the <code>position</code> attribute is omitted, the default value is <code>left</code>.</p>
+<p>If you want hide the version, you can use this in your <code>site.xml</code>:</p>
<div class="source"><pre class="prettyprint linenums"><project>
...
<version position="none"/>
...
</project>
-</pre></div></div>
-<div class="section">
+</pre></div></section><section>
<h3><a name="a.22Powered_by.22_Logo"></a>"Powered by" Logo</h3>
-<p>You can add your own "Powered by" logo to your site. To do this, you add a <tt><poweredBy></tt> element in your <tt>site.xml</tt> like this:</p>
+<p>You can add your own "Powered by" logo to your site. To do this, you add a <code><poweredBy></code> element in your <code>site.xml</code> like this:</p>
<div class="source"><pre class="prettyprint linenums"><project>
...
<poweredBy>
@@ -216,13 +219,11 @@ Dennis Lundberg" />
</poweredBy>
...
</project>
-</pre></div></div>
-<div class="section">
+</pre></div></section><section>
<h3><a name="Inheritance"></a>Inheritance</h3>
-<p>See <a href="./multimodule.html"> Building multi-module sites</a>.</p></div>
-<div class="section">
+<p>See <a href="./multimodule.html"> Building multi-module sites</a>.</p></section><section>
<h3><a name="Including_Generated_Content"></a>Including Generated Content</h3>
-<p>Files in the format-based directory structure can be linked to by their target HTML filename, e.g. <tt>${basedir}/src/site/apt/foo.apt</tt> and <tt>${basedir}/src/site/fml/faq.fml</tt> can be linked to via:</p>
+<p>Files in the format-based directory structure can be linked to by their target HTML filename, e.g. <code>${basedir}/src/site/apt/foo.apt</code> and <code>${basedir}/src/site/fml/faq.fml</code> can be linked to via:</p>
<div class="source"><pre class="prettyprint linenums"><project>
...
<body>
@@ -236,7 +237,7 @@ Dennis Lundberg" />
...
</project>
</pre></div>
-<p>There are also several preset menus that can be used in the site descriptor to include generated content from your project. These are linked via the <tt>ref</tt> attribute, like so:</p>
+<p>There are also several preset menus that can be used in the site descriptor to include generated content from your project. These are linked via the <code>ref</code> attribute, like so:</p>
<div class="source"><pre class="prettyprint linenums"><project>
...
<body>
@@ -247,15 +248,14 @@ Dennis Lundberg" />
...
</project>
</pre></div>
-<p><b>Note:</b> The old syntax using <tt>${reports}</tt>, <tt>${parent}</tt> and <tt>${modules}</tt> has been deprecated and you are encouraged to use the new syntax instead. The support for the old syntax will be removed in a future version of the Site Plugin.</p>
+<p><b>Note:</b> The old syntax using <code>${reports}</code>, <code>${parent}</code> and <code>${modules}</code> has been deprecated and you are encouraged to use the new syntax instead. The support for the old syntax will be removed in a future version of the Site Plugin.</p>
<p>The currently available preset menus are:</p>
<ul>
-<li><tt>reports</tt> - a menu with links to all the generated reports for your project</li>
-<li><tt>parent</tt> - a menu with a link to the parent project's site</li>
-<li><tt>modules</tt> - a menu containing the links to the sites of the submodules of this project</li></ul></div>
-<div class="section">
+<li><code>reports</code> - a menu with links to all the generated reports for your project</li>
+<li><code>parent</code> - a menu with a link to the parent project's site</li>
+<li><code>modules</code> - a menu containing the links to the sites of the submodules of this project</li></ul></section><section>
<h3><a name="Inject_xhtml_into_.3Chead.3E"></a>Inject xhtml into <head></h3>
-<p>You can inject some HTML code into the generated <tt><head></tt> element of each page by adding a head element to the body element of your project's site descriptor. The following example adds some javascript:</p>
+<p>You can inject some HTML code into the generated <code><head></code> element of each page by adding a head element to the body element of your project's site descriptor. The following example adds some javascript:</p>
<div class="source"><pre class="prettyprint linenums"><project>
...
<body>
@@ -268,10 +268,9 @@ Dennis Lundberg" />
...
</project>
</pre></div>
-<p>Notice: since Maven Site Plugin version 3.5, if XHTML content is used, it has to be escaped, for example through CDATA XML notation. Previously, XML content didn't need such escaping.</p></div>
-<div class="section">
+<p>Notice: since Maven Site Plugin version 3.5, if XHTML content is used, it has to be escaped, for example through CDATA XML notation. Previously, XML content didn't need such escaping.</p></section><section>
<h3><a name="Links"></a>Links</h3>
-<p>To add links below your site logo, just add a links element to the <tt><body></tt> element of the site descriptor. Each item in the links element will be rendered as a link in a bar directly below your project's logo.</p>
+<p>To add links below your site logo, just add a links element to the <code><body></code> element of the site descriptor. Each item in the links element will be rendered as a link in a bar directly below your project's logo.</p>
<div class="source"><pre class="prettyprint linenums"><project>
...
<body>
@@ -284,11 +283,10 @@ Dennis Lundberg" />
</body>
...
</project>
-</pre></div></div>
-<div class="section">
+</pre></div></section><section>
<h3><a name="Breadcrumbs"></a>Breadcrumbs</h3>
<p>If there exists a logical hierarchy within your site modules, you may want to generate a series of breadcrumbs to give a way to easily navigate the project tree.</p>
-<p>To configure breadcrumbs, add a <tt><breadcrumbs></tt> element to the <tt><body></tt> element in the site descriptor. Each item element will render a link, and the items in the <tt><breadcrumbs></tt> element will be rendered in order. The breadcrumb items should be listed from highest level to lowest level.</p>
+<p>To configure breadcrumbs, add a <code><breadcrumbs></code> element to the <code><body></code> element in the site descriptor. Each item element will render a link, and the items in the <code><breadcrumbs></code> element will be rendered in order. The breadcrumb items should be listed from highest level to lowest level.</p>
<div class="source"><pre class="prettyprint linenums"><project>
...
<body>
@@ -302,10 +300,9 @@ Dennis Lundberg" />
...
</project>
</pre></div>
-<p><b>Note</b> that in a multi-module build, if the parent contains a breadcrumb and the inheriting site descriptor doesn't, a breadcrumb with the current site descriptor's name will be added automatically. See the notes on <a href="./multimodule.html">building a multi-module site</a> for more details.</p></div>
-<div class="section">
+<p><b>Note</b> that in a multi-module build, if the parent contains a breadcrumb and the inheriting site descriptor doesn't, a breadcrumb with the current site descriptor's name will be added automatically. See the notes on <a href="./multimodule.html">building a multi-module site</a> for more details.</p></section><section>
<h3><a name="Custom_footer"></a>Custom footer</h3>
-<p>You can replace the auto-generated footer content by specifying a custom <tt><footer></tt> element:</p>
+<p>You can replace the auto-generated footer content by specifying a custom <code><footer></code> element:</p>
<div class="source"><pre class="prettyprint linenums"><project>
...
<body>
@@ -316,19 +313,17 @@ Dennis Lundberg" />
...
</project>
</pre></div>
-<p>Notice: since Maven Site Plugin version 3.5, if XHTML content is used, it has to be escaped, for example through CDATA XML notation. Previously, XML content didn't need such escaping.</p></div>
-<div class="section">
+<p>Notice: since Maven Site Plugin version 3.5, if XHTML content is used, it has to be escaped, for example through CDATA XML notation. Previously, XML content didn't need such escaping.</p></section><section>
<h3><a name="Custom_content"></a>Custom content</h3>
-<p>There is also a dummy <tt><custom></tt> element then can be used to specify some arbitrary content. Note that you need to write your own velocity template to make use of this element, it is ignored by the default Velocity template used by the Site Plugin.</p>
+<p>There is also a dummy <code><custom></code> element then can be used to specify some arbitrary content. Note that you need to write your own velocity template to make use of this element, it is ignored by the default Velocity template used by the Site Plugin.</p>
<div class="source"><pre class="prettyprint linenums"><project>
...
<custom>Custom content</custom>
...
</project>
-</pre></div></div>
-<div class="section">
+</pre></div></section><section>
<h3><a name="Skinning"></a>Skinning</h3>
-<p>Skins can be created to customize the look and feel of a site in a consistent way. For more information on creating a skin, see <a href="./creatingskins.html">Creating a Skin</a>. To use a specific skin in your project, you use the <tt><skin></tt> element of the site descriptor. This is a regular artifact or dependency-like element. For example, to use the <a href="/skins/maven-fluido-skin/">Maven Fluido Skin</a>, you would include:</p>
+<p>Skins can be created to customize the look and feel of a site in a consistent way. For more information on creating a skin, see <a href="./creatingskins.html">Creating a Skin</a>. To use a specific skin in your project, you use the <code><skin></code> element of the site descriptor. This is a regular artifact or dependency-like element. For example, to use the <a href="/skins/maven-fluido-skin/">Maven Fluido Skin</a>, you would include:</p>
<div class="source"><pre class="prettyprint linenums"><project>
...
<skin>
@@ -339,12 +334,11 @@ Dennis Lundberg" />
...
</project>
</pre></div>
-<p><b>Note:</b> The <tt><version></tt> element is optional and, like plugins, if omitted the latest version available will be used. It is recommended that you always specify a version so that your site is reproducible over time.</p>
+<p><b>Note:</b> The <code><version></code> element is optional and, like plugins, if omitted the latest version available will be used. It is recommended that you always specify a version so that your site is reproducible over time.</p>
<p>This skin will copy the necessary resources including CSS and if necessary use the included alternate Velocity template to render the site.</p>
-<p>If you don't specify a skin, the Site Plugin will use <a href="/skins/maven-default-skin/">Maven Default Skin</a>.</p></div>
-<div class="section">
+<p>If you don't specify a skin, the Site Plugin will use <a href="/skins/maven-default-skin/">Maven Default Skin</a>.</p></section><section>
<h3><a name="Custom_Properties"></a>Custom Properties</h3>
-<p>The authors of skins have the option to use custom properties that are unique to their skin. The users of the skin can then specify their own values for these properties in their <tt>site.xml</tt> using the <tt><custom></tt> element.</p>
+<p>The authors of skins have the option to use custom properties that are unique to their skin. The users of the skin can then specify their own values for these properties in their <code>site.xml</code> using the <code><custom></code> element.</p>
<p>One skin that uses this is the Maven Fluido Skin. There are many examples on <a href="/skins/maven-fluido-skin/">their site</a> showing what is possible to do with custom properties. Here is one example:</p>
<div class="source"><pre class="prettyprint linenums"><project>
...
@@ -356,28 +350,32 @@ Dennis Lundberg" />
</custom>
...
</project>
-</pre></div></div>
-<div class="section">
+</pre></div></section><section>
<h3><a name="Expressions"></a>Expressions</h3>
-<p>The <tt>site.xml</tt> can contain some expressions, like <tt>${project.name}</tt>. Each expression will be evaluated when the site is rendered.</p>
+<p>The <code>site.xml</code> can contain some expressions, like <code>${project.name}</code>. Each expression will be evaluated when the site is rendered.</p>
<p>Expressions can be:</p>
<ul>
-<li>${project.*}, for instance <tt>${project.organization.name}</tt> referenced in <tt> <project><organization><name> </tt></li>
-<li>${project.properties}, for instance <tt>${myProperty}</tt> referenced in <tt> <project><properties><myProperty> </tt></li>
-<li>${environmentVariable}, for instance <tt>${JAVA_HOME}</tt></li></ul>
-<p><b>Note:</b> Support for some expressions, like <tt>${project.name}</tt> is present in version 2.0-beta-5 of this plugin. Full support is available since version 2.0-beta-6. Also, there are additional restrictions on using dotted project properties in content pages. See <a href="./creating-content.html#Filtering">Filtering</a> for details on injecting properties into content pages.</p></div></div>
- </div>
+<li>${project.*}, for instance <code>${project.organization.name}</code> referenced in <code> <project><organization><name> </code></li>
+<li>${project.properties}, for instance <code>${myProperty}</code> referenced in <code> <project><properties><myProperty> </code></li>
+<li>${environmentVariable}, for instance <code>${JAVA_HOME}</code></li></ul>
+<p><b>Note:</b> Support for some expressions, like <code>${project.name}</code> is present in version 2.0-beta-5 of this plugin. Full support is available since version 2.0-beta-6. Also, there are additional restrictions on using dotted project properties in content pages. See <a href="./creating-content.html#Filtering">Filtering</a> for details on injecting properties into content pages.</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/siterun.html
==============================================================================
--- maven/website/components/plugins-archives/maven-site-plugin-LATEST/examples/siterun.html (original)
+++ maven/website/components/plugins-archives/maven-site-plugin-LATEST/examples/siterun.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\siterun.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\siterun.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 – Configuring Site Run</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 ">Configuring Site Run <a href="https://github.com/apache/maven-site-plugin/tree/maven-site-plugin-3.12.0/src\site\apt/examples\siterun.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 ">Configuring Site Run <a href="https://github.com/apache/maven-site-plugin/tree/maven-site-plugin-4.0.0-M1/src\site\apt/examples\siterun.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 class="active"><a href="#"><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,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="Configuring_Site_Run"></a>Configuring Site Run</h2>
-<p>For the <tt><a href="../run-mojo.html">site:run</a></tt> goal, you can configure which port to use to start up the site as well as the directory where the pages for the site will be rendered.</p>
+<p>For the <code><a href="../run-mojo.html">site:run</a></code> goal, you can configure which port to use to start up the site as well as the directory where the pages for the site will be rendered.</p>
<p>For example, you can have the following configuration in your POM:</p>
<div class="source"><pre class="prettyprint linenums"><project>
...
@@ -131,7 +139,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>
<port>9000</port>
<tempWebappDirectory>${basedir}/target/site/tempdir</tempWebappDirectory>
@@ -142,19 +150,24 @@
...
</project>
</pre></div>
-<p>When you execute "<tt>mvn site:run</tt>", you will see in the command line that the Jetty server is started at port 9000. To access the site, type <tt>http://localhost:9000</tt> in your browser. You will also see that the dummy web application is generated in the <tt>${basedir}/target/site/tempdir</tt> directory as specified by the <tt>tempWebappDirectory</tt> parameter.</p></div>
- </div>
+<p>When you execute "<code>mvn site:run</code>", you will see in the command line that the Jetty server is started at port 9000. To access the site, type <code>http://localhost:9000</code> in your browser. You will also see that the dummy web application is generated in the <code>${basedir}/target/site/tempdir</code> directory as specified by the <code>tempWebappDirectory</code> parameter.</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