From 7fa2b05ed514f9484c7c174dc73df51983837e52 Mon Sep 17 00:00:00 2001
From: vmassol <vmassol@13f79535-47bb-0310-9956-ffa450edef68>
Date: Wed, 3 Dec 2003 11:10:09 +0000
Subject: [PATCH] Added column legends to the dashboard report.

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@114437 13f79535-47bb-0310-9956-ffa450edef68
---
 dashboard/plugin.jelly                        |  9 ++++
 dashboard/plugin.properties                   | 22 +++++++++-
 .../plugin-resources/templates/dashboard.jsl  |  4 ++
 .../src/plugin-resources/templates/legend.jsl | 41 +++++++++++++++++++
 dashboard/xdocs/authoring.xml                 |  1 +
 dashboard/xdocs/changes.xml                   |  3 ++
 6 files changed, 78 insertions(+), 2 deletions(-)
 create mode 100644 dashboard/src/plugin-resources/templates/legend.jsl

diff --git a/dashboard/plugin.jelly b/dashboard/plugin.jelly
index dd1c671b..8f1e68a3 100644
--- a/dashboard/plugin.jelly
+++ b/dashboard/plugin.jelly
@@ -103,6 +103,7 @@
         file="${maven.dashboard.report.xdoc}.xml"/>
     <a:mkdir dir="${xdocReportDir}"/>
 
+    <!-- Generate main report -->
     <d:jsl
         input="${maven.dashboard.report.xml}"
         output="${maven.dashboard.report.xdoc}.xml"
@@ -110,6 +111,14 @@
         outputMode="xml"
         prettyPrint="true"/>
 
+    <!-- Generate legend report -->
+    <d:jsl
+        input="${maven.dashboard.report.xml}"
+        output="${maven.dashboard.report.legend.xdoc}.xml"
+        stylesheet="${maven.dashboard.template.legend}"
+        outputMode="xml"
+        prettyPrint="true"/>
+
   </goal>
 
   <!--
diff --git a/dashboard/plugin.properties b/dashboard/plugin.properties
index ce1b76f0..e8b205f1 100644
--- a/dashboard/plugin.properties
+++ b/dashboard/plugin.properties
@@ -16,14 +16,22 @@ maven.dashboard.ignoreFailures=false
 # Generated dashboard xml data file
 maven.dashboard.report.xml = ${maven.build.dir}/dashboard-data.xml
 
-# Generated dashboard xdoc file name (without the extension). 
+# Generated dashboard main report xdoc file name (without the extension). 
 # Note: The value must not include any path as the xdoc will be 
 # generated in ${maven.gen.docs}.
 maven.dashboard.report.xdoc = dashboard-report
 
-# Location of JSL template to generate the xdoc file
+# Generated dashboard legend xdoc file name (without the extension). 
+# Note: The value must not include any path as the xdoc will be 
+# generated in ${maven.gen.docs}.
+maven.dashboard.report.legend.xdoc = dashboard-report-legend
+
+# Location of JSL template to generate the main report xdoc file
 maven.dashboard.template = ${plugin.resources}/templates/dashboard.jsl
 
+# Location of JSL template to generate the legend report xdoc file
+maven.dashboard.template.legend = ${plugin.resources}/templates/legend.jsl
+
 # Decide whether a call to dashboard:report will call the reactor
 # on the child projects to generate individual dashboard data. If you
 # already using the multiproject project or the reactor, a better option
@@ -59,57 +67,67 @@ maven.dashboard.aggregator.csall.script = ${maven.dashboard.aggregators.dir}/csa
 maven.dashboard.aggregator.csall.artifact = ${maven.build.dir}/checkstyle-raw-report.xml
 maven.dashboard.aggregator.csall.label = CS err/warn
 maven.dashboard.aggregator.csall.goal = checkstyle
+maven.dashboard.aggregator.csall.description = Number of Checkstyle errors and warnings
 
 # Properties for the Checkstyle error aggregator (only errors)
 maven.dashboard.aggregator.cserrors.script = ${maven.dashboard.aggregators.dir}/cserrors.jelly
 maven.dashboard.aggregator.cserrors.artifact = ${maven.build.dir}/checkstyle-raw-report.xml
 maven.dashboard.aggregator.cserrors.label = CS errors
 maven.dashboard.aggregator.cserrors.goal = checkstyle
