You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by rg...@apache.org on 2005/11/24 08:54:05 UTC
svn commit: r348681 - in
/forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo:
resources/stylesheets/changes-to-document.xsl
src/documentation/content/xdocs/index.xml
Author: rgardler
Date: Wed Nov 23 23:53:54 2005
New Revision: 348681
URL: http://svn.apache.org/viewcvs?rev=348681&view=rev
Log:
add some more documentation
Modified:
forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo/resources/stylesheets/changes-to-document.xsl
forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo/src/documentation/content/xdocs/index.xml
Modified: forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo/resources/stylesheets/changes-to-document.xsl
URL: http://svn.apache.org/viewcvs/forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo/resources/stylesheets/changes-to-document.xsl?rev=348681&r1=348680&r2=348681&view=diff
==============================================================================
--- forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo/resources/stylesheets/changes-to-document.xsl (original)
+++ forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo/resources/stylesheets/changes-to-document.xsl Wed Nov 23 23:53:54 2005
@@ -72,7 +72,7 @@
<xsl:apply-templates/>
</xsl:otherwise>
</xsl:choose>
- </body>
+ </body>
</document>
</xsl:template>
Modified: forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo/src/documentation/content/xdocs/index.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo/src/documentation/content/xdocs/index.xml?rev=348681&r1=348680&r2=348681&view=diff
==============================================================================
--- forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo/src/documentation/content/xdocs/index.xml (original)
+++ forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo/src/documentation/content/xdocs/index.xml Wed Nov 23 23:53:54 2005
@@ -25,18 +25,38 @@
<title>Apache Forrest - org.apache.forrest.plugin.input.projectInfo Plugin</title>
<p>This plugin generates project info from various configuration files.</p>
</section>
+
<section>
- <title>Features</title>
- <ul>
- <li><a href="changes.html">Recent Changes</a></li>
- <li><a href="todo.html">ToDo list</a></li>
- <li><a href="releaseNotes_0.1.html">Release Notes</a></li>
- <li><a href="projectDetails/projectDetails.html">Project Details</a></li>
- </ul>
+ <title>Changes</title>
+ <p>By maintaining a file called <code>status.xml</code> you can manage a list
+ changes to your code base. This list can then be generated as a changes
+ page and/or an RSS feed of those changes. For example, here are the
+ <a href="changes.html">changes</a> for this plugin, here is the same
+ list of changes as an <a href="changes.rss">RSS feed</a>.</p>
+
+ <p>It's possible to limit the displayed changes to a particular version
+ number as well. For example, here are the changes for
+ <a href="changes_0.1.html">version 0.1</a> of this plugin (and
+ as an <a href="changes_0.1.rss">RSS feed</a>).</p>
+
+ <p>If you want to only retrieve the changes for the most recent version
+ of the project then you can do that too. Here are the changes in the
+ <a href="changes_current.html">current development version</a> of this
+ plugin (and once more as an <a href="changes_current.rss">RSS feed</a>).</p>
+
</section>
<section>
- <title>Producing Release Notes</title>
+ <title>To Do List</title>
+ <p>The status.xml file can also be used to manage a list of todo items for
+ the community. For example, here is a
+ <a href="todo.html">psuedo todo list</a> for this plugin (our real todo list
+ is managed in an Issue Tracker, one day we hope to add support for that
+ here too).</p>
+ </section>
+
+ <section>
+ <title>Release Notes</title>
<p>To produce release notes you must maintain a <code>status.xml</code> file
for your project and request a page with an URL such as
<code>http://domain.com/releaseNotes_0.7-dev.html</code>, this will be produce
@@ -58,8 +78,10 @@
<p>The introductory text in the release notes comes from the (optional)
element <code>notes</code> (a child of the <code>release</code> element).</p>
+
+ <note>The same options with respect to retrieveing specific versions of the
+ release notes are available as with the changes feature (discuseed above).</note>
</section>
-
<section>
<title>Project Details</title>