jvanzyl 2002/07/05 09:17:27
Added: src/plugins/xdoc/templates Control.vm dependencies.xml
index.xml mail-lists.xml maven-reports.xml
project-info.xml team-list.xml
Log:
o More containment for the xdoc plugin.
Revision Changes Path
1.1 jakarta-turbine-maven/src/plugins/xdoc/templates/Control.vm
Index: Control.vm
===================================================================
## ------------------------------------------------------------------
## Generate the xdocs
## ------------------------------------------------------------------
#set ($dir = $generator.templatePath)
#set ($xdocs = $files.file($dir).list())
#foreach ($xdoc in $xdocs)
#if ($xdoc.endsWith(".xml"))
Generating --> $xdoc
$generator.parse($xdoc, $xdoc)
#end
#end
1.1
jakarta-turbine-maven/src/plugins/xdoc/templates/dependencies.xml
Index: dependencies.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Dependencies</title>
</properties>
<body>
<section name="Dependencies">
#if ($project.dependencies.size() == 0)
<p>
There are no dependencies for this project. It is a standalone
application that does not depend on any other project.
</p>
#else
<p>
The following is a list of dependencies for this project. These
dependencies are required to compile and run the application:
</p>
<table>
<tr>
<th>ID</th>
<th>Version</th>
<th>JAR</th>
</tr>
#foreach ($dep in $project.dependencies)
<tr>
<td>
#if ($dep.url && $dep.url.length() != 0)
<a href="$escape.getText($dep.url)">$!dep.id</a>
#else
$!dep.id
#end
</td>
<td>$!dep.version</td>
<td>$!dep.jar</td>
</tr>
#end
</table>
#end
</section>
</body>
</document>
1.1 jakarta-turbine-maven/src/plugins/xdoc/templates/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>$!project.name</title>
</properties>
<body>
<section name="$!project.name">
<p>
$!project.description
</p>
</section>
</body>
</document>
1.1 jakarta-turbine-maven/src/plugins/xdoc/templates/mail-lists.xml
Index: mail-lists.xml
===================================================================
<?xml version="1.0"?>
#macro (displayLink $label $link)
<td>
#if ($link && $link.length() != 0)
#if ($link.startsWith("http"))
<a href="$escape.getText($link)">$label</a>
#else
<a href="mailto:$link";>$label</a>
#end
#else
Not Available
#end
</td>
#end
<document>
<properties>
<title>Mailing Lists</title>
</properties>
<body>
<section name="Mailing Lists">
#if ($project.mailingLists.size() == 0)
<p>
There are no mailing lists established for this project. Please
check back at a later date.
</p>
#else
<p>
These are the mailing lists that have been established for this
project. For each list, there is a subscribe, unsubscribe, and an
archive link.
</p>
<table>
<tr>
<th>List Name</th>
<th>Subscribe</th>
<th>Unsubscribe</th>
<th>Archive</th>
</tr>
#foreach ($list in $project.mailingLists)
<tr>
<td>$list.name</td>
#displayLink("Subscribe" $list.subscribe)
#displayLink("Unsubscribe" $list.unsubscribe)
#displayLink("Archive" $list.archive)
</tr>
#end
</table>
#end
</section>
</body>
</document>
1.1
jakarta-turbine-maven/src/plugins/xdoc/templates/maven-reports.xml
Index: maven-reports.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Project Reports</title>
<author email="[EMAIL PROTECTED]">Pete Kazmier</author>
</properties>
<body>
<section name="Maven Generated Reports">
<p>
This document provides an overview of the various reports that
are automatically generated by
<a href="http://jakarta.apache.org/turbine/maven/";>Maven</a>.
Each report is briefly described below.
</p>
<subsection name="Overview">
<table>
<tr><th>Document</th><th>Description</th></tr>
<!--
Leaving this commented out until I have the document
auto-generated from the @task tags in the source code.
<tr><td><a href="tasks.html">Tasks</a></td>
<td>
This document contains a list of tasks that need to be
completed.
</td>
</tr>
-->
#if ($project.repository)
<tr><td><a href="changelog.html">Change Log</a></td>
<td>
This document provides a history of the most recent
changes made to the project.
</td>
</tr>
<tr><td><a href="activity-log.html">Developer Activity</a></td>
<td>
This document provides a report of activity in terms of
CVS commits and breaks it out by developer.
</td>
</tr>
<tr><td><a href="file-activity-report.html">File Activity</a></td>
<td>
This document provides a report of activity in terms of
CVS commits and breaks it out by file.
</td>
</tr>
#end
#if ($files.file($project.build.unitTestSourceDirectory).exists())
<tr><td><a href="junit-report.html">Unit Tests</a></td>
<td>
This document provides the results of the unit tests that
are part of this project. Successes and failures are
noted.
</td>
</tr>
#end
#if ($files.file($project.build.sourceDirectory).exists())
<tr><td><a href="jdepend-report.html">Metric Results</a></td>
<td>
This document provides information on various source code
metrics that have been computed. These metrics can
provide useful information regarding the abstractness and
total number of classes.
</td>
</tr>
<tr><td><a href="checkstyle-report.html">Checkstyle Report</a></td>
<td>
This document provides the results of the Checkstyle
report. This report provides an indication of how well
this project complies with its coding conventions.
</td>
</tr>
#end
#if ($files.file("$maven-docs-dest/clover").exists())
<tr><td><a href="clover/index.html">Clover Test Coverage</a></td>
<td>
This document provides the results of the Clover report. This
reports show what portion on your code has been executed by
your test suite and generates statistics. It gives a very good
idea of how good your test suite is.
</td>
</tr>
#end
</table>
</subsection>
</section>
</body>
</document>
1.1
jakarta-turbine-maven/src/plugins/xdoc/templates/project-info.xml
Index: project-info.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Project Information</title>
<author email="[EMAIL PROTECTED]">Pete Kazmier</author>
</properties>
<body>
<section name="General Project Information">
<p>
This document provides an overview of the various documents and
links that are part of this project's general information. All
of this content is automatically generated by
<a href="http://jakarta.apache.org/turbine/maven/";>Maven</a> on
behalf of the project.
</p>
<subsection name="Overview">
<table>
<tr><th>Document</th><th>Description</th></tr>
<tr><td><a href="mail-lists.html">Mailing Lists</a></td>
<td>
This document provides subscription and archive
information for this project's mailing lists.
</td>
</tr>
<tr><td><a href="team-list.html">Project Team</a></td>
<td>
This document provides information on the members of
this project. These are the individuals who have
contributed to the project in one form or another.
</td>
</tr>
<tr><td><a href="dependencies.html">Dependencies</a></td>
<td>
This document lists the projects dependencies and provides
information on each dependency.
</td>
</tr>
#if ($project.repository.url)
<tr><td><a
href="$escape.getText($project.repository.url.toString().trim())">Source
Repository</a></td>
<td>
This is a link to the online source repository that can be
viewed via a web browser.
</td>
</tr>
#end
#if ($project.issueTrackingUrl)
<tr><td><a
href="$escape.getText($project.issueTrackingUrl.toString().trim())">Issue
Tracking</a></td>
<td>
This is a link to the issue tracking system for this
project. Issues (bugs, features, change requests) can be
created and queried using this link.
</td>
</tr>
#end
</table>
</subsection>
</section>
</body>
</document>
1.1 jakarta-turbine-maven/src/plugins/xdoc/templates/team-list.xml
Index: team-list.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Project Team</title>
</properties>
<body>
<section name="The Team">
<p>
A successful project requires many people to play many roles.
Some members write code or documentation, while others are
valuable as testers, submitting patches and suggestions.
</p>
<p>
The team is comprised of <a href="#Members">Members</a>
and <a href="#Contributors">Contributors</a>. Members
have direct access to the source of a project and actively
evolve the code-base. Contributors improve the project
through submission of patches and suggestions to the Members.
The number of Contributors to the project is unbounded.
Get involved today. All contributions to the project are
greatly appreciated.
</p>
</section>
<section name="Members">
#if ($project.developers.size() == 0)
<p>
There are no developers working on this project. Please check
back at a later date.
</p>
#else
<p>
The following is a list of developers with commit priviledges that have
directly contributed to the project in one way or another.
</p>
<table>
<tr>
<th>Name</th>
<th>Email</th>
<th>Organization</th>
<th>Roles</th>
</tr>
#foreach ($developer in $project.developers)
<tr>
<td>$!developer.name</td>
<td><a href="mailto:$!developer.email";>$!developer.email</a></td>
<td>$!developer.organization</td>
<td>
#foreach ($role in $developer.roles)
$role<br/>
#end
</td>
</tr>
#end
</table>
#end
#if ($project.contributors.size() != 0 )
<section name="Contributors">
<p>
The following additional people have contributed to this project
through the way of suggestions, patches or documentation.
</p>
<table>
<tr>
<th>Name</th>
<th>Email</th>
<th>Organization</th>
<th>Roles</th>
</tr>
#foreach ($contributor in $project.contributors)
<tr>
<td>$!contributor.name</td>
<td><a href="mailto:$!contributor.email";>$!contributor.email</a></td>
<td>$!contributor.organization</td>
<td>
#foreach ($role in $contributor.roles)
$role<br/>
#end
</td>
</tr>
#end
</table>
</section>
#end
</section>
</body>
</document>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
