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 13:51:15 UTC
svn commit: r816547 [13/23] - in
/websites/production/maventest/content/plugins/maven-site-plugin-latest: ./
apidocs/ apidocs/org/apache/maven/doxia/sink/
apidocs/org/apache/maven/doxia/sink/class-use/
apidocs/org/apache/maven/plugins/site/ apidocs/org...
Modified: websites/production/maventest/content/plugins/maven-site-plugin-latest/deploy-mojo.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-site-plugin-latest/deploy-mojo.html (original)
+++ websites/production/maventest/content/plugins/maven-site-plugin-latest/deploy-mojo.html Tue May 8 11:51:09 2012
@@ -52,27 +52,19 @@
<div class="xleft">
- Last Published: 2008-06-26
- | Version: 2.0-beta-7
- </div>
- <div class="xright"> <a href="http://www.apache.org/" class="externalLink">Apache</a>
- |
- <a href="http://maven.apache.org/maven-1.x" class="externalLink">Maven 1.x</a>
- |
- <a href="http://maven.apache.org/" class="externalLink">Maven 2.x</a>
- |
- <a href="http://maven.apache.org/plugins/" class="externalLink">Maven 2.x Plugins</a>
- |
- <a href="http://maven.apache.org/continuum" class="externalLink">Continuum</a>
- |
- <a href="http://maven.apache.org/scm" class="externalLink">SCM</a>
- |
- <a href="http://maven.apache.org/wagon" class="externalLink">Wagon</a>
- |
- <a href="http://maven.apache.org/jxr" class="externalLink">JXR</a>
- |
- <a href="http://maven.apache.org/doxia" class="externalLink">Doxia</a>
-
+
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven</a>
+ >
+
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ >
+
+ <a href="../../../../../people.apache.org/www/maven.apache.org/plugins/maven-site-plugin">Maven Site Plugin</a>
+ </div>
+ <div class="xright">
@@ -80,7 +72,9 @@
- </div>
+ Last Published: 2009-03-08
+ | Version: 2.0
+ </div>
<div class="clear">
<hr/>
</div>
@@ -149,7 +143,11 @@
</li>
<li class="none">
- <a href="examples/moduleexcludes.html">Excluding Modules</a>
+ <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>
@@ -174,6 +172,8 @@
+
+
<li class="collapsed">
<a href="project-info.html">Project Information</a>
@@ -209,6 +209,53 @@
<a href="project-reports.html">Project Reports</a>
</li>
</ul>
+ <h5>Maven Projects</h5>
+ <ul>
+
+ <li class="none">
+ <a href="http://maven.apache.org/ant-tasks/index.html" class="externalLink">Ant Tasks</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/doxia/index.html" class="externalLink">Doxia</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/jxr/index.html" class="externalLink">JXR</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/maven-1.x/index.html" class="externalLink">Maven 1.x</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven 2</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/mercury/index.html" class="externalLink">Mercury</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/scm/index.html" class="externalLink">SCM</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/shared/index.html" class="externalLink">Shared Components</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/surefire/index.html" class="externalLink">Surefire</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/wagon/index.html" class="externalLink">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>
@@ -224,13 +271,12 @@
</div>
<div id="bodyColumn">
<div id="contentBox">
- <div class="section"><h2><a name="site:deploy"></a>
-site:deploy</h2>
+ <div class="section"><h2><a name="site:deploy"></a>site:deploy</h2>
<p><strong>Full name</strong>:</p>
-<p>org.apache.maven.plugins:maven-site-plugin:2.0-beta-7:deploy</p>
+<p>org.apache.maven.plugins:maven-site-plugin:2.0:deploy</p>
<p><strong>Description</strong>:</p>
<div>Deploys the generated site using <code>scp</code> or
-<code>file</code> protocol to the site specified in the
+<code>file</code> protocol to the site URL specified in the
<code><distributionManagement></code> section of the POM.
<p>For <code>scp</code> protocol, the website files are packaged
@@ -242,26 +288,23 @@ destination directory.</p>
</div><p><strong>Attributes</strong>:</p>
<ul><li>Requires a Maven 2.0 project to be executed.</li>
</ul>
-<div class="section"><h3><a name="Required_Parameters"></a>
-Required Parameters</h3>
+<div class="section"><h3><a name="Required_Parameters"></a>Required Parameters</h3>
<table class="bodyTable"><tr class="a"><th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
-<tr class="b"><td><strong><a href="#inputDirectory">inputDirectory</a>
-</strong></td>
+<tr class="b"><td><strong><a href="#inputDirectory">inputDirectory</a></strong></td>
<td><code>File</code></td>
<td><code>-</code></td>
<td>Directory containing the generated project sites and report
-distributions. </td>
+distributions.<br />
+</td>
</tr>
</table>
</div>
-<div class="section"><h3><a name="Parameter_Details"></a>
-Parameter Details</h3>
-<p><strong><a name="inputDirectory">inputDirectory</a>
-:</strong></p>
+<div class="section"><h3><a name="Parameter_Details"></a>Parameter Details</h3>
+<p><strong><a name="inputDirectory">inputDirectory</a>:</strong></p>
<div>Directory containing the generated project sites and report
distributions.</div><ul><li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
@@ -277,7 +320,7 @@ distributions.</div><ul><li><strong>Type
</div>
<div id="footer">
<div class="xright">©
- 2002-2008
+ 2002-2009
The Apache Software Foundation
@@ -288,7 +331,7 @@ distributions.</div><ul><li><strong>Type
- </div>
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
<div class="clear">
<hr/>
</div>
Modified: websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/configuring-reports.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/configuring-reports.html (original)
+++ websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/configuring-reports.html Tue May 8 11:51:09 2012
@@ -53,27 +53,19 @@
<div class="xleft">
- Last Published: 2008-06-26
- | Version: 2.0-beta-7
- </div>
- <div class="xright"> <a href="http://www.apache.org/" class="externalLink">Apache</a>
- |
- <a href="http://maven.apache.org/maven-1.x" class="externalLink">Maven 1.x</a>
- |
- <a href="http://maven.apache.org/" class="externalLink">Maven 2.x</a>
- |
- <a href="http://maven.apache.org/plugins/" class="externalLink">Maven 2.x Plugins</a>
- |
- <a href="http://maven.apache.org/continuum" class="externalLink">Continuum</a>
- |
- <a href="http://maven.apache.org/scm" class="externalLink">SCM</a>
- |
- <a href="http://maven.apache.org/wagon" class="externalLink">Wagon</a>
- |
- <a href="http://maven.apache.org/jxr" class="externalLink">JXR</a>
- |
- <a href="http://maven.apache.org/doxia" class="externalLink">Doxia</a>
-
+
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven</a>
+ >
+
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ >
+
+ <a href="../../../../../../people.apache.org/www/maven.apache.org/plugins/maven-site-plugin">Maven Site Plugin</a>
+ </div>
+ <div class="xright">
@@ -81,7 +73,9 @@
- </div>
+ Last Published: 2009-03-08
+ | Version: 2.0
+ </div>
<div class="clear">
<hr/>
</div>
@@ -150,7 +144,11 @@
</li>
<li class="none">
- <a href="../examples/moduleexcludes.html">Excluding Modules</a>
+ <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>
@@ -175,6 +173,8 @@
+
+
<li class="collapsed">
<a href="../project-info.html">Project Information</a>
@@ -210,6 +210,53 @@
<a href="../project-reports.html">Project Reports</a>
</li>
</ul>
+ <h5>Maven Projects</h5>
+ <ul>
+
+ <li class="none">
+ <a href="http://maven.apache.org/ant-tasks/index.html" class="externalLink">Ant Tasks</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/doxia/index.html" class="externalLink">Doxia</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/jxr/index.html" class="externalLink">JXR</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/maven-1.x/index.html" class="externalLink">Maven 1.x</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven 2</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/mercury/index.html" class="externalLink">Mercury</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/scm/index.html" class="externalLink">SCM</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/shared/index.html" class="externalLink">Shared Components</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/surefire/index.html" class="externalLink">Surefire</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/wagon/index.html" class="externalLink">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>
@@ -227,7 +274,7 @@
<div id="contentBox">
<div class="section"><h2>Configuring Reports</h2>
<p>Maven has several reports that you can add to your web site to display the current state of the project. These reports take the form of plugins, just like those used to build the project.</p>
-<p>There are many standard reports that are available by gleaning information from the POM. Currently these are provided by default:</p>
+<p>There are many standard reports that are available by extracting information from the POM. Currently these are provided by default:</p>
<ul><li>Continous Integration</li>
<li>Dependencies</li>
<li>Issue Tracking</li>
@@ -236,10 +283,8 @@
<li>Project Team</li>
<li>Source Repository</li>
</ul>
-<p>To find out more please refer to the <a href="http://maven.apache.org/plugins/maven-project-info-reports-plugin/" class="externalLink">Project Info Reports Plugin</a>
-.</p>
-<p>To add these reports to your site, you must add the plugin to a special <tt><reporting></tt>
- element in the POM. The following example shows how to configure the standard Project Info Reports that display information from the POM in a friendly format:</p>
+<p>To find out more please see to the <a class="externalLink" href="http://maven.apache.org/plugins/maven-project-info-reports-plugin/">Project Info Reports Plugin</a>.</p>
+<p>To add these reports to your site, you must add the plugin to the <tt><reporting></tt> element in the POM. The following example shows how to configure the standard Project Info Reports that display information from the POM in a friendly format:</p>
<div class="source"><pre><project>
...
<reporting>
@@ -247,7 +292,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
- <version>2.0.1</version>
+ <version>2.1.1</version>
</plugin>
</plugins>
</reporting>
@@ -255,15 +300,9 @@
</project>
</pre>
</div>
-<p>If you have included the appropriate <tt><menu ref="reports"/></tt>
- tag in your <a href="sitedescriptor.html">site descriptor</a>
-, then when you regenerate the site those items will appear in the menu.</p>
-<p><b>Note:</b>
- Many report plugins provide a parameter called <tt>outputDirectory</tt>
- or similar to specify the destination for their report outputs. This parameter is only relevant if the report plugin is run standalone, i.e. by invocation directly from the command line. In constrast, when reports are generated as part of the site, the configuration of the Maven Site Plugin will determine the effective output directory to ensure that all reports end up in a common location.</p>
-<p>Check out the <i>reporting</i>
- section of the <a href="http://maven.apache.org/plugins/" class="externalLink">plugins page</a>
-, for a list of available reporting plugins.</p>
+<p>If you have included the appropriate <tt><menu ref="reports"/></tt> tag in your <a href="sitedescriptor.html">site descriptor</a>, then when you regenerate the site those items will appear in a menu called "Project Reports".</p>
+<p><b>Note:</b> Many report plugins provide a parameter called <tt>outputDirectory</tt> or similar to specify the destination for their report outputs. This parameter is only relevant if the report plugin is run standalone, i.e. by invocation directly from the command line. In constrast, when reports are generated as part of the site, the configuration of the Maven Site Plugin will determine the effective output directory to ensure that all reports end up in a common location.</p>
+<p>Check out the <i>reporting</i> section of the <a class="externalLink" href="http://maven.apache.org/plugins/">plugins page</a>, for a list of available reporting plugins.</p>
</div>
</div>
@@ -273,7 +312,7 @@
</div>
<div id="footer">
<div class="xright">©
- 2002-2008
+ 2002-2009
The Apache Software Foundation
@@ -284,7 +323,7 @@
- </div>
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
<div class="clear">
<hr/>
</div>
Modified: websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/creating-content.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/creating-content.html (original)
+++ websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/creating-content.html Tue May 8 11:51:09 2012
@@ -53,27 +53,19 @@
<div class="xleft">
- Last Published: 2008-06-26
- | Version: 2.0-beta-7
- </div>
- <div class="xright"> <a href="http://www.apache.org/" class="externalLink">Apache</a>
- |
- <a href="http://maven.apache.org/maven-1.x" class="externalLink">Maven 1.x</a>
- |
- <a href="http://maven.apache.org/" class="externalLink">Maven 2.x</a>
- |
- <a href="http://maven.apache.org/plugins/" class="externalLink">Maven 2.x Plugins</a>
- |
- <a href="http://maven.apache.org/continuum" class="externalLink">Continuum</a>
- |
- <a href="http://maven.apache.org/scm" class="externalLink">SCM</a>
- |
- <a href="http://maven.apache.org/wagon" class="externalLink">Wagon</a>
- |
- <a href="http://maven.apache.org/jxr" class="externalLink">JXR</a>
- |
- <a href="http://maven.apache.org/doxia" class="externalLink">Doxia</a>
-
+
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven</a>
+ >
+
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ >
+
+ <a href="../../../../../../people.apache.org/www/maven.apache.org/plugins/maven-site-plugin">Maven Site Plugin</a>
+ </div>
+ <div class="xright">
@@ -81,7 +73,9 @@
- </div>
+ Last Published: 2009-03-08
+ | Version: 2.0
+ </div>
<div class="clear">
<hr/>
</div>
@@ -150,7 +144,11 @@
</li>
<li class="none">
- <a href="../examples/moduleexcludes.html">Excluding Modules</a>
+ <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>
@@ -175,6 +173,8 @@
+
+
<li class="collapsed">
<a href="../project-info.html">Project Information</a>
@@ -210,6 +210,53 @@
<a href="../project-reports.html">Project Reports</a>
</li>
</ul>
+ <h5>Maven Projects</h5>
+ <ul>
+
+ <li class="none">
+ <a href="http://maven.apache.org/ant-tasks/index.html" class="externalLink">Ant Tasks</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/doxia/index.html" class="externalLink">Doxia</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/jxr/index.html" class="externalLink">JXR</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/maven-1.x/index.html" class="externalLink">Maven 1.x</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven 2</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/mercury/index.html" class="externalLink">Mercury</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/scm/index.html" class="externalLink">SCM</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/shared/index.html" class="externalLink">Shared Components</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/surefire/index.html" class="externalLink">Surefire</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/wagon/index.html" class="externalLink">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>
@@ -226,40 +273,44 @@
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2>Creating Content</h2>
-<p>Now it's time to create some content for your site. In Maven 2, the site content is separated by format, as there are several formats supported.</p>
+<p>Now it's time to create some content for your site. In Maven 2, the site content is structured by format, as there are several formats supported.</p>
<p>Here's an example of a directory structure for a site:</p>
<div class="source"><pre>+- src/
+- site/
+- apt/
| +- index.apt
|
- +- xdoc/
- | +- other.xml
- |
+- fml/
| +- general.fml
| +- faq.fml
|
+ +- xdoc/
+ | +- other.xml
+ |
+- site.xml
</pre>
</div>
-<p>You notice the <tt>${basedir}/src/site</tt>
- directory which contains a site descriptor along with various directories corresponding to the supported document formatss. Let's take a look at examples of the various document formats.</p>
-<p>The APT format, "Almost Plain Text", is a wiki-like format that allows you to write simple, structured documents (like this one) very quickly. A full reference of the <a href="http://maven.apache.org/doxia/references/apt-format.html" class="externalLink"> APT Format</a>
- is available.</p>
-<p>The FML format is the FAQ format. This is the same that were used in Maven 1.x. For more info about the <a href="http://maven.apache.org/doxia/references/fml-format.html" class="externalLink">FML Format</a>
- check the <a href="http://maven.apache.org/doxia/" class="externalLink">Doxia</a>
- site.</p>
-<p>The XDoc format is the same as <a href="http://maven.apache.org/maven-1.x/using/site.html" class="externalLink"> used in Maven 1.x</a>
-. A reference for the <a href="http://maven.apache.org/doxia/references/xdoc-format.html" class="externalLink"> XDoc Format</a>
- is available.</p>
+<p>You notice the <tt>${basedir}/src/site</tt> directory which contains a site descriptor along with various directories corresponding to the supported document formats. Let's take a look at examples of the various document formats.</p>
+<p>The APT format, "Almost Plain Text", is a wiki-like format that allows you to write simple, structured documents (like this one) very quickly. A full reference of the <a class="externalLink" href="http://maven.apache.org/doxia/references/apt-format.html"> APT Format</a> is available.</p>
+<p>The FML format is the FAQ format. This is the same that were used in Maven 1.x. For more info about the <a class="externalLink" href="http://maven.apache.org/doxia/references/fml-format.html">FML Format</a> check the <a class="externalLink" href="http://maven.apache.org/doxia/">Doxia</a> site.</p>
+<p>The XDoc format is the same as <a class="externalLink" href="http://maven.apache.org/maven-1.x/using/site.html"> used in Maven 1.x</a>. A reference for the <a class="externalLink" href="http://maven.apache.org/doxia/references/xdoc-format.html"> XDoc Format</a> is available.</p>
<p>Other formats are available, but at this point these 3 are the best tested. There are also several possible output formats, but currently only XHTML is available.</p>
-<p>Note that all of the above is optional - just one index file is required in one of the input trees. The paths under each format will be merged together to form the root directory of the site.</p>
+<p>Note that all of the above is optional - just one index file is required in one of the input trees. The paths under each format will be merged together to form the root directory of the site. After running '<tt>mvn site:site</tt>' on the example above you will end up with this in your <tt>target</tt> directory:</p>
+<div class="source"><pre>+- target/
+ +- site/
+ +- css/
+ |
+ +- images/
+ |
+ +- index.html
+ +- general.html
+ +- faq.html
+ +- other.html
+</pre>
+</div>
+<p>The <tt>css</tt> and <tt>images</tt> directories contains stylesheets and images from the skin being used. You can read more about skins in <a href="sitedescriptor.html">the site descriptor documentation</a>.</p>
<div class="section"><h3>Adding Extra Resources</h3>
-<p>You can add any arbitrary resource to your site by including them in a <tt>resources</tt>
- directory as shown below. Additional CSS files can be picked up when they are placed in the <tt>css</tt>
- directory within the <tt>resources</tt>
- directory.</p>
+<p>You can add any arbitrary resource to your site by including them in a <tt>resources</tt> directory as shown below. Additional CSS files can be picked up when they are placed in the <tt>css</tt> directory within the <tt>resources</tt> directory.</p>
<div class="source"><pre>+- src/
+- site/
+- resources/
@@ -270,26 +321,14 @@
+- pic1.jpg
</pre>
</div>
-<p>The file <tt>site.css</tt>
- will be added to the default XHTML output, so it can be used to adjust the default Maven stylesheets if desired.</p>
-<p>The file <tt>pic1.jpg</tt>
- will be available via a relative reference to the <tt>images</tt>
- directory from any page in your site.</p>
+<p>The file <tt>site.css</tt> will be added to the default XHTML output, so it can be used to adjust the default Maven stylesheets if desired.</p>
+<p>The file <tt>pic1.jpg</tt> will be available via a relative reference to the <tt>images</tt> directory from any page in your site.</p>
</div>
<div class="section"><h3>Filtering</h3>
-<p><b>Note:</b>
- This feature is available in version 2.0-beta-6 or later of the Site Plugin.</p>
-<p>To filter properties into any supported documentation format, add a <tt>.vm</tt>
- extension to the filename.</p>
-<p>For example, the module for the Maven website contains a <a href="http://svn.apache.org/repos/asf/maven/site/trunk/src/site/apt/download.apt.vm" class="externalLink"><tt>src/site/apt/download.apt.vm</tt>
-</a>
- file, which uses the expression <tt>${currentVersion}</tt>
- to filter in a property set in the <a href="http://svn.apache.org/repos/asf/maven/site/trunk/pom.xml" class="externalLink">POM</a>
-.</p>
-<p><b>Note:</b>
- <a href="http://velocity.apache.org/" class="externalLink">Velocity</a>
- is used to apply the filtering. Because Velocity uses a dot-notation internally you can <b>not</b>
- use dots in your properties.</p>
+<p><b>Note:</b> This feature is available in version 2.0-beta-6 or later of the Site Plugin.</p>
+<p>To filter properties into any supported documentation format, add a <tt>.vm</tt> extension to the filename.</p>
+<p>For example, the module for the Maven website contains a <a class="externalLink" href="http://svn.apache.org/repos/asf/maven/site/trunk/src/site/apt/download.apt.vm"><tt>src/site/apt/download.apt.vm</tt></a> file, which uses the expression <tt>${currentVersion}</tt> to filter in a property set in the <a class="externalLink" href="http://svn.apache.org/repos/asf/maven/site/trunk/pom.xml">POM</a>.</p>
+<p><b>Note:</b> <a class="externalLink" href="http://velocity.apache.org/">Velocity</a> is used to apply the filtering. Because Velocity uses a dot-notation internally you can <b>not</b> use dots in your properties.</p>
<p>If you declare these properties in your POM</p>
<div class="source"><pre> <properties>
<!-- This will not work because the name of the property has a dot in it -->
@@ -299,14 +338,10 @@
</properties>
</pre>
</div>
-<p>and then use the expression <tt>${my.property}</tt>
- in your document, it will <b>not</b>
- work. If you instead use the expression <tt>${myProperty}</tt>
- it will work just fine.</p>
+<p>and then use the expression <tt>${my.property}</tt> in your document, it will <b>not</b> work. If you instead use the expression <tt>${myProperty}</tt> it will work just fine.</p>
</div>
<div class="section"><h3>Internationalization</h3>
-<p>Internationalization in Maven is very simple, as long as the reports you are using have that particular locale defined. For an overview of supported languages and instructions on how to add further languages, please see the related article <a href="../i18n.html"> Internationalization</a>
-.</p>
+<p>Internationalization in Maven is very simple, as long as the reports you are using have that particular locale defined. For an overview of supported languages and instructions on how to add further languages, please see the related article <a href="../i18n.html"> Internationalization</a>.</p>
<p>To enable multiple locales, or languages, add a configuration similar to the following to your POM:</p>
<div class="source"><pre><project>
...
@@ -315,7 +350,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
- <version>2.0-beta-6</version>
+ <version>2.0</version>
<configuration>
<locales>en,fr</locales>
</configuration>
@@ -326,10 +361,8 @@
</project>
</pre>
</div>
-<p>This will generate both an English and a French version of the site. If <tt>en</tt>
- is your current locale, then it will be generated at the root of the site, with a copy of the French translation of the site in the <tt>fr/</tt>
- subdirectory.</p>
-<p>To add your own content for that translation instead of using the default, place a subdirectory with that locale name in your site directory and create a new site descriptor with the locale in the file name. For example:</p>
+<p>This will generate both an English and a French version of the site. If <tt>en</tt> is your current locale, then it will be generated at the root of the site, with a copy of the French translation of the site in the <tt>fr/</tt> subdirectory.</p>
+<p>To add your own content for that translation instead of using the default, create a subdirectory with that locale's name in your site directory and create a new site descriptor with the name of the locale in the file name. For example:</p>
<div class="source"><pre>+- src/
+- site/
+- apt/
@@ -354,7 +387,7 @@
</div>
<div id="footer">
<div class="xright">©
- 2002-2008
+ 2002-2009
The Apache Software Foundation
@@ -365,7 +398,7 @@
- </div>
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
<div class="clear">
<hr/>
</div>
Modified: websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/creatingskins.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/creatingskins.html (original)
+++ websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/creatingskins.html Tue May 8 11:51:09 2012
@@ -19,7 +19,8 @@
@import url("../css/site.css");
</style>
<link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
- <meta name="author" content="Brett Porter" />
+ <meta name="author" content="Brett Porter
+Dennis Lundberg" />
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
@@ -53,27 +54,19 @@
<div class="xleft">
- Last Published: 2008-06-26
- | Version: 2.0-beta-7
- </div>
- <div class="xright"> <a href="http://www.apache.org/" class="externalLink">Apache</a>
- |
- <a href="http://maven.apache.org/maven-1.x" class="externalLink">Maven 1.x</a>
- |
- <a href="http://maven.apache.org/" class="externalLink">Maven 2.x</a>
- |
- <a href="http://maven.apache.org/plugins/" class="externalLink">Maven 2.x Plugins</a>
- |
- <a href="http://maven.apache.org/continuum" class="externalLink">Continuum</a>
- |
- <a href="http://maven.apache.org/scm" class="externalLink">SCM</a>
- |
- <a href="http://maven.apache.org/wagon" class="externalLink">Wagon</a>
- |
- <a href="http://maven.apache.org/jxr" class="externalLink">JXR</a>
- |
- <a href="http://maven.apache.org/doxia" class="externalLink">Doxia</a>
-
+
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven</a>
+ >
+
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ >
+
+ <a href="../../../../../../people.apache.org/www/maven.apache.org/plugins/maven-site-plugin">Maven Site Plugin</a>
+ </div>
+ <div class="xright">
@@ -81,7 +74,9 @@
- </div>
+ Last Published: 2009-03-08
+ | Version: 2.0
+ </div>
<div class="clear">
<hr/>
</div>
@@ -150,7 +145,11 @@
</li>
<li class="none">
- <a href="../examples/moduleexcludes.html">Excluding Modules</a>
+ <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>
@@ -175,6 +174,8 @@
+
+
<li class="collapsed">
<a href="../project-info.html">Project Information</a>
@@ -210,6 +211,53 @@
<a href="../project-reports.html">Project Reports</a>
</li>
</ul>
+ <h5>Maven Projects</h5>
+ <ul>
+
+ <li class="none">
+ <a href="http://maven.apache.org/ant-tasks/index.html" class="externalLink">Ant Tasks</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/doxia/index.html" class="externalLink">Doxia</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/jxr/index.html" class="externalLink">JXR</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/maven-1.x/index.html" class="externalLink">Maven 1.x</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven 2</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/mercury/index.html" class="externalLink">Mercury</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/scm/index.html" class="externalLink">SCM</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/shared/index.html" class="externalLink">Shared Components</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/surefire/index.html" class="externalLink">Surefire</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/wagon/index.html" class="externalLink">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>
@@ -226,39 +274,29 @@
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2>Creating Skins</h2>
-<p>If you want to tune the way your site looks, you can use a custom skin to provide your own CSS styles. If that is still not enough, you can even tweak the output templates that Maven uses to generate the site documentation.</p>
+<p>If you want to tune the way your site looks, you can use a custom skin to provide your own CSS stylesheets. If that is still not enough, you can even tweak the output templates that Maven uses to generate the site documentation.</p>
+<p>For an in-depth discussion of site customization, please have a look at <a class="externalLink" href="http://www.sonatype.com/books/maven-book/reference/site-generation.html"> Maven: The Definitive Guide, Chapter 15. Site Generation</a> provided by Sonatype.</p>
<div class="section"><h3>About</h3>
-<p>A Maven 2 site skin contains the following elements:</p>
-<ul><li>Resources to copy into each project (such as images used by the CSS).</li>
-<li>A couple of CSS files, containing the visual styling.</li>
-<li>An optional Velocity template for an alternate HTML rendering of the site.</li>
+<p>A skin contains the following elements:</p>
+<ul><li>Resources to copy into each project (such as images used by the CSS)</li>
+<li>A couple of CSS files, containing the visual styling</li>
+<li>An optional Velocity template for an alternate HTML rendering of the site</li>
</ul>
</div>
<div class="section"><h3>Building</h3>
-<p>A skin is built like any other JAR - with a <tt>packaging</tt>
- of <tt>jar</tt>
-. No additional plugins are needed.</p>
-<p>Resources should be put in the normal <tt>src/main/resources</tt>
- directory.</p>
+<p>A skin is built like any other JAR - with a <tt>packaging</tt> of <tt>jar</tt>. No additional plugins are needed.</p>
+<p>Resources should be put in the normal <tt>src/main/resources</tt> directory.</p>
<p>Once the JAR is built and deployed, it can be used by projects.</p>
</div>
<div class="section"><h3>Constructing the CSS</h3>
-<p><b>More information is needed here on constructing the CSS.</b>
-</p>
-<p>If you are interested in constructing your own CSS, it is recommended that you copy an existing skin's <tt>maven-theme.css</tt>
- file and modify it to suit your needs.</p>
+<p>If you are interested in constructing your own CSS, it is recommended that you copy the file <a class="externalLink" href="https://svn.apache.org/repos/asf/maven/skins/trunk/maven-default-skin/src/main/resources/css/maven-theme.css"><tt>maven-theme.css</tt></a> from Maven Default Skin and modify it to suit your needs.</p>
</div>
<div class="section"><h3>Customizing the HTML Output with a Velocity Template</h3>
-<p><b>Details on the Velocity template variables and use should be included</b>
-.</p>
-<p>The format of the Velocity template is currently out of scope for this document. To attempt this, start by copying <tt><a href="https://svn.apache.org/repos/asf/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/resources/org/apache/maven/doxia/siterenderer/resources/default-site.vm" class="externalLink">default-site.vm</a>
-</tt>
- to <tt>src/main/resources/META-INF/maven/site.vm</tt>
- in your project and then modify it to your needs.</p>
+<p>The format of the Velocity template is currently out of scope for this document. To attempt this, start by copying <tt><a class="externalLink" href="https://svn.apache.org/repos/asf/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/resources/org/apache/maven/doxia/siterenderer/resources/default-site.vm">default-site.vm</a></tt> to <tt>src/main/resources/META-INF/maven/site.vm</tt> in your project and then modify it to your needs.</p>
+<p>For more information about how to write Velocity templates see the <a class="externalLink" href="http://velocity.apache.org/engine/releases/velocity-1.5/user-guide.html">Velocity User Guide</a> and <a class="externalLink" href="http://velocity.apache.org/engine/releases/velocity-1.5/vtl-reference-guide.html">Velocity Template Language Reference Guide</a>.</p>
</div>
<div class="section"><h3>Examples of Existing Skins</h3>
-<p>A list of links to skins that can be used as inspiration can be found on <a href="http://docs.codehaus.org/display/MAVENUSER/Maven+Skins" class="externalLink">the wiki</a>
-.</p>
+<p>A list of links to skins that can be used as inspiration can be found on <a class="externalLink" href="http://docs.codehaus.org/display/MAVENUSER/Maven+Skins">the wiki</a>.</p>
</div>
</div>
@@ -269,7 +307,7 @@
</div>
<div id="footer">
<div class="xright">©
- 2002-2008
+ 2002-2009
The Apache Software Foundation
@@ -280,7 +318,7 @@
- </div>
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
<div class="clear">
<hr/>
</div>
Modified: websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/moduleexcludes.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/moduleexcludes.html (original)
+++ websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/moduleexcludes.html Tue May 8 11:51:09 2012
@@ -12,7 +12,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
- <title>Maven Site Plugin - Excluding Modules</title>
+ <title>Maven Site Plugin - Excluding Document Formats</title>
<style type="text/css" media="all">
@import url("../css/maven-base.css");
@import url("../css/maven-theme.css");
@@ -53,27 +53,19 @@
<div class="xleft">
- Last Published: 2008-06-26
- | Version: 2.0-beta-7
- </div>
- <div class="xright"> <a href="http://www.apache.org/" class="externalLink">Apache</a>
- |
- <a href="http://maven.apache.org/maven-1.x" class="externalLink">Maven 1.x</a>
- |
- <a href="http://maven.apache.org/" class="externalLink">Maven 2.x</a>
- |
- <a href="http://maven.apache.org/plugins/" class="externalLink">Maven 2.x Plugins</a>
- |
- <a href="http://maven.apache.org/continuum" class="externalLink">Continuum</a>
- |
- <a href="http://maven.apache.org/scm" class="externalLink">SCM</a>
- |
- <a href="http://maven.apache.org/wagon" class="externalLink">Wagon</a>
- |
- <a href="http://maven.apache.org/jxr" class="externalLink">JXR</a>
- |
- <a href="http://maven.apache.org/doxia" class="externalLink">Doxia</a>
-
+
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven</a>
+ >
+
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ >
+
+ <a href="../../../../../../people.apache.org/www/maven.apache.org/plugins/maven-site-plugin">Maven Site Plugin</a>
+ </div>
+ <div class="xright">
@@ -81,7 +73,9 @@
- </div>
+ Last Published: 2009-03-08
+ | Version: 2.0
+ </div>
<div class="clear">
<hr/>
</div>
@@ -150,8 +144,12 @@
</li>
<li class="none">
- <strong>Excluding Modules</strong>
+ <strong>Excluding Document Formats</strong>
</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>
@@ -175,6 +173,8 @@
+
+
<li class="collapsed">
<a href="../project-info.html">Project Information</a>
@@ -210,6 +210,53 @@
<a href="../project-reports.html">Project Reports</a>
</li>
</ul>
+ <h5>Maven Projects</h5>
+ <ul>
+
+ <li class="none">
+ <a href="http://maven.apache.org/ant-tasks/index.html" class="externalLink">Ant Tasks</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/doxia/index.html" class="externalLink">Doxia</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/jxr/index.html" class="externalLink">JXR</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/maven-1.x/index.html" class="externalLink">Maven 1.x</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven 2</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/mercury/index.html" class="externalLink">Mercury</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/scm/index.html" class="externalLink">SCM</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/shared/index.html" class="externalLink">Shared Components</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/surefire/index.html" class="externalLink">Surefire</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/wagon/index.html" class="externalLink">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>
@@ -225,9 +272,8 @@
</div>
<div id="bodyColumn">
<div id="contentBox">
- <div class="section"><h2>Excluding Modules</h2>
-<p>To exclude specific modules from the site to be generated, you can use the <tt>excludeModules</tt>
- parameter.</p>
+ <div class="section"><h2>Excluding Document Formats</h2>
+<p>To exclude specific document formats from the generated site, you can use the <tt>excludeModules</tt> parameter.</p>
<p>For example, you have the following site content in your POM</p>
<div class="source"><pre>Module1
|-- src
@@ -240,8 +286,7 @@
`-- pom.xml
</pre>
</div>
-<p>and you want to exclude the whole fml module from the site to be generated, you need to set the following in your POM then execute "<tt>mvn site</tt>
-".</p>
+<p>and you want to exclude all the documents in the fml format from the generated site, you need to set the following in your POM and then execute "<tt>mvn site</tt>".</p>
<div class="source"><pre><project>
...
<build>
@@ -249,6 +294,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
+ <version>2.0</version>
<configuration>
<excludeModules>fml</excludeModules>
</configuration>
@@ -259,8 +305,7 @@
</project>
</pre>
</div>
-<p>You will see that no <tt>sample-fml.html</tt>
- will be generated with the site.</p>
+<p>You will see that no <tt>sample-fml.html</tt> will be present in the generated site.</p>
</div>
</div>
@@ -270,7 +315,7 @@
</div>
<div id="footer">
<div class="xright">©
- 2002-2008
+ 2002-2009
The Apache Software Foundation
@@ -281,7 +326,7 @@
- </div>
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
<div class="clear">
<hr/>
</div>
Added: 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 (added)
+++ websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/site-deploy-to-sourceforge.net.html Tue May 8 11:51:09 2012
@@ -0,0 +1,487 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+
+
+
+
+
+
+
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Maven Site Plugin - 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=ISO-8859-1" />
+
+<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="http://maven.apache.org/" id="bannerLeft">
+
+ <img src="http://maven.apache.org/images/apache-maven-project-2.png" alt="" />
+
+ </a>
+ <a href="http://maven.apache.org/" id="bannerRight">
+
+ <img src="http://maven.apache.org/images/maven-logo-2.gif" alt="" />
+
+ </a>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+
+
+
+
+
+
+
+ <div class="xleft">
+
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven</a>
+ >
+
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ >
+
+ <a href="../../../../../../people.apache.org/www/maven.apache.org/plugins/maven-site-plugin">Maven Site Plugin</a>
+ </div>
+ <div class="xright">
+
+
+
+
+
+
+
+ Last Published: 2009-03-08
+ | Version: 2.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>
+ </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">
+ <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">
+ <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>
+ </ul>
+ <h5>Maven Projects</h5>
+ <ul>
+
+ <li class="none">
+ <a href="http://maven.apache.org/ant-tasks/index.html" class="externalLink">Ant Tasks</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/doxia/index.html" class="externalLink">Doxia</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/jxr/index.html" class="externalLink">JXR</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/maven-1.x/index.html" class="externalLink">Maven 1.x</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven 2</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/mercury/index.html" class="externalLink">Mercury</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/scm/index.html" class="externalLink">SCM</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/shared/index.html" class="externalLink">Shared Components</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/surefire/index.html" class="externalLink">Surefire</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/wagon/index.html" class="externalLink">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>
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <div class="section"><h2>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"><h3>Quick Start</h3>
+<ul><li>Create a shell on <tt>shell.sourceforge.net</tt> with your username and project group<div class="source"><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 class="source"><pre> ...
+ <distributionManagement>
+ ...
+ <site>
+ <id>your_project.sf.net</id>
+ <url>scp://shell.sourceforge.net/home/groups/y/yo/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</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</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.
+queued... creating... starting...
+
+This is an interactive shell created for user barrie,qifcon.
+Use the "timeleft" command to see how much time remains before shutdown.
+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</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>
+ </site>
+ </distributionManagement>
+ ...
+</pre>
+</div>
+</div>
+<div class="section"><h4>Run <tt>mvn site:deploy</tt></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] ------------------------------------------------------------------------
+[INFO] Building QifCon
+[INFO] task-segment: [site:deploy]
+[INFO] ------------------------------------------------------------------------
+[INFO] [site:deploy]
+Using private key: C:\Projects\putty\barrie@sourceforge-net.openssh
+scp://shell.sourceforge.net/home/groups/q/qi/qifcon/htdocs - Session: Opened
+Executing command: mkdir -p /home/groups/q/qi/qifcon/htdocs/.
+Executing command: mkdir -p /home/groups/q/qi/qifcon/htdocs/.
+Executing command: scp -t /home/groups/q/qi/qifcon/htdocs/./wagon51463.zip
+Uploading: ./wagon51463.zip to scp://shell.sourceforge.net/home/groups/q/qi/qifcon/htdocs
+
+########################
+Transfer finished. 95979 bytes copied in 1.812 seconds
+Executing command: cd /home/groups/q/qi/qifcon/htdocs/.; unzip -q -o wagon51463.zip; rm -f wagon51463.zip
+Executing command: chmod -Rf g+w,a+rX /home/groups/q/qi/qifcon/htdocs
+scp://shell.sourceforge.net/home/groups/q/qi/qifcon/htdocs - Session: Disconnecting
+scp://shell.sourceforge.net/home/groups/q/qi/qifcon/htdocs - Session: Disconnected
+[INFO] ------------------------------------------------------------------------
+[INFO] BUILD SUCCESSFUL
+[INFO] ------------------------------------------------------------------------
+[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</h4>
+<p>Open a browser to <tt>http://qifcon.sf.net</tt>.</p>
+</div>
+</div>
+<div class="section"><h3>Troubleshooting</h3>
+<div class="section"><h4>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>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 type="1"><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] ------------------------------------------------------------------------
+[INFO] Building QifCon
+[INFO] task-segment: [site:deploy]
+[INFO] ------------------------------------------------------------------------
+[INFO] [site:deploy]
+Using private key: C:\Projects\putty\barrie@sourceforge-net.openssh
+scp://web.sourceforge.net/home/groups/q/qi/qifcon/htdocs/site - Session: Opened
+Executing command: mkdir -p /home/groups/q/qi/qifcon/htdocs/site/.
+Executing command: mkdir -p /home/groups/q/qi/qifcon/htdocs/site/.
+Executing command: scp -t /home/groups/q/qi/qifcon/htdocs/site/./wagon12736.zip
+scp://web.sourceforge.net/home/groups/q/qi/qifcon/htdocs/site - Session: Disconnecting
+scp://web.sourceforge.net/home/groups/q/qi/qifcon/htdocs/site - Session: Disconnected
+[INFO] ------------------------------------------------------------------------
+[ERROR] BUILD ERROR
+[INFO] ------------------------------------------------------------------------
+[INFO] Error uploading site
+
+Embedded error: SCP terminated with error: 'scp: /home/groups/q/qi/qifcon/htdocs/site/./wagon12736.zip: No such file or directory'
+[INFO] ------------------------------------------------------------------------
+[INFO] For more information, run Maven with the -e switch
+[INFO] ------------------------------------------------------------------------
+[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] Scanning for projects...
+[INFO] Searching repository for plugin with prefix: 'site'.
+[INFO] ------------------------------------------------------------------------
+[INFO] Building QifCon
+[INFO] task-segment: [site:deploy]
+[INFO] ------------------------------------------------------------------------
+[INFO] [site:deploy]
+Using private key: C:\Projects\putty\barrie@sourceforge-net.openssh
+scp://web.sourceforge.net/home/groups/q/qi/qifcon/htdocs/site - Session: Opened
+Executing command: mkdir -p /home/groups/q/qi/qifcon/htdocs/site/.
+Executing command: mkdir -p /home/groups/q/qi/qifcon/htdocs/site/.
+Executing command: scp -t /home/groups/q/qi/qifcon/htdocs/site/./wagon21889.zip
+Uploading: ./wagon21889.zip to scp://web.sourceforge.net/home/groups/q/qi/qifcon/htdocs/site
+
+########################
+Transfer finished. 95979 bytes copied in 1.872 seconds
+Executing command: cd /home/groups/q/qi/qifcon/htdocs/site/.; unzip -q -o wagon21889.zip; rm -f wagon21889.zip
+Executing command: chmod -Rf g+w,a+rX /home/groups/q/qi/qifcon/htdocs/site
+scp://web.sourceforge.net/home/groups/q/qi/qifcon/htdocs/site - Session: Disconnecting
+scp://web.sourceforge.net/home/groups/q/qi/qifcon/htdocs/site - Session: Disconnected
+[INFO] ------------------------------------------------------------------------
+[INFO] BUILD SUCCESSFUL
+[INFO] ------------------------------------------------------------------------
+[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</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...
+
+You don't have an active shell at this time. For basic file transfers and
+management, use web.sourceforge.net -- it allows rsync, sftp, and scp access.
+
+If you would like to create a shell, use ssh to login using a USER,PROJECT
+username with the "create" command. If you tell ssh to allocate a tty
+(e.g. using -t), an interactive shell will be opened when the create is
+done. Otherwise, the create command will exit when the shell becomes
+ready for use. An example create that enters the shell when ready:
+
+ ssh -t USER,PROJECT@shell.sourceforge.net create
+
+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-2009
+
+ The Apache Software Foundation
+
+
+
+
+
+
+
+
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></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/site-deploy-to-sourceforge.net.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: websites/production/maventest/content/plugins/maven-site-plugin-latest/examples/site-deploy-to-sourceforge.net.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision