Apache Forrest

status.xml
(status of the project and community)
module.xml
(extended Gump descriptor of the software module)
build.xml
(main build file)
properties.xml
(properties used for building the project)

Documentation
(run "build docs" first)
Javadocs
(run "build javadocs" first)
Unit test results
(run "build test" first)
Code metrics
(run "build metrics" first)
Local build number
(how many builds have been done locally)

Project Site
(online)
Krysalis Centipede build system site
(online)

What is this?

Forrest is an XML standards-oriented project documentation framework based on Apache Cocoon, providing XSLT stylesheets and schemas, images and other resources. Forrest uses these to render the XML source content into a website via command-line, robot, or a dynamic web application.

Why?

If you ever participated in ASF open development you know why: there is always
the feeling that you are left on your own, that each project, effort,
community mail list and invidual has to struggle to keep up with the others
and to keep coherence.

This effort was started by those who believe that a better and more coherent
technical infrastructure is a first step in the right direction.

Ok, better infrastructure, what what do you mean exactly?

Ever seen 'sourceforge'? ok, than you know what a technological
insfrastructure for open development is. Ever seen Mozilla's 'tinkerbox' and
'bonsai'? ok, then you know what we mean for 'helping tools'.

Take all the wishes/dreams that you ever had when you were participating in
an OSS community... well, we want Forrest to make them possible.

Why the name 'Forrest'?

Oh, long story, but mainly out of the movie 'Forrest Gump', mostly
to indicate that even dumb and simple things can go a long way when done
by heart.

What will Forrest do?

The first development phase will bring:

   - a publishing system for documentation
   - analysis of logs and publishing of results

Later phases will be decided after we reach this minimum functionality.

Will I be able to use Forrest on my own sites?

We do Forrest for our own stuff, but there is no reason why we should
restrict its use on external and unreleated sites.

What will the license be?

The entire thing will be licensed with the Apache License. See the /legal
directory for more information.

Getting started

After you have downloaded the xml-forrest source, you can build the main
Forrest documentation ...

        UNIX:     ./build.sh docs
        Windows: build docs

The HTML documents are then generated in ./build/xml-forrest/docs/

Can I help?

Of course! We need you! Even your wish-list is a good way of contributing...
so please, send email to

    forrest-dev-subscribe@xml.apache.org

and join us!

                                           The Apache XML Project
                                           http://xml.apache.org/