You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by mi...@apache.org on 2016/02/08 20:06:48 UTC
svn commit: r979873 [20/32] - in
/websites/production/maven/components/plugins-archives/maven-site-plugin-LATEST:
./ apidocs/ css/ examples/ fonts/ images/ images/profiles/ img/ js/
testapidocs/ xref-test/ xref/ xref/org/apache/maven/plugins/site/ xref...
Modified: websites/production/maven/components/plugins-archives/maven-site-plugin-LATEST/usage.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-site-plugin-LATEST/usage.html (original)
+++ websites/production/maven/components/plugins-archives/maven-site-plugin-LATEST/usage.html Mon Feb 8 19:06:46 2016
@@ -1,212 +1,422 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-07
- | Rendered using Apache Maven Stylus Skin 1.5
+ | Generated by Apache Maven Doxia 1.7-SNAPSHOT at 2016-02-08
+ | Rendered using Apache Maven Fluido Skin 1.4
-->
-<html xmlns="http://www.w3.org/1999/xhtml">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
- <title>Apache Maven Site Plugin – Usage</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 charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="author" content="Vincent Siveton
vincent.siveton@gmail.com
Maria Odea Ching" />
- <meta name="Date-Creation-yyyymmdd" content="20120112" />
- <meta name="Date-Revision-yyyymmdd" content="20140707" />
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-
-<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
-
+ <meta name="Date-Creation-yyyymmdd" content="20120112" />
+ <meta name="Date-Revision-yyyymmdd" content="20160208" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Apache Maven Site Plugin – Usage</title>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.4.min.css" />
+ <link rel="stylesheet" href="./css/site.css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="./js/apache-maven-fluido-1.4.min.js"></script>
+
+
+
+<script src="https://www.google-analytics.com/urchin.js" type="text/javascript"></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="" />
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="http://www.apache.org/" id="bannerLeft">
+ <img src="../../images/apache-maven-project.png" alt="Apache Maven"/>
</a>
- <span id="bannerRight">
- <img src="../../images/maven-logo-2.gif" alt="" />
- </span>
- <div class="clear">
- <hr/>
+ </div>
+ <div class="pull-right"> <a href="../../" id="bannerRight">
+ <img src="../../images/maven-logo-black-on-white.png" />
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
</div>
- </div>
- <div id="breadcrumbs">
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="http://www.apache.org/" class="externalLink" title="Apache">
+ Apache</a>
+ <span class="divider">/</span>
+ </li>
+ <li class="">
+ <a href="../../index.html" title="Maven">
+ Maven</a>
+ <span class="divider">/</span>
+ </li>
+ <li class="">
+ <a href="../index.html" title="Plugins">
+ Plugins</a>
+ <span class="divider">/</span>
+ </li>
+ <li class="">
+ <a href="./" title="Apache Maven Site Plugin">
+ Apache Maven Site Plugin</a>
+ <span class="divider">/</span>
+ </li>
+ <li class="active ">Usage</li>
+
+
+
+ <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2016-02-08</li>
+ <li id="projectVersion" class="pull-right">
+ Version: 3.5-SNAPSHOT
+ </li>
- <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="./">Apache Maven Site Plugin</a>
- >
- Usage
- </div>
- <div class="xright">
- Last Published: 2014-07-07
- | Version: 3.4
- </div>
- <div class="clear">
- <hr/>
+ </ul>
</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">
- <strong>Usage</strong>
+
+
+ <div class="row-fluid">
+ <div id="leftColumn" class="span2">
+ <div class="well sidebar-nav">
+
+
+ <ul class="nav nav-list">
+ <li class="nav-header">Overview</li>
+
+ <li>
+
+ <a href="index.html" title="Introduction">
+ <span class="none"></span>
+ Introduction</a>
+ </li>
+
+ <li>
+
+ <a href="plugin-info.html" title="Goals">
+ <span class="none"></span>
+ Goals</a>
+ </li>
+
+ <li class="active">
+
+ <a href="#"><span class="none"></span>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>
- <li class="none">
- <a href="http://www.apache.org/licenses/" class="externalLink">License</a>
- </li>
- <li class="none">
- <a href="download.html">Download</a>
- </li>
- </ul>
- <h5>Configuration</h5>
- <ul>
- <li class="none">
- <a href="i18n.html">Internationalization</a>
- </li>
- <li class="none">
- <a href="../../doxia/doxia-sitetools/doxia-decoration-model/decoration.html">Site Descriptor</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/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>
+
+ <a href="faq.html" title="FAQ">
+ <span class="none"></span>
+ FAQ</a>
+ </li>
+
+ <li>
+
+ <a href="migrate.html" title="Migrate">
+ <span class="none"></span>
+ Migrate</a>
+ </li>
+
+ <li>
+
+ <a href="maven-3.html" title="Maven 3">
+ <span class="none"></span>
+ Maven 3</a>
+ </li>
+
+ <li>
+
+ <a href="http://www.apache.org/licenses/" class="externalLink" title="License">
+ <span class="none"></span>
+ License</a>
+ </li>
+
+ <li>
+
+ <a href="download.html" title="Download">
+ <span class="none"></span>
+ Download</a>
+ </li>
+ <li class="nav-header">Configuration</li>
+
+ <li>
+
+ <a href="i18n.html" title="Internationalization">
+ <span class="none"></span>
+ Internationalization</a>
+ </li>
+
+ <li>
+
+ <a href="../../doxia/doxia-sitetools/doxia-decoration-model/decoration.html" title="Site Descriptor">
+ <span class="none"></span>
+ Site Descriptor</a>
+ </li>
+ <li class="nav-header">Examples</li>
+
+ <li>
+
+ <a href="examples/creating-content.html" title="Creating Content">
+ <span class="none"></span>
+ Creating Content</a>
+ </li>
+
+ <li>
+
+ <a href="examples/sitedescriptor.html" title="Configuring the Site Descriptor">
+ <span class="none"></span>
+ Configuring the Site Descriptor</a>
+ </li>
+
+ <li>
+
+ <a href="examples/multimodule.html" title="Building a multi-module site">
+ <span class="none"></span>
+ Building a multi-module site</a>
+ </li>
+
+ <li>
+
+ <a href="examples/configuring-reports.html" title="Configuring Reports">
+ <span class="none"></span>
+ Configuring Reports</a>
+ </li>
+
+ <li>
+
+ <a href="examples/siterun.html" title="Configuring Site Run">
+ <span class="none"></span>
+ Configuring Site Run</a>
+ </li>
+
+ <li>
+
+ <a href="examples/adding-deploy-protocol.html" title="Adding a Protocol to Deploy the Site">
+ <span class="none"></span>
+ Adding a Protocol to Deploy the Site</a>
+ </li>
+
+ <li>
+
+ <a href="examples/templatefile.html" title="Changing the Template File">
+ <span class="none"></span>
+ Changing the Template File</a>
+ </li>
+
+ <li>
+
+ <a href="examples/creatingskins.html" title="Creating Skins">
+ <span class="none"></span>
+ Creating Skins</a>
+ </li>
+
+ <li>
+
+ <a href="examples/moduleexcludes.html" title="Excluding Document Formats">
+ <span class="none"></span>
+ Excluding Document Formats</a>
+ </li>
+
+ <li>
+
+ <a href="examples/site-deploy-to-sourceforge.net.html" title="Deploying to sourceforge.net">
+ <span class="none"></span>
+ Deploying to sourceforge.net</a>
+ </li>
+ <li class="nav-header">Project Documentation</li>
+
+ <li>
+
+ <a href="project-info.html" title="Project Information">
+ <span class="icon-chevron-right"></span>
+ Project Information</a>
</li>
- <li class="collapsed">
- <a href="project-reports.html">Project Reports</a>
+
+ <li>
+
+ <a href="project-reports.html" title="Project Reports">
+ <span class="icon-chevron-right"></span>
+ 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 & 3</a>
- </li>
- <li class="none">
- <a href="../../pom/index.html">Parent POMs</a>
- </li>
- <li class="none">
- <a href="../index.html">Plugins</a>
- </li>
- <li class="none">
- <a href="../../plugin-tools/index.html">Plugin Tools</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="../../skins/index.html">Skins</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>
- <h5>ASF</h5>
- <ul>
- <li class="none">
- <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</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/references/apt-
format.html --><div class="section">
+ <li class="nav-header">Maven Projects</li>
+
+ <li>
+
+ <a href="../../ant-tasks/index.html" title="Ant Tasks">
+ <span class="none"></span>
+ Ant Tasks</a>
+ </li>
+
+ <li>
+
+ <a href="../../archetype/index.html" title="Archetype">
+ <span class="none"></span>
+ Archetype</a>
+ </li>
+
+ <li>
+
+ <a href="../../doxia/index.html" title="Doxia">
+ <span class="none"></span>
+ Doxia</a>
+ </li>
+
+ <li>
+
+ <a href="../../jxr/index.html" title="JXR">
+ <span class="none"></span>
+ JXR</a>
+ </li>
+
+ <li>
+
+ <a href="../../ref/current" title="Maven">
+ <span class="none"></span>
+ Maven</a>
+ </li>
+
+ <li>
+
+ <a href="../../pom/index.html" title="Parent POMs">
+ <span class="none"></span>
+ Parent POMs</a>
+ </li>
+
+ <li>
+
+ <a href="../index.html" title="Plugins">
+ <span class="none"></span>
+ Plugins</a>
+ </li>
+
+ <li>
+
+ <a href="../../plugin-testing/index.html" title="Plugin Testing">
+ <span class="none"></span>
+ Plugin Testing</a>
+ </li>
+
+ <li>
+
+ <a href="../../plugin-tools/index.html" title="Plugin Tools">
+ <span class="none"></span>
+ Plugin Tools</a>
+ </li>
+
+ <li>
+
+ <a href="../../apache-resource-bundles/index.html" title="Resource Bundles">
+ <span class="none"></span>
+ Resource Bundles</a>
+ </li>
+
+ <li>
+
+ <a href="../../scm/index.html" title="SCM">
+ <span class="none"></span>
+ SCM</a>
+ </li>
+
+ <li>
+
+ <a href="../../shared/index.html" title="Shared Components">
+ <span class="none"></span>
+ Shared Components</a>
+ </li>
+
+ <li>
+
+ <a href="../../skins/index.html" title="Skins">
+ <span class="none"></span>
+ Skins</a>
+ </li>
+
+ <li>
+
+ <a href="../../surefire/index.html" title="Surefire">
+ <span class="none"></span>
+ Surefire</a>
+ </li>
+
+ <li>
+
+ <a href="../../wagon/index.html" title="Wagon">
+ <span class="none"></span>
+ Wagon</a>
+ </li>
+ <li class="nav-header">ASF</li>
+
+ <li>
+
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works">
+ <span class="none"></span>
+ How Apache Works</a>
+ </li>
+
+ <li>
+
+ <a href="http://www.apache.org/foundation/" class="externalLink" title="Foundation">
+ <span class="none"></span>
+ Foundation</a>
+ </li>
+
+ <li>
+
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache">
+ <span class="none"></span>
+ Sponsoring Apache</a>
+ </li>
+
+ <li>
+
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">
+ <span class="none"></span>
+ Thanks</a>
+ </li>
+ </ul>
+
+
+ <form id="search-form" action="https://www.google.com/search" method="get" >
+
+ <input value="$sitesearchValue" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=search-form"></script>
+
+ <hr />
+
+ <div id="poweredBy">
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+
+ <div class="g-plusone" data-href="http://maven.apache.org/plugins/maven-site-plugin/" data-size="tall" ></div>
+
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
+ </a>
+ </div>
+ </div>
+ </div>
+
+
+ <div id="bodyColumn" class="span10" >
+
+ <!-- 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/references/
apt-format.html --><div class="section">
<h2><a name="Usage"></a>Usage</h2>
<p>You can put additional content (e.g. documentation, resources, etc.) in your site. See <a href="./examples/creating-content.html">Creating Content</a> for more information on this. If you want to change the menus, breadcrumbs, links or logos on your pages you need to add and configure a <a href="./examples/sitedescriptor.html">site descriptor</a>. If you like, you also can let Maven generate some <a href="./examples/configuring-reports.html">reports</a> for you, based on the contents of your POM.</p>
<ul>
@@ -217,16 +427,15 @@ Maria Odea Ching" />
<div class="section">
<h3><a name="Generating_a_Site"></a>Generating a Site</h3>
<p>To generate the project's site and reports, execute:</p>
-<div class="source">
-<pre>mvn site</pre></div>
+<div class="source"><pre class="prettyprint linenums">mvn site
+</pre></div>
<p>By default, the resulting site will be in the <tt>target/site/</tt> directory.</p>
<p><b>Note:</b> If you have a multi module project, then the links between the parent and child modules will <i>not</i> work when you use '<tt>mvn site</tt>' or '<tt>mvn site:site</tt>'. If you want to use those links, you should use '<tt>mvn site:stage</tt>' instead. You can read more about that goal further down on this page in the section called '<i>Staging a Site</i>'.</p>
<p><b>Note:</b> For performance reasons, Maven compares the timestamps of generated files and corresponding source documents, and only regenerates documents that have changed since the last build. However, this only applies to documentation source documents (apt, xdoc,...). If you change anything in your <tt>site.xml</tt>, any relevant sections in your pom, or any relevant properties or resource files, you should generate the site from scratch to make sure all references and links are correct.</p></div>
<div class="section">
<h3><a name="Deploying_a_Site"></a>Deploying a Site</h3>
<p>To be able to deploy the site, you must first specify where the site will be deployed. This is set in the <tt><distributionManagement></tt> element of the POM as shown below.</p>
-<div class="source">
-<pre><project>
+<div class="source"><pre class="prettyprint linenums"><project>
...
<distributionManagement>
<site>
@@ -235,57 +444,60 @@ Maria Odea Ching" />
</site>
</distributionManagement>
...
-</project></pre></div>
+</project>
+</pre></div>
<p>The <tt><id></tt> element identifies the repository, so that you can attach credentials to it in your <tt>settings.xml</tt> file using the <a class="externalLink" href="http://maven.apache.org/settings.html#Servers"><tt><servers></tt> element</a> as you would for any other repository.</p>
<p>The <tt><url></tt> gives the location to deploy to. In the example above we copy to the host <tt>www.mycompany.com</tt> using the path <tt>/www/docs/project/</tt> over the <tt>scp</tt> protocol. You can read more about which protocols are supported on <a href="./examples/adding-deploy-protocol.html">this page</a>. If subprojects inherit the site URL from a parent POM, they will automatically append their <tt><artifactId></tt> to form their effective deployment location.</p>
<p>Now you can execute the <tt><a href="./deploy-mojo.html">site:deploy</a></tt> goal from your project directory.</p>
<p><b>Note:</b> A site must be generated first before executing <tt>site:deploy</tt>.</p>
-<div class="source">
-<pre>mvn site:deploy</pre></div>
+<div class="source"><pre class="prettyprint linenums">mvn site:deploy
+</pre></div>
<p>If you want to generate the site <i>and</i> deploy it in one go, you can utilize the <tt>site-deploy</tt> phase of the site lifecycle. To do this, just execute:</p>
-<div class="source">
-<pre>mvn site-deploy</pre></div></div>
+<div class="source"><pre class="prettyprint linenums">mvn site-deploy
+</pre></div></div>
<div class="section">
<h3><a name="Staging_a_Site"></a>Staging a Site</h3>
<p><b>Note:</b> This goal is available in version 2.0-beta-5 or later of the Site Plugin.</p>
<p>To review/test the generated web site before an official deploy, you can stage the site in a specific directory. It will use the <tt><distributionManagement></tt> element or the project hierarchy to link the project and its modules.</p>
<p>Just execute the <tt><a href="./stage-mojo.html">site:stage</a></tt> goal from your project</p>
-<div class="source">
-<pre>mvn site:stage</pre></div>
+<div class="source"><pre class="prettyprint linenums">mvn site:stage
+</pre></div>
<p><b>Note:</b> Since version 2.3, a site must be generated first before executing <tt>site:stage</tt>.</p>
<p>By default, the site will be staged in a directory <tt>target/staging/</tt>. A different staging location can be chosen with the <tt>stagingDirectory</tt> parameter as shown below:</p>
-<div class="source">
-<pre>mvn site:stage -DstagingDirectory=C:\fullsite</pre></div>
+<div class="source"><pre class="prettyprint linenums">mvn site:stage -DstagingDirectory=C:\fullsite
+</pre></div>
<p><b>Note:</b> <tt>stagingDirectory</tt> cannot be dynamic, i.e. <tt>stagingDirectory=${basedir}\fullsite</tt></p>
<p>To stage a site and to deploy it, just execute the <tt><a href="./stage-deploy-mojo.html">site:stage-deploy</a></tt> goal from your project with the required parameters. The <tt>site:stage-deploy</tt> goal will use the value of <tt>distributionManagement.site.id</tt> as default id to lookup the server section in your <tt>settings.xml</tt>; unless this is not defined, then the String <tt>stagingSite</tt> will be used as id. So if you need to add your username or password separately for stage-deploy in <tt>settings.xml</tt>, you should use <tt><id>stagingSite</id></tt> for that <tt><server></tt> section. See the <a class="externalLink" href="http://maven.apache.org/guides/mini/guide-deployment-security-settings.html">Guide to Deployment and Security Settings</a> for more information on this.</p>
<p>By default, the site will be stage-deployed to <tt>$<a name="distributionManagement.site.url">distributionManagement.site.url</a>/staging/</tt>. A different location can be chosen with the <tt>stagingSiteURL</tt> parameter as shown below:</p>
-<div class="source">
-<pre>mvn site:stage-deploy -DstagingSiteURL=scp://www.mycompany.com/www/project/</pre></div>
+<div class="source"><pre class="prettyprint linenums">mvn site:stage-deploy -DstagingSiteURL=scp://www.mycompany.com/www/project/
+</pre></div>
<p><b>Note:</b> Since version 2.3, a site must be generated first before executing <tt>site:stage-deploy</tt>.</p>
<p><b>Note:</b> Due to a bug in Wagon, the password is not always picked up when you run the <tt>site:stage-deploy</tt> goal. The bug has been fixed, but the version of Wagon that is used by the Site Plugin is determined by the version of Maven you use. The current 2.0.x releases of Maven use a version where this bug is still present.</p></div>
<div class="section">
<h3><a name="Running_a_Site"></a>Running a Site</h3>
<p>The Site Plugin can also be used to start up the site in Jetty. To do this, execute:</p>
-<div class="source">
-<pre>mvn site:run</pre></div>
+<div class="source"><pre class="prettyprint linenums">mvn site:run
+</pre></div>
<p>The server will, by default, be started on <tt>http://localhost:8080/</tt>. See <a class="externalLink" href="http://jetty.mortbay.org/">http://jetty.mortbay.org/</a> for more information about the Jetty server.</p>
<p><b>Note:</b> Running a site only works for single-module sites. To preview a multi-module site one should use <tt>site:stage</tt>.</p></div></div>
- </div>
- </div>
- <div class="clear">
- <hr/>
- </div>
- <div id="footer">
- <div class="xright">
- © 2002-2014
- 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>
+ </div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container-fluid">
+ <div class="row-fluid">
+ <p >Copyright © 2002–2016
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All rights reserved.
+
+ </p>
+ </div>
+
+
+ </div>
+ </footer>
+ </body>
</html>
\ No newline at end of file
Modified: websites/production/maven/components/plugins-archives/maven-site-plugin-LATEST/xref/index.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-site-plugin-LATEST/xref/index.html (original)
+++ websites/production/maven/components/plugins-archives/maven-site-plugin-LATEST/xref/index.html Mon Feb 8 19:06:46 2016
@@ -1,24 +0,0 @@
-
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
-<html xml:lang="en" lang="en">
-<!-- this is a JXR report set -->
- <head>
- <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
- <title>Apache Maven Site Plugin 3.4 Reference</title>
- </head>
- <frameset cols="20%,80%">
- <frameset rows="30%,70%">
- <frame src="overview-frame.html" name="packageListFrame" />
- <frame src="allclasses-frame.html" name="packageFrame" />
- </frameset>
- <frame src="overview-summary.html" name="classFrame" />
- <noframes>
- <body>
- <h1>Frame Alert</h1>
- <p>
- You don't have frames. Go <a href="overview-summary.html">here</a>
- </p>
- </body>
- </noframes>
- </frameset>
-</html>
Modified: websites/production/maven/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/AbstractSiteMojo.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/AbstractSiteMojo.html (original)
+++ websites/production/maven/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/AbstractSiteMojo.html Mon Feb 8 19:06:46 2016
@@ -27,151 +27,117 @@
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L21" href="#L21">21</a>
-<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.File;
-<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
-<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
-<a class="jxr_linenumber" name="L25" href="#L25">25</a>
-<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.List;
-<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.Properties;
-<a class="jxr_linenumber" name="L28" href="#L28">28</a>
-<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.repository.ArtifactRepository;
-<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.versioning.ComparableVersion;
-<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.tools.SiteTool;
-<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo;
-<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component;
-<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter;
-<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
-<a class="jxr_linenumber" name="L36" href="#L36">36</a>
-<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.i18n.I18N;
-<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.IOUtil;
-<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.ReaderFactory;
-<a class="jxr_linenumber" name="L40" href="#L40">40</a>
-<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * Base class for site mojos.</em>
-<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:brett@apache.org" target="alexandria_uri">mailto:brett@apache.org</a>">Brett Porter</a></em>
-<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/site/AbstractSiteMojo.html">AbstractSiteMojo</a>
-<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">extends</strong> AbstractMojo
-<a class="jxr_linenumber" name="L48" href="#L48">48</a> {
-<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * A comma separated list of locales supported by Maven. The first valid token will be the default Locale</em>
-<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * for this instance of the Java Virtual Machine.</em>
-<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * @since 2.3</em>
-<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L55" href="#L55">55</a> @Parameter( property = <span class="jxr_string">"locales"</span> )
-<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">protected</strong> String locales;
-<a class="jxr_linenumber" name="L57" href="#L57">57</a>
-<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * SiteTool.</em>
-<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L61" href="#L61">61</a> @Component
-<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">protected</strong> SiteTool siteTool;
-<a class="jxr_linenumber" name="L63" href="#L63">63</a>
-<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * Internationalization.</em>
-<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L67" href="#L67">67</a> @Component
-<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">protected</strong> I18N i18n;
-<a class="jxr_linenumber" name="L69" href="#L69">69</a>
-<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * Directory containing the site.xml file and the source for apt, fml and xdoc docs.</em>
-<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * @since 2.3</em>
-<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L75" href="#L75">75</a> @Parameter( defaultValue = <span class="jxr_string">"${basedir}/src/site"</span> )
-<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">protected</strong> File siteDirectory;
-<a class="jxr_linenumber" name="L77" href="#L77">77</a>
-<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * The maven project.</em>
-<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L81" href="#L81">81</a> @Parameter( defaultValue = <span class="jxr_string">"${project}"</span>, readonly = <strong class="jxr_keyword">true</strong> )
-<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">protected</strong> MavenProject project;
-<a class="jxr_linenumber" name="L83" href="#L83">83</a>
-<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * The local repository.</em>
-<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L87" href="#L87">87</a> @Parameter( defaultValue = <span class="jxr_string">"${localRepository}"</span>, readonly = <strong class="jxr_keyword">true</strong> )
-<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">protected</strong> ArtifactRepository localRepository;
-<a class="jxr_linenumber" name="L89" href="#L89">89</a>
-<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * The reactor projects.</em>
-<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L93" href="#L93">93</a> @Parameter( defaultValue = <span class="jxr_string">"${reactorProjects}"</span>, required = <strong class="jxr_keyword">true</strong>, readonly = <strong class="jxr_keyword">true</strong> )
-<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">protected</strong> List<MavenProject> reactorProjects;
-<a class="jxr_linenumber" name="L95" href="#L95">95</a>
-<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * Specifies the input encoding.</em>
-<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * @since 2.3</em>
-<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L101" href="#L101">101</a> @Parameter( property = <span class="jxr_string">"encoding"</span>, defaultValue = <span class="jxr_string">"${project.build.sourceEncoding}"</span> )
-<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">private</strong> String inputEncoding;
-<a class="jxr_linenumber" name="L103" href="#L103">103</a>
-<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * Specifies the output encoding.</em>
-<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * @since 2.3</em>
-<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L109" href="#L109">109</a> @Parameter( property = <span class="jxr_string">"outputEncoding"</span>, defaultValue = <span class="jxr_string">"${project.reporting.outputEncoding}"</span> )
-<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">private</strong> String outputEncoding;
-<a class="jxr_linenumber" name="L111" href="#L111">111</a>
-<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * Gets the input files encoding.</em>
-<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * @return The input files encoding, never <code>null</code>.</em>
-<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">protected</strong> String getInputEncoding()
-<a class="jxr_linenumber" name="L118" href="#L118">118</a> {
-<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">return</strong> ( inputEncoding == <strong class="jxr_keyword">null</strong> ) ? ReaderFactory.ISO_8859_1 : inputEncoding;
-<a class="jxr_linenumber" name="L120" href="#L120">120</a> }
-<a class="jxr_linenumber" name="L121" href="#L121">121</a>
-<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * Gets the effective reporting output files encoding.</em>
-<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * @return The effective reporting output file encoding, never <code>null</code>.</em>
-<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">protected</strong> String getOutputEncoding()
-<a class="jxr_linenumber" name="L128" href="#L128">128</a> {
-<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">return</strong> ( outputEncoding == <strong class="jxr_keyword">null</strong> ) ? ReaderFactory.UTF_8 : outputEncoding;
-<a class="jxr_linenumber" name="L130" href="#L130">130</a> }
-<a class="jxr_linenumber" name="L131" href="#L131">131</a>
-<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * Check the current Maven version to see if it's Maven 3.0 or newer.</em>
-<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isMaven3OrMore()
-<a class="jxr_linenumber" name="L136" href="#L136">136</a> {
-<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> ComparableVersion( getMavenVersion() ).compareTo( <strong class="jxr_keyword">new</strong> ComparableVersion( <span class="jxr_string">"3.0"</span> ) ) >= 0;
-<a class="jxr_linenumber" name="L138" href="#L138">138</a> }
-<a class="jxr_linenumber" name="L139" href="#L139">139</a>
-<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> String getMavenVersion()
-<a class="jxr_linenumber" name="L141" href="#L141">141</a> {
-<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_comment">// This relies on the fact that MavenProject is the in core classloader</em>
-<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_comment">// and that the core classloader is for the maven-core artifact</em>
-<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_comment">// and that should have a pom.properties file</em>
-<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_comment">// if this ever changes, we will have to revisit this code.</em>
-<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">final</strong> Properties properties = <strong class="jxr_keyword">new</strong> Properties();
-<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">final</strong> InputStream in =
-<a class="jxr_linenumber" name="L148" href="#L148">148</a> MavenProject.<strong class="jxr_keyword">class</strong>.getClassLoader().getResourceAsStream( <span class="jxr_string">"META-INF/maven/org.apache.maven/maven-core/pom.properties"</span> );
-<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">try</strong>
-<a class="jxr_linenumber" name="L150" href="#L150">150</a> {
-<a class="jxr_linenumber" name="L151" href="#L151">151</a> properties.load( in );
-<a class="jxr_linenumber" name="L152" href="#L152">152</a> }
-<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">catch</strong> ( IOException ioe )
-<a class="jxr_linenumber" name="L154" href="#L154">154</a> {
-<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">""</span>;
-<a class="jxr_linenumber" name="L156" href="#L156">156</a> }
-<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">finally</strong>
-<a class="jxr_linenumber" name="L158" href="#L158">158</a> {
-<a class="jxr_linenumber" name="L159" href="#L159">159</a> IOUtil.close( in );
-<a class="jxr_linenumber" name="L160" href="#L160">160</a> }
-<a class="jxr_linenumber" name="L161" href="#L161">161</a>
-<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">return</strong> properties.getProperty( <span class="jxr_string">"version"</span> ).trim();
-<a class="jxr_linenumber" name="L163" href="#L163">163</a> }
-<a class="jxr_linenumber" name="L164" href="#L164">164</a> }
+<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
+<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
+<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.List;
+<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.Locale;
+<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.Properties;
+<a class="jxr_linenumber" name="L27" href="#L27">27</a>
+<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.repository.ArtifactRepository;
+<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.versioning.ComparableVersion;
+<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.tools.SiteTool;
+<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo;
+<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component;
+<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter;
+<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
+<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.i18n.I18N;
+<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.IOUtil;
+<a class="jxr_linenumber" name="L37" href="#L37">37</a>
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * Base class for site mojos.</em>
+<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:brett@apache.org" target="alexandria_uri">mailto:brett@apache.org</a>">Brett Porter</a></em>
+<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/site/AbstractSiteMojo.html">AbstractSiteMojo</a>
+<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">extends</strong> AbstractMojo
+<a class="jxr_linenumber" name="L45" href="#L45">45</a> {
+<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * A comma separated list of locales to render. The first valid token will be the default Locale</em>
+<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * for this site.</em>
+<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * @since 2.3</em>
+<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L52" href="#L52">52</a> @Parameter( property = <span class="jxr_string">"locales"</span>, defaultValue = <span class="jxr_string">"en"</span> )
+<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">private</strong> String locales;
+<a class="jxr_linenumber" name="L54" href="#L54">54</a>
+<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * Set this to 'true' to skip site generation and staging.</em>
+<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * @since 3.0</em>
+<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L60" href="#L60">60</a> @Parameter( property = <span class="jxr_string">"maven.site.skip"</span>, defaultValue = <span class="jxr_string">"false"</span> )
+<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> skip;
+<a class="jxr_linenumber" name="L62" href="#L62">62</a>
+<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * SiteTool.</em>
+<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L66" href="#L66">66</a> @Component
+<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">protected</strong> SiteTool siteTool;
+<a class="jxr_linenumber" name="L68" href="#L68">68</a>
+<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * Internationalization.</em>
+<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L72" href="#L72">72</a> @Component
+<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">protected</strong> I18N i18n;
+<a class="jxr_linenumber" name="L74" href="#L74">74</a>
+<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * The Maven project.</em>
+<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L78" href="#L78">78</a> @Parameter( defaultValue = <span class="jxr_string">"${project}"</span>, readonly = <strong class="jxr_keyword">true</strong> )
+<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">protected</strong> MavenProject project;
+<a class="jxr_linenumber" name="L80" href="#L80">80</a>
+<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * The local repository.</em>
+<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L84" href="#L84">84</a> @Parameter( defaultValue = <span class="jxr_string">"${localRepository}"</span>, readonly = <strong class="jxr_keyword">true</strong> )
+<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">protected</strong> ArtifactRepository localRepository;
+<a class="jxr_linenumber" name="L86" href="#L86">86</a>
+<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * The reactor projects.</em>
+<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L90" href="#L90">90</a> @Parameter( defaultValue = <span class="jxr_string">"${reactorProjects}"</span>, required = <strong class="jxr_keyword">true</strong>, readonly = <strong class="jxr_keyword">true</strong> )
+<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">protected</strong> List<MavenProject> reactorProjects;
+<a class="jxr_linenumber" name="L92" href="#L92">92</a>
+<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * Check the current Maven version to see if it's Maven 3.0 or newer.</em>
+<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isMaven3OrMore()
+<a class="jxr_linenumber" name="L97" href="#L97">97</a> {
+<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> ComparableVersion( getMavenVersion() ).compareTo( <strong class="jxr_keyword">new</strong> ComparableVersion( <span class="jxr_string">"3.0"</span> ) ) >= 0;
+<a class="jxr_linenumber" name="L99" href="#L99">99</a> }
+<a class="jxr_linenumber" name="L100" href="#L100">100</a>
+<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> String getMavenVersion()
+<a class="jxr_linenumber" name="L102" href="#L102">102</a> {
+<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_comment">// This relies on the fact that MavenProject is the in core classloader</em>
+<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_comment">// and that the core classloader is for the maven-core artifact</em>
+<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_comment">// and that should have a pom.properties file</em>
+<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_comment">// if this ever changes, we will have to revisit this code.</em>
+<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">final</strong> Properties properties = <strong class="jxr_keyword">new</strong> Properties();
+<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">final</strong> String corePomProperties = <span class="jxr_string">"META-INF/maven/org.apache.maven/maven-core/pom.properties"</span>;
+<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">final</strong> InputStream in = MavenProject.<strong class="jxr_keyword">class</strong>.getClassLoader().getResourceAsStream( corePomProperties );
+<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">try</strong>
+<a class="jxr_linenumber" name="L111" href="#L111">111</a> {
+<a class="jxr_linenumber" name="L112" href="#L112">112</a> properties.load( in );
+<a class="jxr_linenumber" name="L113" href="#L113">113</a> }
+<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">catch</strong> ( IOException ioe )
+<a class="jxr_linenumber" name="L115" href="#L115">115</a> {
+<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">""</span>;
+<a class="jxr_linenumber" name="L117" href="#L117">117</a> }
+<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">finally</strong>
+<a class="jxr_linenumber" name="L119" href="#L119">119</a> {
+<a class="jxr_linenumber" name="L120" href="#L120">120</a> IOUtil.close( in );
+<a class="jxr_linenumber" name="L121" href="#L121">121</a> }
+<a class="jxr_linenumber" name="L122" href="#L122">122</a>
+<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">return</strong> properties.getProperty( <span class="jxr_string">"version"</span> ).trim();
+<a class="jxr_linenumber" name="L124" href="#L124">124</a> }
+<a class="jxr_linenumber" name="L125" href="#L125">125</a>
+<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">protected</strong> List<Locale> getLocales()
+<a class="jxr_linenumber" name="L127" href="#L127">127</a> {
+<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">return</strong> siteTool.getSiteLocales( locales );
+<a class="jxr_linenumber" name="L129" href="#L129">129</a> }
+<a class="jxr_linenumber" name="L130" href="#L130">130</a> }
</pre>
<hr/>
-<div id="footer">Copyright © 2002–2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
+<div id="footer">Copyright © 2002–2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>
\ No newline at end of file