o Add new report deregister goal, modify register goal for slightly modified report method

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@112977 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
bwalding committed 2003-02-23 15:57:06 +00:00
1 parent 7ade43c7a6
commit 9873992dfe
16 files changed
+187 -92

No files matched your search

+79 -30
View File
@@ -10,23 +10,58 @@
xmlns:velocity="jelly:org.apache.commons.jelly.tags.velocity.VelocityTagLibrary"
xmlns:doc="doc">
<j:new var="reports" className="java.util.ArrayList"/>
<define:taglib uri="doc">
<define:tag name="registerReport">
<define:tag name="deregisterReport">
<!-- @name : Report to deregister, must be same as name used to register -->
<j:set
var="reports"
value="${pom.getPluginContext('maven-xdoc-plugin').getVariable('reports')}"/>
<j:new var="report" className="java.util.HashMap"/>
<j:set var="dummy" value="${report.put('name', name)}"/>
<j:set var="dummy" value="${report.put('link', link)}"/>
<j:set var="dummy" value="${report.put('description', description)}"/>
<j:set var="dummy" value="${reports.add(report)}"/>
<j:set var="removeRpt" value="null"/>
<j:forEach var="rpt" items="${reports}">
<j:if test="${rpt.get('name').equals(name)}">
<j:set var="removeRpt" value="${rpt}"/>
</j:if>
</j:forEach>
<j:if test="${removeRpt != null}">
<j:set var="dummy" value="${reports.remove(removeRpt)}"/>
</j:if>
</define:tag>
<define:tag name="registerReport">
<!--
@name the name of this report. Used for navigation items
@plugin-name the name of the plugin. @plugin:report goal must exist
@description text description of report
@link the nav-bar link for this report
-->
<j:set
var="reports"
value="${pom.getPluginContext('maven-xdoc-plugin').getVariable('reports')}"/>
<j:set var="add" value="true"/>
<j:forEach var="rpt" items="${reports}">
<j:if test="${rpt.get('name').equals(name)}">
<j:set var="add" value="false"/>
</j:if>
</j:forEach>
<j:if test="${add.equals('true')}">
<j:new var="report" className="java.util.HashMap"/>
<j:set var="dummy" value="${report.put('name', name)}"/>
<j:set var="dummy" value="${report.put('pluginName', pluginName)}"/>
<j:set var="dummy" value="${report.put('description', description)}"/>
<j:set var="dummy" value="${report.put('link', link)}"/>
<j:set var="dummy" value="${reports.add(report)}"/>
<echo>${report}</echo>
</j:if>
</define:tag>
<define:tag name="formatAsNumber">
<!--
| @string
@@ -316,7 +351,6 @@
<j:useBean var="files" class="org.apache.velocity.texen.util.FileUtil"/>
<j:forEach var="pomDocument" items="${pomDocuments}">
<velocity:merge
name="${maven.gen.docs}/${pomDocument}"
basedir="${plugin.resources}/templates"
@@ -504,32 +538,36 @@
locale="${maven.xdoc.date.locale}"/>
</tstamp>
</goal>
<goal name="xdoc:register-reports">
<!--
| This should be a LinkedHashSet to prevent someone from
| registering somthing twice. Unfortunately, 1.3 does not
| have a LinkedHashSet so I'll leave this here as a reminder
| for us someday. In the meantime, each time this goal is called,
| we'll just replace the old List with a new one. Shouldn't cause
| any problmes. When we do actually use the Set, we can put a check
| to see if 'reports' already exists, and if so, do nothing.
| <j:new var="reports" className="java.util.LinkedHashSet"/>
|-->
<j:new var="reports" className="java.util.ArrayList"/>
<j:set var="dummy" value="${pom.getPluginContext('maven-xdoc-plugin').setVariable('reports', reports)}"/>
<!--
| We need to have each <report> register itself with us so we can
| build up our navbar. To do this, we call the plugin:register
| goal on each report plugin.
|-->
<j:forEach var="report" items="${pom.reports}">
<j:set var="reportGoal" value="${report}:register"/>
<echo>${report} is registering with the xdoc plugin ... </echo>
<attainGoal name="${reportGoal}"/>
</j:forEach>
<j:if test="${!pom.reports.isEmpty()}">
<j:forEach var="report" items="${pom.reports}">
<attainGoal name="${report}:register"/>
</j:forEach>
</j:if>
<!-- If the descriptor is empty, use these as defaults -->
<j:if test="${pom.reports.isEmpty()}">
<attainGoal name="maven-jdepend-plugin:register"/>
<attainGoal name="maven-checkstyle-plugin:register"/>
<attainGoal name="maven-changelog-plugin:register"/>
<attainGoal name="maven-developer-activity-plugin:register"/>
<attainGoal name="maven-file-activity-plugin:register"/>
<attainGoal name="maven-license-plugin:register"/>
<attainGoal name="maven-javadoc-plugin:register"/>
<attainGoal name="maven-jxr-plugin:register"/>
<attainGoal name="maven-junit-report-plugin:register"/>
<attainGoal name="maven-linkcheck-plugin:register"/>
<attainGoal name="maven-tasklist-plugin:register"/>
</j:if>
</goal>
<goal name="xdoc:jelly-transform"
@@ -588,5 +626,16 @@
srcdir="${maven.xdoc.src}"
destdir="${maven.docs.dest}"/>
</goal>
<goal name="xdoc:dump-report-settings">
<echo>Dumping report settings</echo>
<j:set
var="reports"
value="${pom.getPluginContext('maven-xdoc-plugin').getVariable('reports')}"/>
<j:forEach var="report" items="${reports}">
<echo>Report: ${report}</echo>
</j:forEach>
</goal>
</project>