+maven.dashboard.aggregator.cserrors.description = Number of Checkstyle errors
 
 # Properties for the Checkstyle warning aggregator (only warnings)
 maven.dashboard.aggregator.cswarnings.script = ${maven.dashboard.aggregators.dir}/cswarnings.jelly
 maven.dashboard.aggregator.cswarnings.artifact = ${maven.build.dir}/checkstyle-raw-report.xml
 maven.dashboard.aggregator.cswarnings.label = CS warnings
 maven.dashboard.aggregator.cswarnings.goal = checkstyle
+maven.dashboard.aggregator.cswarnings.description = Number of Checkstyle warnings
 
 # Properties for the Clover TPC aggregator (TPC = Total Percent Coverage)
 maven.dashboard.aggregator.clovertpc.script = ${maven.dashboard.aggregators.dir}/clovertpc.jelly
 maven.dashboard.aggregator.clovertpc.artifact = ${maven.build.dir}/clover.xml
 maven.dashboard.aggregator.clovertpc.label = Clover TPC
 maven.dashboard.aggregator.clovertpc.goal = clover
+maven.dashboard.aggregator.clovertpc.description = Number of test coverage percentage
 
 # Properties for the Clover LOC aggregator (LOC = Line Of Code)
 maven.dashboard.aggregator.cloverloc.script = ${maven.dashboard.aggregators.dir}/cloverloc.jelly
 maven.dashboard.aggregator.cloverloc.artifact = ${maven.build.dir}/clover.xml
 maven.dashboard.aggregator.cloverloc.label = Clover LOC
 maven.dashboard.aggregator.cloverloc.goal = clover
+maven.dashboard.aggregator.cloverloc.description = Number of line of code (including comments)
 
 # Properties for the Clover NCLOC aggregator (NCLOC = Non Comment Line Of Code)
 maven.dashboard.aggregator.cloverncloc.script = ${maven.dashboard.aggregators.dir}/cloverncloc.jelly
 maven.dashboard.aggregator.cloverncloc.artifact = ${maven.build.dir}/clover.xml
 maven.dashboard.aggregator.cloverncloc.label = Clover NCLOC
 maven.dashboard.aggregator.cloverncloc.goal = clover
+maven.dashboard.aggregator.cloverncloc.description = Number of non-commented lines of code
 
 # Properties for the JUnit Test aggregator 
 maven.dashboard.aggregator.junittests.script = ${maven.dashboard.aggregators.dir}/junittests.jelly
 maven.dashboard.aggregator.junittests.artifact = ${maven.build.dir}/TESTS-TestSuites.xml
 maven.dashboard.aggregator.junittests.label = JUnit Tests
 maven.dashboard.aggregator.junittests.goal = junit-report:report
+maven.dashboard.aggregator.junittests.description = Number of JUnit tests
 
 # Properties for the JUnit Failures aggregator 
 maven.dashboard.aggregator.junitfailures.script = ${maven.dashboard.aggregators.dir}/junitfailures.jelly
 maven.dashboard.aggregator.junitfailures.artifact = ${maven.build.dir}/TESTS-TestSuites.xml
 maven.dashboard.aggregator.junitfailures.label = JUnit Failures
 maven.dashboard.aggregator.junitfailures.goal = junit-report:report
+maven.dashboard.aggregator.junitfailures.description = Number of JUnit test failures
 
 # Properties for the JUnit Errors aggregator 
 maven.dashboard.aggregator.juniterrors.script = ${maven.dashboard.aggregators.dir}/juniterrors.jelly
 maven.dashboard.aggregator.juniterrors.artifact = ${maven.build.dir}/TESTS-TestSuites.xml
 maven.dashboard.aggregator.juniterrors.label = JUnit Errors
 maven.dashboard.aggregator.juniterrors.goal = junit-report:report
