Mailing List Archive: Forrest: User

Tracking changes on my project

Index | Next | Previous | View Threaded

dashmz at web

Aug 17, 2007, 1:10 AM

Post #1 of 2 (124 views)
Permalink

Tracking changes on my project

Hello,
I am responsible for the documentation of a new software project and of
course I am using Apache Forrest for it. Now I am looking for a special
feature: Is there a way to track the changes between different versions
of the documentation? So that the all people who are involved in the
project can easily look up what has changed since the last release.

Because of the words "changes", "relased" etc. I unfortunately did not
get any good search results.

Greetings,
Rainer Hihn

rgardler at apache

Aug 17, 2007, 2:30 AM

Post #2 of 2 (122 views)
Permalink

Re: Tracking changes on my project [In reply to]

dashmz wrote:
> Hello,
> I am responsible for the documentation of a new software project and of
> course I am using Apache Forrest for it. Now I am looking for a special
> feature: Is there a way to track the changes between different versions
> of the documentation? So that the all people who are involved in the
> project can easily look up what has changed since the last release.

No. there is the projectInfo plugin that generates changes lists:

Manual tracking:
http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/docs/user/useCases/changeLogFeatures.html

Automated tracking: some support of changelog from SVN -
http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/index.html#SVN+Changes

There is no support for displaying diffs between documents. This could
be easily achieved though. Install something like viewSVN and have
Forrest retrieve the diff rendering from there and skin it
appropriately. If you want to go this route we can help guide you here.

Alternatively you could write a generator (but look to see if Cocoon has
one already) and use that, via a plugin, to create your diffs and render
them. If you want to go this route, the join us on the dev list.

Ross

Index | Next | Previous | View Threaded

Interested in having your list archived? Contact Gossamer Threads