Hi all,
As I am a docoholic, I solved some of the problems I found in the
generation of the docs, which were :
- when you were on the "task-list.html" page, you didn't see the same
menu as the other pages under "Project Reports". I added "task-list.xml"
to the check for $infilename in "src/dvsl/xdocs/site.dvsl". While I was
there, I reorganized this check, setting an array of files that are
under "Project Info" and "Project Reports", and checking against that
array. This way, the only thing we have to do is to add a file name in
these arrays, and the menu will be the same than the other files under
those categories.
- when you were on the "tasks.html" page, in the menu you didn't see the
"Task List" link. This was because "tasks.xml" is not a generated page
but a user page, and because the dvsl task generating the user docs in
"src/templates/build/plugins/docs/build.xml" didn't set the tool
"toolbox.string.genDoc", so you got an "invalid reference" error. I
added the tool to the task.
- the "Project Reports" page had a title "Project Information". I set it
to "Project Reports". (btw, on this page, you don't see the "Tasks" and
"Task List" links. The "Tasks" link is commented for later use. What
about the "Task List" link ? Should it be there ?)
- the "Source XReference" pages had a notice that said "This page
generated by Maven", which misses a verb, no ? ;-) I set it to "This
page was generated by Maven", "Maven" now being a link to the Maven
homepage (btw, when will maven be a top-project ?).
Thanx,
St�phane
Index: src/dvsl/xdocs/site.dvsl
===================================================================
RCS file: /home/cvspublic/jakarta-turbine-maven/src/dvsl/xdocs/site.dvsl,v
retrieving revision 1.50
diff -u -r1.50 site.dvsl
--- src/dvsl/xdocs/site.dvsl 5 Jun 2002 15:03:59 -0000 1.50
+++ src/dvsl/xdocs/site.dvsl 6 Jun 2002 02:56:36 -0000
@@ -170,38 +170,44 @@
<div><small><a href="$relativePath/index.html">Front
Page</a></small></div>
<div>
<small><a href="$relativePath/project-info.html">Project
Info</a></small>
- #if ($currentDir == "." && ($infilename == "project-info.xml" ||
$infilename == "mail-lists.xml" || $infilename == "team-list.xml" || $infilename ==
"dependencies.xml"))
- <div><small><a href="$relativePath/mail-lists.html">Mailing
Lists</a></small></div>
- <div><small><a href="$relativePath/team-list.html">Project
Team</a></small></div>
- <div><small><a
href="$relativePath/dependencies.html">Dependencies</a></small></div>
- #if ($pom.repository.url)
- <div><small><a
href="$pom.repository.url.toString().trim()">Source Repository</a></small></div>
+ #set ($projectInfoFiles = ["dependencies", "mail-lists",
+"project-info", "team-list"])
+ #foreach ($infoFile in $projectInfoFiles)
+ #if ($currentDir == "." && $infilename == "${infoFile}.xml")
+ <div><small><a href="$relativePath/mail-lists.html">Mailing
+Lists</a></small></div>
+ <div><small><a href="$relativePath/team-list.html">Project
+Team</a></small></div>
+ <div><small><a
+href="$relativePath/dependencies.html">Dependencies</a></small></div>
+ #if ($pom.repository.url)
+ <div><small><a
+href="$pom.repository.url.toString().trim()">Source Repository</a></small></div>
+ #end
+ #if ($pom.issueTrackingUrl)
+ <div><small><a
+href="$pom.issueTrackingUrl.toString().trim()">Issue Tracking</a></small></div>
+ #end
#end
- #if ($pom.issueTrackingUrl)
- <div><small><a
href="$pom.issueTrackingUrl.toString().trim()">Issue Tracking</a></small></div>
- #end
- #end
+ #end
</div>
<div>
<small><a href="$relativePath/maven-reports.html">Project
Reports</a></small>
- #if ($currentDir == "." && ($infilename == "maven-reports.xml" ||
$infilename == "tasks.xml" || $infilename == "changelog.xml" || $infilename ==
"junit-report.xml" || $infilename == "jdepend-report.xml" || $infilename ==
"checkstyle-report.xml" || $infilename == "activity-log.xml" || $infilename ==
"file-activity-report.xml"))
- #if
($context.toolbox.fileutil.file("$context.toolbox.docSrc/tasks.xml").exists())
- <div><small><a
href="$relativePath/tasks.html">Tasks</a></small></div>
- #end
- #if
($context.toolbox.fileutil.file("$context.toolbox.genDoc/task-list.xml").exists())
- <div><small><a href="$relativePath/task-list.html">Task
List</a></small></div>
- #end
- #if ($pom.repository)
- <div><small><a href="$relativePath/changelog.html">Change
Log</a></small></div>
- <div><small><a href="$relativePath/activity-log.html">Developer
Activity</a></small></div>
- <div><small><a
href="$relativePath/file-activity-report.html">File Activity</a></small></div>
- #end
- #if ($context.toolbox.testSrcPresent == "true")
- <div><small><a href="$relativePath/junit-report.html">Unit
Tests</a></small></div>
- #end
- #if ($context.toolbox.srcPresent == "true")
- <div><small><a href="$relativePath/jdepend-report.html">Metric
Results</a></small></div>
- <div><small><a
href="$relativePath/checkstyle-report.html">Checkstyle Report</a></small></div>
+ #set ($projectReportFiles = ["activity-log", "changelog",
+"checkstyle-report", "file-activity-report", "jdepend-report", "junit-report",
+"maven-reports", "task-list", "tasks"])
+ #foreach ($reportFile in $projectReportFiles)
+ #if ($currentDir == "." && $infilename == "${reportFile}.xml")
+ #if
+($context.toolbox.fileutil.file("$context.toolbox.docSrc/tasks.xml").exists())
+ <div><small><a
+href="$relativePath/tasks.html">Tasks</a></small></div>
+ #end
+ #if
+($context.toolbox.fileutil.file("$context.toolbox.genDoc/task-list.xml").exists())
+ <div><small><a href="$relativePath/task-list.html">Task
+List</a></small></div>
+ #end
+ #if ($pom.repository)
+ <div><small><a href="$relativePath/changelog.html">Change
+Log</a></small></div>
+ <div><small><a href="$relativePath/activity-log.html">Developer
+Activity</a></small></div>
+ <div><small><a
+href="$relativePath/file-activity-report.html">File Activity</a></small></div>
+ #end
+ #if ($context.toolbox.testSrcPresent == "true")
+ <div><small><a href="$relativePath/junit-report.html">Unit
+Tests</a></small></div>
+ #end
+ #if ($context.toolbox.srcPresent == "true")
+ <div><small><a href="$relativePath/jdepend-report.html">Metric
+Results</a></small></div>
+ <div><small><a
+href="$relativePath/checkstyle-report.html">Checkstyle Report</a></small></div>
+ #end
#end
#end
</div>
Index: src/templates/build/plugins/docs/build.xml
===================================================================
RCS file:
/home/cvspublic/jakarta-turbine-maven/src/templates/build/plugins/docs/build.xml,v
retrieving revision 1.10
diff -u -r1.10 build.xml
--- src/templates/build/plugins/docs/build.xml 5 Jun 2002 00:50:24 -0000 1.10
+++ src/templates/build/plugins/docs/build.xml 6 Jun 2002 02:56:19 -0000
@@ -420,6 +420,7 @@
<classpath refid="maven-classpath"/>
<tool name="toolbox.string.basedir" value="${basedir}"/>
<tool name="toolbox.string.docSrc" value="${maven.docs.src}"/>
+ <tool name="toolbox.string.genDoc" value="${maven.gen.docs}"/>
<tool name="toolbox.string.srcDir" value="${maven.src.dir}"/>
<tool name="toolbox.string.srcPresent" value="${maven.sourcesPresent}"/>
<tool name="toolbox.string.testSrcPresent"
value="${maven.unitTestSourcesPresent}"/>
Index: src/java/org/apache/maven/jxr/JXR.java
===================================================================
RCS file:
/home/cvspublic/jakarta-turbine-maven/src/java/org/apache/maven/jxr/JXR.java,v
retrieving revision 1.10
diff -u -r1.10 JXR.java
--- src/java/org/apache/maven/jxr/JXR.java 22 May 2002 17:59:00 -0000 1.10
+++ src/java/org/apache/maven/jxr/JXR.java 6 Jun 2002 02:56:57 -0000
@@ -71,7 +71,8 @@
* Description of the Field
*/
public final static String NOTICE =
- "This page automatically generated by Maven";
+ "This page was automatically generated by " +
+ "<a href="http://jakarta.apache.org/turbine/maven";>Maven</a>";
/**
* Path to all source.files
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