+maven.dashboard.aggregator.juniterrors.description = Number of JUnit test errors
 
 # Properties for the JUnit Pass Rate  aggregator 
 maven.dashboard.aggregator.junitpassrate.script = ${maven.dashboard.aggregators.dir}/junitpassrate.jelly
 maven.dashboard.aggregator.junitpassrate.artifact = ${maven.build.dir}/TESTS-TestSuites.xml
 maven.dashboard.aggregator.junitpassrate.label = JUnit Pass Rate
 maven.dashboard.aggregator.junitpassrate.goal = junit-report:report
+maven.dashboard.aggregator.junitpassrate.description = Percentage of JUnit tests that have passed vs tests in error or failed
diff --git a/dashboard/src/plugin-resources/templates/dashboard.jsl b/dashboard/src/plugin-resources/templates/dashboard.jsl
index 6f78def9..3baf4806 100644
--- a/dashboard/src/plugin-resources/templates/dashboard.jsl
+++ b/dashboard/src/plugin-resources/templates/dashboard.jsl
@@ -14,6 +14,10 @@
       </properties>
       <body>
         <section name="Dashboard report">
+          <p>
+            <a href="${maven.dashboard.report.legend.xdoc}.html" target="Legend">Column 
+            legends</a>
+          </p>
           <table>
             <tr>
               <th>Project</th>
diff --git a/dashboard/src/plugin-resources/templates/legend.jsl b/dashboard/src/plugin-resources/templates/legend.jsl
new file mode 100644
index 00000000..b1566855
--- /dev/null
+++ b/dashboard/src/plugin-resources/templates/legend.jsl
@@ -0,0 +1,41 @@
+<?xml version="1.0"?>
+
+<jsl:stylesheet
+  select="$doc"
+  xmlns:j="jelly:core"
+  xmlns:jsl="jelly:jsl"
+  xmlns:x="jelly:xml"
+  xmlns="dummy" trim="false">
+
+  <jsl:template match="dashboard">
+    <document>
+      <properties>
+        <title>Dashboard Report Legend</title>
+      </properties>
+      <body>
+        <section name="Dashboard report column legend">
+          <table>
+            <tr>
+              <th>Column name</th>
+              <th>Description</th>
+            </tr>
+            <x:forEach var="aggregatorName" select="project[1]/aggregator/@name">
+              <tr>
+                <td>
+                  <j:set var="labelProperty" 
+                      value="maven.dashboard.aggregator.${aggregatorName.value}.label"/>
+                  <j:expr value="${context.getVariable(labelProperty)}"/>
+                </td>                
+                <td>
+                  <j:set var="descriptionProperty" 
+                      value="maven.dashboard.aggregator.${aggregatorName.value}.description"/>
+                  <j:expr value="${context.getVariable(descriptionProperty)}"/>
+                </td>
+              </tr>
+            </x:forEach>
+          </table>
+        </section>
+      </body>
+    </document>
+  </jsl:template>
+</jsl:stylesheet>
diff --git a/dashboard/xdocs/authoring.xml b/dashboard/xdocs/authoring.xml
index da482692..cf7c390e 100644
--- a/dashboard/xdocs/authoring.xml
+++ b/dashboard/xdocs/authoring.xml
@@ -54,6 +54,7 @@ maven.dashboard.aggregator.[aggregator name].script = [location of my custom jel
 maven.dashboard.aggregator.[aggregator name].artifact = [Location of artifacts from which to extract data]
 maven.dashboard.aggregator.[aggregator name].label = [Label to display in report]
 maven.dashboard.aggregator.[aggregator name].goal = [Goal to call that generates the artifact above]
+maven.dashboard.aggregator.[aggregator name].description = [Aggregator description legend]
 ]]></source>
         <p>
           In order to use your aggregator in the dashboard report, you need to 
diff --git a/dashboard/xdocs/changes.xml b/dashboard/xdocs/changes.xml
index f97d77bc..62aca912 100644
--- a/dashboard/xdocs/changes.xml
+++ b/dashboard/xdocs/changes.xml
@@ -8,6 +8,9 @@
   <body>
 
     <release version="1.2" date="in CVS">
+      <action dev="vmassol">
+        Added column legends to the dashboard report.
+      </action>
       <action dev="vmassol" due-to="John D Taylor">
         Added JUnit aggregators.
       </action>