Update docs with new generated navigation feature

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@113584 13f79535-47bb-0310-9956-ffa450edef68

multiproject/xdocs/changes.xml

@@ -7,6 +7,9 @@
 
   <body>
     <release version="1.0" date="in CVS">
+      <action dev="dion" type="update">
+        Updated multiproject:site to automate navigation generation for all projects
+      </action>
       <action dev="michal" type="add">
         Added multiproject 'install', 'install-snapshot', 'deploy' and 'deploy-snapshot'
         facility

multiproject/xdocs/goals.xml

@@ -8,10 +8,48 @@
   </properties>
   <body>
     <goals>
+
       <goal>
         <name>multiproject</name>
-        <description>Run the site goal of all projects</description>
+        <description>Executes multiproject:site</description>
       </goal>
+
+      <goal>
+        <name>multiproject:artifact</name>
+        <description>
+          Run <code>'artifact':'artifact'</code> goal for all projects.
+        </description>
+      </goal
+      
+      <goal>
+        <name>multiproject:deploy</name>
+        <description>
+          Run <code>'artifact':install-snapshot</code> goal for all projects.
+        </description>
+      </goal>      
+
+      <goal>
+        <name>multiproject:deploy-snapshot</name>
+        <description>
+          Run <code>'artifact':install-snapshot</code> goal for all projects.
+        </description>
+      </goal>
+
+      <goal>
+        <name>multiproject:goal</name>
+        <description>
+              Run the comma separated list of goals provided by the variable <code>goal</code> for all projects
+              e.g.
+              <source>
+                  maven -Dgoal=java:compile multiproject:goal
+              </source>
+              or
+              <source>
+                  maven -Dgoal=clean,java:compile,test multiproject:goal
+              </source>
+        </description>
+      </goal>
+
       <goal>
         <name>multiproject:install</name>
         <description>
@@ -37,45 +75,28 @@
           </ol>
         </description>
       </goal>
+
       <goal>
         <name>multiproject:install-snapshot</name>
         <description>
           Run <code>'artifact':install-snapshot</code> goal for all projects.
         </description>
       </goal>
+
       <goal>
-        <name>multiproject:deploy</name>
+        <name>multiproject:site</name>
         <description>
-          Run <code>'artifact':install-snapshot</code> goal for all projects.
-        </description>
-      </goal>      
-      <goal>
-        <name>multiproject:deploy-snapshot</name>
-        <description>
-          Run <code>'artifact':install-snapshot</code> goal for all projects.
-        </description>
-      </goal>
-      <goal>
-        <name>multiproject:artifact</name>
-        <description>
-          Run <code>'artifact':'artifact'</code> goal for all projects.
-        </description>
-      </goal
-      
-      <goal>
-        <name>multiproject:goal</name>
-        <description>
-              Run the comma separated list of goals provided by the variable <code>goal</code> for all projects
-              e.g.
-              <source>
-                  maven -Dgoal=java:compile multiproject:goal
-              </source>
-              or
-              <source>
-                  maven -Dgoal=clean,java:compile,test multiproject:goal
-              </source>
+          <p>
+            Run the site goal of all projects, generating navigation for projects processed according to the
+            <a href="properties.html">maven.multiproject.navigation</a> property.
+          </p>
+          <p>
+            If a navigation.xml is found in <code>${basedir}/multiproject/navigation.xml</code>, it will 
+            take precedence over the multiproject navigation.
+          </p>
         </description>
       </goal>
+
     </goals>
   </body>
 </document>

multiproject/xdocs/properties.xml

@@ -66,6 +66,33 @@
           </td>
         </tr>
         
+        <tr>
+          <td>maven.multiproject.navigation</td>
+          <td>Yes</td>
+          <td>
+            <p>
+              This property tells the plugin how to generate navigation for the set of sites being managed.
+            </p>
+            <p>
+              If the property is set to <code>independent</code> a navigation menu is generated with each
+              project's name linking to the project's URL, as specified in that project's descriptor, project.xml.
+            </p>
+            <p>
+              If the property is set to <code>aggregate</code> a navigation menu is generated with each
+              project's name linking to <code>/multiproject/${project.name}/index.html</code>. At the completion of 
+              the <a href="goals.html">multiproject:site</a> goal, each project's generated site is copied into
+              the appropriate directory. e.g. if WebProject1 and JarProject2 are the names of projects
+              processed via <code>multiproject:site</code>, the project that is executing 
+              <code>multiproject:site</code> will have the generated sites from 
+              <code>WebProject1/target/docs</code> and <code>JarProject2/target/docs</code> copied into
+              <code>target/docs/multiproject/WebProject1</code> and 
+              <code>target/docs/multiproject/JarProject2</code> respectively.
+            </p>
+            <p>
+              Default value is <code>aggregate</code>.
+            </p>
+          </td>
+        </tr>
         <tr>
           <td>maven.multiproject.type</td>
           <td>No</td>