From 9480f0b3579a47c6073f21040994476ab53371ec Mon Sep 17 00:00:00 2001
From: michal <michal@13f79535-47bb-0310-9956-ffa450edef68>
Date: Sun, 27 Jul 2003 21:48:41 +0000
Subject: [PATCH] Added generation of "Projects Overview".

Goals multiproject:create-nav and multiproject:create-overview-page
are independed but still
reactor usage should be rationalized as at the moment for generating web site
3 passes of reactor are needed.


git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@113728 13f79535-47bb-0310-9956-ffa450edef68
---
 multiproject/plugin.jelly                     | 43 ++++++++++++++++++-
 multiproject/plugin.properties                |  4 ++
 .../templates/navigation-aggregate.xml        |  3 ++
 .../templates/navigation-independent.xml      |  3 ++
 .../templates/projects-overview.xml           | 16 +++++++
 5 files changed, 68 insertions(+), 1 deletion(-)
 create mode 100644 multiproject/src/plugin-resources/templates/projects-overview.xml

diff --git a/multiproject/plugin.jelly b/multiproject/plugin.jelly
index 17924f40..4aba17f4 100644
--- a/multiproject/plugin.jelly
+++ b/multiproject/plugin.jelly
@@ -29,6 +29,7 @@
     description="Run the site goal of all subprojects">
 
     <attainGoal name="multiproject:create-nav"/>
+    <attainGoal name="multiproject:create-overview-page"/>
     
     <!-- FIXME: This can't use multiproject:goal as it throws away the projects -->
     <!-- generate site docs -->
@@ -94,11 +95,12 @@
     <!-- generate navbar for project based on aggregate or independent -->
     <j:set var="aggregateDir" value="${maven.multiproject.aggregateDir}"/>
     <j:set var="navType" value="${maven.multiproject.navigation}"/>
+    <j:set var="createOverviewPage" value="${maven.multiproject.overviewPage}"/>
     <j:if test="${navType != ''}">
       <echo>Producing ${navType} navigation...</echo> 
       <velocity:merge 
         name="${maven.gen.docs}/navigation.xml"
-        basedir="${plugin.resources}/templates"
+        basedir="${maven.multiproject.templates}"
         template="navigation-${navType}.xml"/>
     </j:if>
 
@@ -116,9 +118,48 @@
         basedir="${maven.docs.src}"
         template="navigation.xml"/>
     </j:if>
+    
+    
 
   </goal>
   
+  <!--==================================================================-->
+  <!-- Generate Overview of all projects                                -->
+  <!--==================================================================-->    
+  <goal name="multiproject:create-overview-page">
+  
+    <mkdir dir="${maven.gen.docs}"/>
+    
+    <j:set var="createOverviewPage" value="${maven.multiproject.overviewPage}"/>
+    <j:if test="${createOverviewPage=='true'}">
+      
+      <!-- FIXME: 2) Needs to be a tag
+       | get all projects for template processing
+       | -->
+      <maven:reactor
+        basedir="${maven.multiproject.basedir}"
+        banner="Getting projects for creating an overview page"
+        includes="${maven.multiproject.includes}"
+        excludes="${maven.multiproject.excludes}"
+        postProcessing="true"
+        ignoreFailures="true"
+      />
+    
+     <ant:echo>Using tamplate:${maven.multiproject.templates}/projects-overview.xml</ant:echo>
+     <velocity:merge 
+         name="${maven.gen.docs}/projects-overview.xml"
+         basedir="${maven.multiproject.templates}"
+         template="projects-overview.xml"/>
+    </j:if>      
+    
+  </goal>
+  
+  
+  
+  
+  
+  
+  
   <!--==================================================================-->
   <!-- Run specific sets of goals for all subprojects                   -->
   <!--==================================================================-->
diff --git a/multiproject/plugin.properties b/multiproject/plugin.properties
index cac2e006..f19a1c28 100644
--- a/multiproject/plugin.properties
+++ b/multiproject/plugin.properties
@@ -7,6 +7,7 @@ maven.multiproject.basedir=${basedir}
 maven.multiproject.includes=**/project.xml
 maven.multiproject.excludes=
 maven.multiproject.ignoreFailures=false
+maven.multiproject.templates=${plugin.resources}/templates
 
 # Decide whether to aggregate all project generated web sites in one
 # place or to provide external links to each project's web site.
@@ -17,3 +18,6 @@ maven.multiproject.type=jar
 
 # directory under target/docs where aggregated sites are copied to
 maven.multiproject.aggregateDir=multiproject/
+
+#should overview page be created?
+maven.multiproject.overviewPage=true
diff --git a/multiproject/src/plugin-resources/templates/navigation-aggregate.xml b/multiproject/src/plugin-resources/templates/navigation-aggregate.xml
index db9a00b2..c5c7dfca 100644
--- a/multiproject/src/plugin-resources/templates/navigation-aggregate.xml
+++ b/multiproject/src/plugin-resources/templates/navigation-aggregate.xml
@@ -6,6 +6,9 @@
 
   <body>
     <menu name="Projects">
+    #if ($createOverviewPage == "true" )
+      <item name="Overview" href="projects-overview.xml"/>
+    #end
     #foreach ($reactorProject in $reactorProjects)
       <item name="$reactorProject.name" href="/${aggregateDir}${reactorProject.artifactId}/index.html"/>
     #end
diff --git a/multiproject/src/plugin-resources/templates/navigation-independent.xml b/multiproject/src/plugin-resources/templates/navigation-independent.xml
index b2c88ff7..bcbe6e72 100644
--- a/multiproject/src/plugin-resources/templates/navigation-independent.xml
+++ b/multiproject/src/plugin-resources/templates/navigation-independent.xml
@@ -6,6 +6,9 @@
 
   <body>
     <menu name="Projects">
+    #if ($createOverviewPage == "true" )
+      <item name="Overview" href="projects-overview.xml"/>
+    #end
     #foreach ($reactorProject in $reactorProjects)
       <item name="$reactorProject.name" href="${reactorProject.url}"/>
     #end
diff --git a/multiproject/src/plugin-resources/templates/projects-overview.xml b/multiproject/src/plugin-resources/templates/projects-overview.xml
new file mode 100644
index 00000000..34d87986
--- /dev/null
+++ b/multiproject/src/plugin-resources/templates/projects-overview.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<document>
+  <properties>
+    <title>Overview of projects</title>
+    <author email="michal.maczka@dimatics.com">Michal Maczka</author>
+  </properties>  
+ <body> 
+   #foreach ($reactorProject in $reactorProjects)
+    <section name="$reactorProject.name">
+      <p>
+        ${reactorProject.description}
+      </p>
+    </section>
+   #end
+ </body>
+</document>
\ No newline at end of file