You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2012/05/08 14:09:45 UTC
svn commit: r816568 [16/49] - in
/websites/production/maventest/content/plugins/maven-site-plugin-latest: ./
apidocs/ apidocs/org/apache/maven/plugins/site/
apidocs/org/apache/maven/plugins/site/class-use/
apidocs/org/apache/maven/plugins/site/wagon/ a...
Added: websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/multimodule.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/multimodule.html (added)
+++ websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/multimodule.html Tue May 8 12:09:38 2012
@@ -0,0 +1,205 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!-- Generated by Apache Maven Doxia at Jul 30, 2011 -->
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Multi-module Sites</title>
+ <style type="text/css" media="all">
+ @import url("../css/maven-base.css");
+ @import url("../css/maven-theme.css");
+ @import url("../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
+ <meta name="author" content="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="20110730" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+
+<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
+
+<script type="text/javascript">_uacct = "UA-140879-1";
+ urchinTracker();</script>
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../../../" id="bannerLeft">
+ <img src="../../../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <span id="bannerRight">
+ <img src="../../../images/maven-logo-2.gif" alt="" />
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../../index.html">Maven</a>
+ >
+ <a href="../../index.html">Plugins</a>
+ >
+ <a href="../">Maven Site Plugin 3</a>
+ >
+ Multi-module Sites
+ </div>
+ <div class="xright">
+ Last Published: 2011-07-30
+ | Version: 3.0
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+ <h5>Overview</h5>
+ <ul>
+ <li class="none">
+ <a href="../index.html">Introduction</a>
+ </li>
+ <li class="none">
+ <a href="../plugin-info.html">Goals</a>
+ </li>
+ <li class="none">
+ <a href="../usage.html">Usage</a>
+ </li>
+ <li class="none">
+ <a href="../faq.html">FAQ</a>
+ </li>
+ <li class="none">
+ <a href="../migrate.html">Migrate</a>
+ </li>
+ <li class="none">
+ <a href="../maven-3.html">Maven 3</a>
+ </li>
+ </ul>
+ <h5>Configuration</h5>
+ <ul>
+ <li class="none">
+ <a href="../i18n.html">Internationalization</a>
+ </li>
+ </ul>
+ <h5>Examples</h5>
+ <ul>
+ <li class="none">
+ <a href="../examples/creating-content.html">Creating Content</a>
+ </li>
+ <li class="none">
+ <a href="../examples/sitedescriptor.html">Configuring the Site Descriptor</a>
+ </li>
+ <li class="none">
+ <strong>Building a multi-module site</strong>
+ </li>
+ <li class="none">
+ <a href="../examples/configuring-reports.html">Configuring Reports</a>
+ </li>
+ <li class="none">
+ <a href="../examples/siterun.html">Configuring Site Run</a>
+ </li>
+ <li class="none">
+ <a href="../examples/adding-deploy-protocol.html">Adding a Protocol to Deploy the Site</a>
+ </li>
+ <li class="none">
+ <a href="../examples/templatefile.html">Changing the Template File</a>
+ </li>
+ <li class="none">
+ <a href="../examples/creatingskins.html">Creating Skins</a>
+ </li>
+ <li class="none">
+ <a href="../examples/moduleexcludes.html">Excluding Document Formats</a>
+ </li>
+ <li class="none">
+ <a href="../examples/site-deploy-to-sourceforge.net.html">Deploying to sourceforge.net</a>
+ </li>
+ </ul>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../project-info.html">Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="../project-reports.html">Project Reports</a>
+ </li>
+ </ul>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../../../doxia/index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../../../index.html">Maven 2</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../../wagon/index.html">Wagon</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../images/logos/maven-feather.png"/>
+ </a>
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements. See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership. The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied. See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/referen
ces/apt-format.html --><div class="section"><h2>Building multi-module sites<a name="Building_multi-module_sites"></a></h2><p>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"><h3>Staging and deploying<a name="Staging_and_deploying"></a></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 build the whole site and 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> e
lement of the pom as deployment location. This is usually a remote url, but both <tt>scp</tt> and <tt>file</tt> protocols 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><b>Note:</b> If subprojects inherit the 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. 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 Si
te Plugin use the <url> element in the POM?</a></tt>.</p></div><div class="section"><h3>Inheritance<a name="Inheritance"></a></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>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 adde
d 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><div class="source"><pre><project>
+ ...
+ <body>
+ ...
+ <menu name="My Inherited Menu" inherit="top">
+ ...
+ </menu>
+ ...
+ </body>
+ ...
+</project>
+</pre></div></div></div>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">
+ © 2002-2011
+ The Apache Software Foundation
+
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
\ No newline at end of file
Propchange: websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/multimodule.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/multimodule.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Modified: websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/site-deploy-to-sourceforge.net.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/site-deploy-to-sourceforge.net.html (original)
+++ websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/site-deploy-to-sourceforge.net.html Tue May 8 12:09:38 2012
@@ -1,80 +1,52 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-
-
-
-
-
-
-
-
-
-
+<!-- Generated by Apache Maven Doxia at Jul 30, 2011 -->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
- <title>Maven Site Plugin - Deploying to sourceforge.net</title>
+ <title>Deploying to sourceforge.net</title>
<style type="text/css" media="all">
@import url("../css/maven-base.css");
@import url("../css/maven-theme.css");
@import url("../css/site.css");
</style>
<link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
- <meta name="author" content="Barrie Treloar" />
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta name="author" content="Barrie Treloar" />
+ <meta name="Date-Creation-yyyymmdd" content="20090308" />
+ <meta name="Date-Revision-yyyymmdd" content="20110730" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
<script type="text/javascript">_uacct = "UA-140879-1";
urchinTracker();</script>
</head>
<body class="composite">
<div id="banner">
- <a href="../../" id="bannerLeft">
-
- <img src="../../../images/apache-maven-project-2.png" alt="" />
-
- </a>
- <span id="bannerRight">
-
- <img src="../../../images/maven-logo-2.gif" alt="" />
-
- </span>
+ <a href="../../../" id="bannerLeft">
+ <img src="../../../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <span id="bannerRight">
+ <img src="../../../images/maven-logo-2.gif" alt="" />
+ </span>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
-
-
-
-
-
-
-
-
- <div class="xleft">
-
- <a href="http://www.apache.org/" class="externalLink">Apache</a>
- >
-
- <a href="../../../index.html">Maven</a>
- >
-
- <a href="../../index.html">Plugins</a>
- >
-
- <a href="http://maven.apache.org/plugins/maven-site-plugin-3.0-beta-3" class="externalLink">Maven Site Plugin</a>
- </div>
- <div class="xright">
-
-
-
-
-
-
- Last Published: 2010-10-18
- | Version: 3.0-beta-3
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../../index.html">Maven</a>
+ >
+ <a href="../../index.html">Plugins</a>
+ >
+ <a href="../">Maven Site Plugin 3</a>
+ >
+ Deploying to sourceforge.net
+ </div>
+ <div class="xright">
+ Last Published: 2011-07-30
+ | Version: 3.0
</div>
<div class="clear">
<hr/>
@@ -82,214 +54,130 @@
</div>
<div id="leftColumn">
<div id="navcolumn">
-
-
-
-
-
-
-
-
- <h5>Overview</h5>
- <ul>
-
- <li class="none">
- <a href="../index.html">Introduction</a>
- </li>
-
- <li class="none">
- <a href="../plugin-info.html">Goals</a>
- </li>
-
- <li class="none">
- <a href="../usage.html">Usage</a>
- </li>
-
- <li class="none">
- <a href="../faq.html">FAQ</a>
- </li>
-
- <li class="none">
- <a href="../migrate.html">Migrate</a>
- </li>
-
- <li class="none">
- <a href="../maven-3.html">Maven 3</a>
- </li>
+
+ <h5>Overview</h5>
+ <ul>
+ <li class="none">
+ <a href="../index.html">Introduction</a>
+ </li>
+ <li class="none">
+ <a href="../plugin-info.html">Goals</a>
+ </li>
+ <li class="none">
+ <a href="../usage.html">Usage</a>
+ </li>
+ <li class="none">
+ <a href="../faq.html">FAQ</a>
+ </li>
+ <li class="none">
+ <a href="../migrate.html">Migrate</a>
+ </li>
+ <li class="none">
+ <a href="../maven-3.html">Maven 3</a>
+ </li>
</ul>
- <h5>Configuration</h5>
- <ul>
-
- <li class="none">
- <a href="../i18n.html">Internationalization</a>
- </li>
+ <h5>Configuration</h5>
+ <ul>
+ <li class="none">
+ <a href="../i18n.html">Internationalization</a>
+ </li>
</ul>
- <h5>Examples</h5>
- <ul>
-
- <li class="none">
- <a href="../examples/creating-content.html">Creating Content</a>
- </li>
-
- <li class="none">
- <a href="../examples/sitedescriptor.html">Configuring the Site Descriptor</a>
- </li>
-
- <li class="none">
- <a href="../examples/configuring-reports.html">Configuring Reports</a>
- </li>
-
- <li class="none">
- <a href="../examples/siterun.html">Configuring Site Run</a>
+ <h5>Examples</h5>
+ <ul>
+ <li class="none">
+ <a href="../examples/creating-content.html">Creating Content</a>
+ </li>
+ <li class="none">
+ <a href="../examples/sitedescriptor.html">Configuring the Site Descriptor</a>
+ </li>
+ <li class="none">
+ <a href="../examples/multimodule.html">Building a multi-module site</a>
+ </li>
+ <li class="none">
+ <a href="../examples/configuring-reports.html">Configuring Reports</a>
+ </li>
+ <li class="none">
+ <a href="../examples/siterun.html">Configuring Site Run</a>
+ </li>
+ <li class="none">
+ <a href="../examples/adding-deploy-protocol.html">Adding a Protocol to Deploy the Site</a>
+ </li>
+ <li class="none">
+ <a href="../examples/templatefile.html">Changing the Template File</a>
+ </li>
+ <li class="none">
+ <a href="../examples/creatingskins.html">Creating Skins</a>
+ </li>
+ <li class="none">
+ <a href="../examples/moduleexcludes.html">Excluding Document Formats</a>
+ </li>
+ <li class="none">
+ <strong>Deploying to sourceforge.net</strong>
</li>
-
- <li class="none">
- <a href="../examples/templatefile.html">Changing the Template File</a>
- </li>
-
- <li class="none">
- <a href="../examples/creatingskins.html">Creating Skins</a>
- </li>
-
- <li class="none">
- <a href="../examples/moduleexcludes.html">Excluding Document Formats</a>
- </li>
-
- <li class="none">
- <strong>Deploying to sourceforge.net</strong>
- </li>
</ul>
- <h5>Project Documentation</h5>
- <ul>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="collapsed">
- <a href="../project-info.html">Project Information</a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="collapsed">
- <a href="../project-reports.html">Project Reports</a>
- </li>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../project-info.html">Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="../project-reports.html">Project Reports</a>
+ </li>
</ul>
- <h5>Maven Projects</h5>
- <ul>
-
- <li class="none">
- <a href="../../../ant-tasks/index.html">Ant Tasks</a>
- </li>
-
- <li class="none">
- <a href="../../../doxia/index.html">Doxia</a>
- </li>
-
- <li class="none">
- <a href="../../../jxr/index.html">JXR</a>
- </li>
-
- <li class="none">
- <a href="../../../maven-1.x/index.html">Maven 1.x</a>
- </li>
-
- <li class="none">
- <a href="../../../index.html">Maven 2</a>
- </li>
-
- <li class="none">
- <a href="../../../mercury/index.html">Mercury</a>
- </li>
-
- <li class="none">
- <a href="../../index.html">Plugins</a>
- </li>
-
- <li class="none">
- <a href="../../../scm/index.html">SCM</a>
- </li>
-
- <li class="none">
- <a href="../../../shared/index.html">Shared Components</a>
- </li>
-
- <li class="none">
- <a href="../../../surefire/index.html">Surefire</a>
- </li>
-
- <li class="none">
- <a href="../../../wagon/index.html">Wagon</a>
- </li>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../../../doxia/index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../../../index.html">Maven 2</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../../wagon/index.html">Wagon</a>
+ </li>
</ul>
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img alt="Built by Maven" src="../images/logos/maven-feather.png"></img>
- </a>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../images/logos/maven-feather.png"/>
+ </a>
-
-
-
-
-
-
-
- </div>
+ </div>
</div>
<div id="bodyColumn">
<div id="contentBox">
- <div class="section"><h2>Deploying to sourceforge.net<a name="Deploying_to_sourceforge.net"></a></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"><h3>Quick Start<a name="Quick_Start"></a></h3><ul><li>Create a shell on <tt>shell.sourceforge.net</tt> with your username and project grou
p<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<div><pre> ...
+ <div class="section"><h2>Deploying to sourceforge.net<a name="Deploying_to_sourceforge.net"></a></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"><h3>Quick Start<a name="Quick_Start"></a></h3><ul><li>Create a shell on <tt>shell.sourceforge.net</tt> with your username and project grou
p<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<div><pre> ...
<distributionManagement>
...
<site>
<id>your_project.sf.net</id>
- <url>scp://shell.sourceforge.net/home/groups/y/yo/your_project/htdocs</url>
+ <url>scp://shell.sourceforge.net/home/project-web/your_project/htdocs</url>
</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"><h3>Detailed Instructions with Examples<a name="Detailed_Instructions_with_Examples"></a></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>Create a shell on <tt>shell.sourceforge.net</tt> with your username and project group<a name="Create_a_shell_on_shell.sourceforge.net_with_your_username_and_project_group"></a></h4><div class="source"><pre>$ ssh -t barrie,qifcon@shell.sf.net create
+ </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"><h3>Detailed Instructions with Examples<a name="Detailed_Instructions_with_Examples"></a></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>Create a shell on <tt>shell.sourceforge.net</tt> with your username and project group<a name="Create_a_shell_on_shell.sourceforge.net_with_your_username_and_project_group"></a></h4><div class="source"><pre>$ ssh -t barrie,qifcon@shell.sf.net create
barrie,qifcon@shell.sf.net's password:
Requesting a new shell for "barrie" and waiting for it to start.
@@ -300,15 +188,17 @@ Use the "timeleft" command to
Use the "shutdown" command to destroy the shell before the time limit.
For path information and login help, type "sf-help".
--bash-3.2$</pre></div></div><div class="section"><h4>Use <tt>shell.sourceforge.net</tt> (instead of <tt>web.sourceforge.net</tt>) in you site URL<a name="Use_shell.sourceforge.net_instead_of_web.sourceforge.net_in_you_site_URL"></a></h4><p>In the project's <tt>pom.xml</tt>:</p><div class="source"><pre> ...
+-bash-3.2$
+</pre></div></div><div class="section"><h4>Use <tt>shell.sourceforge.net</tt> (instead of <tt>web.sourceforge.net</tt>) in you site URL<a name="Use_shell.sourceforge.net_instead_of_web.sourceforge.net_in_you_site_URL"></a></h4><p>In the project's <tt>pom.xml</tt>:</p><div class="source"><pre> ...
<distributionManagement>
...
<site>
<id>qifcon.sf.net</id>
- <url>scp://shell.sourceforge.net/home/groups/q/qi/qifcon/htdocs</url>
+ <url>scp://shell.sourceforge.net/home/project-web/qifcon/htdocs</url>
</site>
</distributionManagement>
- ...</pre></div></div><div class="section"><h4>Run <tt>mvn site:deploy</tt><a name="Run_mvn_site:deploy"></a></h4><div class="source"><pre>C:\ide\Finance\qifcon\site>mvn site:deploy
+ ...
+</pre></div></div><div class="section"><h4>Run <tt>mvn site:deploy</tt><a name="Run_mvn_site:deploy"></a></h4><div class="source"><pre>C:\ide\Finance\qifcon\site>mvn site:deploy
[INFO] Scanning for projects...
[INFO] Searching repository for plugin with prefix: 'site'.
[INFO] ------------------------------------------------------------------------
@@ -335,7 +225,8 @@ scp://shell.sourceforge.net/home/groups/
[INFO] Total time: 30 seconds
[INFO] Finished at: Sat Nov 08 08:09:40 CST 2008
[INFO] Final Memory: 6M/11M
-[INFO] ------------------------------------------------------------------------</pre></div></div><div class="section"><h4>Verify you have a working web site<a name="Verify_you_have_a_working_web_site"></a></h4><p>Open a browser to <tt>http://qifcon.sf.net</tt>.</p></div></div><div class="section"><h3>Troubleshooting<a name="Troubleshooting"></a></h3><div class="section"><h4>Trying to deploy to <tt>web.sourceforge.net</tt><a name="Trying_to_deploy_to_web.sourceforge.net"></a></h4><p>The accepted methods for deploying to <tt>web.sourceforge.net</tt> 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>An example of this error:</p><div class="source"><pre>C:\ide\Finance\qifcon\site>mvn site:deploy
+[INFO] ------------------------------------------------------------------------
+</pre></div></div><div class="section"><h4>Verify you have a working web site<a name="Verify_you_have_a_working_web_site"></a></h4><p>Open a browser to <tt>http://qifcon.sf.net</tt>.</p></div></div><div class="section"><h3>Troubleshooting<a name="Troubleshooting"></a></h3><div class="section"><h4>Trying to deploy to <tt>web.sourceforge.net</tt><a name="Trying_to_deploy_to_web.sourceforge.net"></a></h4><p>The accepted methods for deploying to <tt>web.sourceforge.net</tt> 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>An example of this error:</p><div class=
"source"><pre>C:\ide\Finance\qifcon\site>mvn site:deploy
[INFO] Scanning for projects...
[INFO] Searching repository for plugin with prefix: 'site'.
[INFO] ------------------------------------------------------------------------
@@ -362,7 +253,8 @@ Embedded error: SCP terminated with erro
[INFO] Total time: 15 seconds
[INFO] Finished at: Sat Nov 08 07:27:34 CST 2008
[INFO] Final Memory: 6M/11M
-[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><div class="source"><pre>C:\ide\Finance\qifcon\site>mvn site:deploy
+[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><div class="source"><pre>C:\ide\Finance\qifcon\site>mvn site:deploy
[INFO] Scanning for projects...
[INFO] Searching repository for plugin with prefix: 'site'.
[INFO] ------------------------------------------------------------------------
@@ -389,7 +281,8 @@ scp://web.sourceforge.net/home/groups/q/
[INFO] Total time: 18 seconds
[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"><h4>No shell created error<a name="No_shell_created_error"></a></h4><p>If you try to run <tt>ssh</tt> without first creating a shell you will get the following error:</p><div class="source"><pre>$ ssh barrie,qifcon@shell.sf.net
+[INFO] ------------------------------------------------------------------------
+</pre></div></li></ol></div><div class="section"><h4>No shell created error<a name="No_shell_created_error"></a></h4><p>If you try to run <tt>ssh</tt> without first creating a shell you will get the following error:</p><div class="source"><pre>$ ssh barrie,qifcon@shell.sf.net
barrie,qifcon@shell.sf.net's password:
Logging in to your interactive shell...
@@ -404,26 +297,21 @@ 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>
+Connection to shell.sf.net closed.
+</pre></div></div></div></div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
- <div class="xright">©
- 2002-2010
-
- The Apache Software Foundation
-
-
-
-
-
+ <div class="xright">
+ © 2002-2011
+ The Apache Software Foundation
-
-
- - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
<div class="clear">
<hr/>
</div>
Modified: websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/sitedescriptor.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/sitedescriptor.html (original)
+++ websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/sitedescriptor.html Tue May 8 12:09:38 2012
@@ -1,83 +1,55 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-
-
-
-
-
-
-
-
-
-
+<!-- Generated by Apache Maven Doxia at Jul 30, 2011 -->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
- <title>Maven Site Plugin - Configuring the Site Descriptor</title>
+ <title>Configuring the Site Descriptor</title>
<style type="text/css" media="all">
@import url("../css/maven-base.css");
@import url("../css/maven-theme.css");
@import url("../css/site.css");
</style>
<link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
- <meta name="author" content="Vincent Siveton
+ <meta name="author" content="Vincent Siveton
vincent.siveton@gmail.com
Maria Odea Ching
Dennis Lundberg" />
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta name="Date-Creation-yyyymmdd" content="20100812" />
+ <meta name="Date-Revision-yyyymmdd" content="20110730" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
<script type="text/javascript">_uacct = "UA-140879-1";
urchinTracker();</script>
</head>
<body class="composite">
<div id="banner">
- <a href="../../" id="bannerLeft">
-
- <img src="../../../images/apache-maven-project-2.png" alt="" />
-
- </a>
- <span id="bannerRight">
-
- <img src="../../../images/maven-logo-2.gif" alt="" />
-
- </span>
+ <a href="../../../" id="bannerLeft">
+ <img src="../../../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <span id="bannerRight">
+ <img src="../../../images/maven-logo-2.gif" alt="" />
+ </span>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
-
-
-
-
-
-
-
- <div class="xleft">
-
- <a href="http://www.apache.org/" class="externalLink">Apache</a>
- >
-
- <a href="../../../index.html">Maven</a>
- >
-
- <a href="../../index.html">Plugins</a>
- >
-
- <a href="http://maven.apache.org/plugins/maven-site-plugin-3.0-beta-3" class="externalLink">Maven Site Plugin</a>
- </div>
- <div class="xright">
-
-
-
-
-
-
-
- Last Published: 2010-10-18
- | Version: 3.0-beta-3
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../../index.html">Maven</a>
+ >
+ <a href="../../index.html">Plugins</a>
+ >
+ <a href="../">Maven Site Plugin 3</a>
+ >
+ Configuring the Site Descriptor
+ </div>
+ <div class="xright">
+ Last Published: 2011-07-30
+ | Version: 3.0
</div>
<div class="clear">
<hr/>
@@ -85,242 +57,152 @@ Dennis Lundberg" />
</div>
<div id="leftColumn">
<div id="navcolumn">
-
-
-
-
-
-
-
-
- <h5>Overview</h5>
- <ul>
-
- <li class="none">
- <a href="../index.html">Introduction</a>
- </li>
-
- <li class="none">
- <a href="../plugin-info.html">Goals</a>
- </li>
-
- <li class="none">
- <a href="../usage.html">Usage</a>
- </li>
-
- <li class="none">
- <a href="../faq.html">FAQ</a>
- </li>
-
- <li class="none">
- <a href="../migrate.html">Migrate</a>
- </li>
-
- <li class="none">
- <a href="../maven-3.html">Maven 3</a>
- </li>
+
+ <h5>Overview</h5>
+ <ul>
+ <li class="none">
+ <a href="../index.html">Introduction</a>
+ </li>
+ <li class="none">
+ <a href="../plugin-info.html">Goals</a>
+ </li>
+ <li class="none">
+ <a href="../usage.html">Usage</a>
+ </li>
+ <li class="none">
+ <a href="../faq.html">FAQ</a>
+ </li>
+ <li class="none">
+ <a href="../migrate.html">Migrate</a>
+ </li>
+ <li class="none">
+ <a href="../maven-3.html">Maven 3</a>
+ </li>
</ul>
- <h5>Configuration</h5>
- <ul>
-
- <li class="none">
- <a href="../i18n.html">Internationalization</a>
- </li>
+ <h5>Configuration</h5>
+ <ul>
+ <li class="none">
+ <a href="../i18n.html">Internationalization</a>
+ </li>
</ul>
- <h5>Examples</h5>
- <ul>
-
- <li class="none">
- <a href="../examples/creating-content.html">Creating Content</a>
- </li>
-
- <li class="none">
- <strong>Configuring the Site Descriptor</strong>
- </li>
-
- <li class="none">
- <a href="../examples/configuring-reports.html">Configuring Reports</a>
- </li>
-
- <li class="none">
- <a href="../examples/siterun.html">Configuring Site Run</a>
- </li>
-
- <li class="none">
- <a href="../examples/templatefile.html">Changing the Template File</a>
- </li>
-
- <li class="none">
- <a href="../examples/creatingskins.html">Creating Skins</a>
- </li>
-
- <li class="none">
- <a href="../examples/moduleexcludes.html">Excluding Document Formats</a>
- </li>
-
- <li class="none">
- <a href="../examples/site-deploy-to-sourceforge.net.html">Deploying to sourceforge.net</a>
- </li>
+ <h5>Examples</h5>
+ <ul>
+ <li class="none">
+ <a href="../examples/creating-content.html">Creating Content</a>
+ </li>
+ <li class="none">
+ <strong>Configuring the Site Descriptor</strong>
+ </li>
+ <li class="none">
+ <a href="../examples/multimodule.html">Building a multi-module site</a>
+ </li>
+ <li class="none">
+ <a href="../examples/configuring-reports.html">Configuring Reports</a>
+ </li>
+ <li class="none">
+ <a href="../examples/siterun.html">Configuring Site Run</a>
+ </li>
+ <li class="none">
+ <a href="../examples/adding-deploy-protocol.html">Adding a Protocol to Deploy the Site</a>
+ </li>
+ <li class="none">
+ <a href="../examples/templatefile.html">Changing the Template File</a>
+ </li>
+ <li class="none">
+ <a href="../examples/creatingskins.html">Creating Skins</a>
+ </li>
+ <li class="none">
+ <a href="../examples/moduleexcludes.html">Excluding Document Formats</a>
+ </li>
+ <li class="none">
+ <a href="../examples/site-deploy-to-sourceforge.net.html">Deploying to sourceforge.net</a>
+ </li>
</ul>
- <h5>Project Documentation</h5>
- <ul>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="collapsed">
- <a href="../project-info.html">Project Information</a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="collapsed">
- <a href="../project-reports.html">Project Reports</a>
- </li>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../project-info.html">Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="../project-reports.html">Project Reports</a>
+ </li>
</ul>
- <h5>Maven Projects</h5>
- <ul>
-
- <li class="none">
- <a href="../../../ant-tasks/index.html">Ant Tasks</a>
- </li>
-
- <li class="none">
- <a href="../../../doxia/index.html">Doxia</a>
- </li>
-
- <li class="none">
- <a href="../../../jxr/index.html">JXR</a>
- </li>
-
- <li class="none">
- <a href="../../../maven-1.x/index.html">Maven 1.x</a>
- </li>
-
- <li class="none">
- <a href="../../../index.html">Maven 2</a>
- </li>
-
- <li class="none">
- <a href="../../../mercury/index.html">Mercury</a>
- </li>
-
- <li class="none">
- <a href="../../index.html">Plugins</a>
- </li>
-
- <li class="none">
- <a href="../../../scm/index.html">SCM</a>
- </li>
-
- <li class="none">
- <a href="../../../shared/index.html">Shared Components</a>
- </li>
-
- <li class="none">
- <a href="../../../surefire/index.html">Surefire</a>
- </li>
-
- <li class="none">
- <a href="../../../wagon/index.html">Wagon</a>
- </li>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../../../doxia/index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../../../index.html">Maven 2</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../../wagon/index.html">Wagon</a>
+ </li>
</ul>
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img alt="Built by Maven" src="../images/logos/maven-feather.png"></img>
- </a>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../images/logos/maven-feather.png"/>
+ </a>
-
-
-
-
-
-
-
- </div>
+ </div>
</div>
<div id="bodyColumn">
<div id="contentBox">
- <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements. See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership. The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied. See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/referen
ces/apt-format.html --><div class="section"><h2>Configuring the Site Descriptor<a name="Configuring_the_Site_Descriptor"></a></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>If you are migrating from Maven 1.x you will be interested to know that the <tt>navigation.xml</tt> file has been replaced by the site descriptor in Maven 2. The format is nearly the same, so you can probably reuse most of your old file.</p><p>There is an <a class="externalLink" href="http://maven.apache.org/doxia/doxia-sitetools-1.0.x/doxia-decoration-model/decoration.html">XML Schema Reference for the site de
scriptor</a> available.</p><p>The XML Schema for the site descriptor is published at <a class="externalLink" href="http://maven.apache.org/xsd/decoration-1.0.0.xsd">http://maven.apache.org/xsd/decoration-1.0.0.xsd</a>.</p><p>Have a look at the <a class="externalLink" href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/site/site.xml">site descriptor for Maven Site Plugin</a> for a real life example.</p><div class="section"><h3>Title<a name="Title"></a></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 confi
gure this in your <tt>site.xml</tt>, like this:</p><div class="source"><pre><project name="My Site Title">
+ <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements. See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership. The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied. See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/referen
ces/apt-format.html --><div class="section"><h2>Configuring the Site Descriptor<a name="Configuring_the_Site_Descriptor"></a></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>If you are migrating from Maven 1.x you will be interested to know that the <tt>navigation.xml</tt> file has been replaced by the site descriptor in Maven 2. The format is nearly the same, so you can probably reuse most of your old file.</p><p>There is an <a class="externalLink" href="http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/decoration.html">XML Schema Reference for the site descript
or</a> available.</p><p>The XML Schema for the site descriptor is published at <a class="externalLink" href="http://maven.apache.org/xsd/decoration-1.0.0.xsd">http://maven.apache.org/xsd/decoration-1.0.0.xsd</a>.</p><p>Have a look at the <a class="externalLink" href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/site/site.xml">site descriptor for Maven Site Plugin</a> for a real life example.</p><div class="section"><h3>Title<a name="Title"></a></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 t
his in your <tt>site.xml</tt>, like this:</p><div class="source"><pre><project name="My Site Title">
...
-</project></pre></div></div><div class="section"><h3>Publish Date<a name="Publish_Date"></a></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><div class="source"><pre><project>
+</project>
+</pre></div></div><div class="section"><h3>Publish Date<a name="Publish_Date"></a></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><div class="source"><pre><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><div class="source"><pre><project>
+</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><div class="source"><pre><project>
...
<publishDate position="none"/>
...
-</project></pre></div><p>The format of the "Last Published" date is the ISO 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.</p></div><div class="section"><h3>Version<a name="Version"></a></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><div class="source"><pre><project>
+</project>
+</pre></div><p>The format of the "Last Published" date is the ISO 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.</p></div><div class="section"><h3>Version<a name="Version"></a></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><div class="source"><pre><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><div class="source"><pre><project>
+</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><div class="source"><pre><project>
...
<version position="none"/>
...
-</project></pre></div></div><div class="section"><h3>"Powered by" Logo<a name="aPowered_by_Logo"></a></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><div class="source"><pre><project>
+</project>
+</pre></div></div><div class="section"><h3>"Powered by" Logo<a name="aPowered_by_Logo"></a></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><div class="source"><pre><project>
...
<poweredBy>
<logo name="Maven" href="http://maven.apache.org/"
img="http://maven.apache.org/images/logos/maven-feather.png"/>
</poweredBy>
...
-</project></pre></div></div><div class="section"><h3>Inheritance<a name="Inheritance"></a></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>site:attach-descriptor</tt> 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, only the basic settings are inherited. From the body, <b>only</b> the links are inherited, and these accumulate to contain all the parents' site descriptor links.</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><div class="source"><pre><proj
ect>
- ...
- <body>
- ...
- <menu name="My Inherited Menu" inherit="top">
- ...
- </menu>
- ...
- </body>
- ...
-</project></pre></div></div><div class="section"><h3>Including Generated Content<a name="Including_Generated_Content"></a></h3><p>Files in the format-based directory structure can be linked to by their target HTML filename, e.g. <tt>$<a name="basedir">basedir</a>/src/site/apt/foo.apt</tt> and <tt>$<a name="basedir">basedir</a>/src/site/fml/faq.fml</tt> can be linked to via:</p><div class="source"><pre><project>
+</project>
+</pre></div></div><div class="section"><h3>Inheritance<a name="Inheritance"></a></h3><p>See <a href="./multimodule.html"> Building multi-module sites</a>.</p></div><div class="section"><h3>Including Generated Content<a name="Including_Generated_Content"></a></h3><p>Files in the format-based directory structure can be linked to by their target HTML filename, e.g. <tt>$<a name="basedir">basedir</a>/src/site/apt/foo.apt</tt> and <tt>$<a name="basedir">basedir</a>/src/site/fml/faq.fml</tt> can be linked to via:</p><div class="source"><pre><project>
...
<body>
...
@@ -329,7 +211,8 @@ Dennis Lundberg" />
...
</body>
...
-</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><div class="source"><pre><project>
+</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><div class="source"><pre><project>
...
<body>
...
@@ -337,7 +220,8 @@ Dennis Lundberg" />
...
</body>
...
-</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>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"><h3>Skinning<a name="Skinning"></a></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 artifa
ct or dependency-like element. For example, to use the <a class="externalLink" href="http://maven.apache.org/skins/maven-classic-skin/">Maven Classic Skin</a>, you would include:</p><div class="source"><pre><project>
+</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>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"><h3>Skinning<a name="Skinning"></a></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 class="externalLink" href="http://maven.apache.org/skins/maven-classic-skin/">Maven Classic Skin</a>, you would include:</p><div class="source"><pre><project>
...
<skin>
<groupId>org.apache.maven.skins</groupId>
@@ -345,26 +229,21 @@ Dennis Lundberg" />
<version>1.0</version>
</skin>
...
-</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>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 class="externalLink" href="http://maven.apache.org/skins/maven-default-skin/">Maven Default Skin</a>.</p></div><div class="section"><h3>Expressions<a name="Expressions"></a></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>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.</p></div></div>
+</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>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 class="externalLink" href="http://maven.apache.org/skins/maven-default-skin/">Maven Default Skin</a>.</p></div><div class="section"><h3>Expressions<a name="Expressions"></a></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>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}, fo
r 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.</p></div></div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
- <div class="xright">©
- 2002-2010
-
- The Apache Software Foundation
-
-
-
-
-
+ <div class="xright">
+ © 2002-2011
+ The Apache Software Foundation
-
-
- - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
<div class="clear">
<hr/>
</div>