Pure jelly reimplementation of Project Info templates
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@113315 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
f675566b02
commit
7c5a905da2
79
xdoc/src/plugin-resources/jelly-templates/cvs-usage.xml
Normal file
79
xdoc/src/plugin-resources/jelly-templates/cvs-usage.xml
Normal file
@ -0,0 +1,79 @@
|
||||
<?xml version="1.0"?>
|
||||
<document xmlns:j="jelly:core">
|
||||
|
||||
<properties>
|
||||
<author email="turbine-maven-dev@jakarta.apache.org">Maven</author>
|
||||
<title>CVS</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<j:set var="repository" value="${pom.repository}"/>
|
||||
|
||||
<j:if test="${empty(repository)}">
|
||||
<section name="Repository">
|
||||
<p>
|
||||
No SCM repository is defined.
|
||||
</p>
|
||||
</section>
|
||||
</j:if>
|
||||
<j:if test="${!empty(repository)}">
|
||||
|
||||
<j:set var="conn" value="${repository.cvsRoot}"/>
|
||||
<j:set var="module" value="${repository.cvsModule}"/>
|
||||
<j:set var="url" value="${repository.url}"/>
|
||||
|
||||
<section name="Web Access">
|
||||
<p>
|
||||
<a href="${url}">${url}</a>
|
||||
</p>
|
||||
</section>
|
||||
|
||||
<section name="Anonymous CVS Access">
|
||||
<p>
|
||||
This project's CVS repository can be checked out through anonymous (pserver)
|
||||
CVS with the following instruction set.
|
||||
When prompted for a password for anonymous, simply press the Enter key.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
cvs -d ${conn} login
|
||||
<br/>
|
||||
cvs -z3 -d ${conn} co ${module}
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Updates from within the module's directory do not need the -d parameter.
|
||||
</p>
|
||||
</section>
|
||||
|
||||
<section name="Developer CVS Access via SSH">
|
||||
|
||||
<p>
|
||||
Only project developers can access the CVS tree via this method.
|
||||
SSH1 must be installed on your client machine. Substitute
|
||||
<b>name</b> with the proper value. Enter your site password when prompted.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
export CVS_RSH=ssh
|
||||
<br/>
|
||||
cvs -z3 -d ${conn} co ${module}
|
||||
</p>
|
||||
|
||||
</section>
|
||||
|
||||
<section name="CVS Access behind a firewall">
|
||||
|
||||
<p>
|
||||
For those developers who are stuck behind a corporate
|
||||
firewall, <a href="http://cvsgrab.sourceforge.net/">CVSGrab</a>
|
||||
can use the viewcvs web interface to checkout the source code.
|
||||
</p>
|
||||
|
||||
</section>
|
||||
|
||||
</j:if>
|
||||
</body>
|
||||
|
||||
</document>
|
||||
|
||||
45
xdoc/src/plugin-resources/jelly-templates/dependencies.xml
Normal file
45
xdoc/src/plugin-resources/jelly-templates/dependencies.xml
Normal file
@ -0,0 +1,45 @@
|
||||
<?xml version="1.0"?>
|
||||
<document xmlns:j="jelly:core">
|
||||
|
||||
<properties>
|
||||
<title>Dependencies</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Dependencies">
|
||||
<j:if test="${size(pom.dependencies) == 0}">
|
||||
<p>
|
||||
There are no dependencies for this project. It is a standalone
|
||||
application that does not depend on any other project.
|
||||
</p>
|
||||
</j:if>
|
||||
<j:if test="${size(pom.dependencies) != 0}">
|
||||
<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>
|
||||
<j:forEach var="dep" items="${pom.dependencies}">
|
||||
<tr>
|
||||
<td>
|
||||
<j:if test="${!empty(dep.url)}">
|
||||
<a href="${dep.url}">${dep.groupId}</a>
|
||||
</j:if>
|
||||
<j:if test="${empty(dep.url)}">
|
||||
${dep.groupId}
|
||||
</j:if>
|
||||
</td>
|
||||
<td>${dep.version}</td>
|
||||
<td>${dep.artifact}</td>
|
||||
</tr>
|
||||
</j:forEach>
|
||||
</table>
|
||||
</j:if>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
15
xdoc/src/plugin-resources/jelly-templates/index.xml
Normal file
15
xdoc/src/plugin-resources/jelly-templates/index.xml
Normal file
@ -0,0 +1,15 @@
|
||||
<?xml version="1.0"?>
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>${pom.name}</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="${pom.name}">
|
||||
<p>
|
||||
${pom.description}
|
||||
</p>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
17
xdoc/src/plugin-resources/jelly-templates/issue-tracking.xml
Normal file
17
xdoc/src/plugin-resources/jelly-templates/issue-tracking.xml
Normal file
@ -0,0 +1,17 @@
|
||||
<?xml version="1.0"?>
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<author email="turbine-maven-dev@jakarta.apache.org">Maven</author>
|
||||
<title>Issue Tracking</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Issue Tracking">
|
||||
<p>
|
||||
<a href="${pom.issueTrackingUrl}">${pom.issueTrackingUrl}</a>
|
||||
</p>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
|
||||
59
xdoc/src/plugin-resources/jelly-templates/mail-lists.xml
Normal file
59
xdoc/src/plugin-resources/jelly-templates/mail-lists.xml
Normal file
@ -0,0 +1,59 @@
|
||||
<?xml version="1.0"?>
|
||||
<document xmlns:j="jelly:core" xmlns:define="jelly:define" xmlns:myMacros="myMacros">
|
||||
|
||||
<define:taglib uri="myMacros">
|
||||
<define:tag name="displayLink">
|
||||
<td>
|
||||
<j:if test="${!empty(link)}">
|
||||
<j:if test="${link.startsWith('http')}">
|
||||
<a href="${link}">${label}</a>
|
||||
</j:if>
|
||||
<j:if test="${!link.startsWith('http')}">
|
||||
<a href="mailto:${link}">${label}</a>
|
||||
</j:if>
|
||||
</j:if>
|
||||
<j:if test="${empty(link)}">
|
||||
Not Available
|
||||
</j:if>
|
||||
</td>
|
||||
</define:tag>
|
||||
</define:taglib>
|
||||
|
||||
<properties>
|
||||
<title>Mailing Lists</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Mailing Lists">
|
||||
<j:if test="${size(pom.mailingLists) == 0}">
|
||||
<p>
|
||||
There are no mailing lists established for this project. Please
|
||||
check back at a later date.
|
||||
</p>
|
||||
</j:if>
|
||||
<j:if test="${size(pom.mailingLists) != 0}">
|
||||
<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>
|
||||
<j:forEach var="list" items="${pom.mailingLists}">
|
||||
<tr>
|
||||
<td>${list.name}</td>
|
||||
<myMacros:displayLink label="Subscribe" link="${list.subscribe}"/>
|
||||
<myMacros:displayLink label="Unsubscribe" link="${list.unsubscribe}"/>
|
||||
<myMacros:displayLink label="Archive" link="${list.archive}"/>
|
||||
</tr>
|
||||
</j:forEach>
|
||||
</table>
|
||||
</j:if>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
32
xdoc/src/plugin-resources/jelly-templates/maven-reports.xml
Normal file
32
xdoc/src/plugin-resources/jelly-templates/maven-reports.xml
Normal file
@ -0,0 +1,32 @@
|
||||
<?xml version="1.0"?>
|
||||
<document xmlns:j="jelly:core">
|
||||
|
||||
<properties>
|
||||
<title>Project Reports</title>
|
||||
<author email="pete-apache-dev@kazmier.com">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://maven.apache.org/">Maven</a>.
|
||||
Each report is briefly described below.
|
||||
</p>
|
||||
|
||||
<j:set var="reports" value="${pom.getPluginContext('maven-xdoc-plugin').getVariable('reports')}"/>
|
||||
<subsection name="Overview">
|
||||
<table>
|
||||
<tr><th>Document</th><th>Description</th></tr>
|
||||
<j:forEach var="report" items="${reports}">
|
||||
<tr>
|
||||
<td><a href="${report.link}.html">${report.name}</a></td>
|
||||
<td>${report.description}</td>
|
||||
</tr>
|
||||
</j:forEach>
|
||||
</table>
|
||||
</subsection>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
70
xdoc/src/plugin-resources/jelly-templates/project-info.xml
Normal file
70
xdoc/src/plugin-resources/jelly-templates/project-info.xml
Normal file
@ -0,0 +1,70 @@
|
||||
<?xml version="1.0"?>
|
||||
<document xmlns:j="jelly:core">
|
||||
|
||||
<properties>
|
||||
<title>Project Information</title>
|
||||
<author email="pete-apache-dev@kazmier.com">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://maven.apache.org/">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>
|
||||
|
||||
<!--
|
||||
|
||||
This is really bad that the url requires specification in two
|
||||
places. Makes pluggable reporting impossible. FIX
|
||||
|
||||
-->
|
||||
|
||||
<j:if test="${!empty(pom.repository.url)}">
|
||||
<tr><td><a href="cvs-usage.html">Source Repository</a></td>
|
||||
<td>
|
||||
This is a link to the online source repository that can be
|
||||
viewed via a web browser.
|
||||
</td>
|
||||
</tr>
|
||||
</j:if>
|
||||
<j:if test="${!empty(pom.issueTrackingUrl)}">
|
||||
<tr><td><a href="issue-tracking.html">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>
|
||||
</j:if>
|
||||
</table>
|
||||
</subsection>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
99
xdoc/src/plugin-resources/jelly-templates/team-list.xml
Normal file
99
xdoc/src/plugin-resources/jelly-templates/team-list.xml
Normal file
@ -0,0 +1,99 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1" ?>
|
||||
<document xmlns:j="jelly:core">
|
||||
|
||||
<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">
|
||||
<j:if test="${size(pom.developers) == 0}">
|
||||
<p>
|
||||
There are no developers working on this project. Please check
|
||||
back at a later date.
|
||||
</p>
|
||||
</j:if>
|
||||
<j:if test="${size(pom.developers) != 0}">
|
||||
<p>
|
||||
The following is a list of developers with commit privileges that have
|
||||
directly contributed to the project in one way or another.
|
||||
</p>
|
||||
<table>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Id</th>
|
||||
<th>Email</th>
|
||||
<th>Organization</th>
|
||||
<th>Roles</th>
|
||||
</tr>
|
||||
<j:forEach var="developer" items="${pom.developers}">
|
||||
<tr>
|
||||
<j:if test="${!empty(developer.url)}">
|
||||
<td><a href="${developer.url}">${developer.name}</a></td>
|
||||
</j:if>
|
||||
<j:if test="${empty(developer.url)}">
|
||||
<td>${developer.name}</td>
|
||||
</j:if>
|
||||
<td><a name="${developer.id}">${developer.id}</a></td>
|
||||
<td><a href="mailto:${developer.email}">${developer.email}</a></td>
|
||||
<td>${developer.organization}</td>
|
||||
<td>
|
||||
<j:forEach var="role" items="${developer.roles}">
|
||||
${role}<br/>
|
||||
</j:forEach>
|
||||
</td>
|
||||
</tr>
|
||||
</j:forEach>
|
||||
</table>
|
||||
</j:if>
|
||||
<j:if test="${size(pom.contributors) != 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>
|
||||
<j:forEach var="contributor" items="${pom.contributors}">
|
||||
<tr>
|
||||
<td>${contributor.name}</td>
|
||||
<td><a href="mailto:${contributor.email}">${contributor.email}</a></td>
|
||||
<td>${contributor.organization}</td>
|
||||
<td>
|
||||
<j:forEach var="role" items="${contributor.roles}">
|
||||
${role}<br/>
|
||||
</j:forEach>
|
||||
</td>
|
||||
</tr>
|
||||
</j:forEach>
|
||||
</table>
|
||||
</section>
|
||||
</j:if>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
Loading…
x
Reference in New Issue
Block a user