<?xml version="1.0"?>
<!-- 
/*
 * Copyright 2001-2004 The Apache Software Foundation.
 * 
 * Licensed 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.
 */
 -->

<document>

  <properties>
    <title>Maven Site Plug-in Goals</title>
    <author email="dion@multitask.com.au">dIon Gillard</author>
  </properties>

  <body>
    <section name="Goals">
      <table>
        <tr><th>Goal</th><th>Description</th></tr>
        <tr>
          <td>site</td>
          <td>
            This is the default goal of the plugin and simply attains
            the <code>site:generate</code> goal.
          </td>
        </tr>
        <tr>
          <td>site:generate</td>
          <td>
            Generates a Maven documentation site by attaining the following
            goals
            <ul>
              <li>jdepend</li>
              <li>checkstyle</li>
              <li>changelog</li>
              <li>activity</li>
              <li>javadoc</li>
              <li>jxr</li>
              <li>junit-report</li>
              <li>tasklist</li>
              <li>xdoc</li>
            </ul>
            See the respective plugins for more information on those goals
          </td>
        </tr>
        <tr>
          <td>site:deploy</td>
          <td>
            Generates the site using the <code>site:generate</code>, and then
            deploys the site using either <code>ssh</code> or copying via the 
            file system, depending on the <code>maven.site.deploy.method</code>
            property.
          </td>
        </tr>
        <tr>
          <td>site:sshdeploy</td>
          <td>
            Deploys the site by <code>tar.gz</code>'ing the docs, 
            <code>scp</code>'ing them to the <code>pom.siteAddress</code>
            and then unpacking them into the <code>pom.siteDirectory</code>
          </td>
        </tr>
        <tr>
          <td>site:fsdeploy</td>
          <td>
            Deploys the site by coping the docs to the <code>pom.siteDirectory</code>
          </td>
        </tr>
      </table>
    </section>
 </body>
</document>
