blob: f678a24d1305dc0217cdf0c9f2f525383bc1179f [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- FIXME:
Please note that this HTML mess was *NOT* created by Forrest.
It is a hack document from someone's webpage editor, and will be tidy soon.
-->
<html>
<head>
<title>Apache Forrest</title>
<style type="text/css">
body { color: #000000;
background-color: #ffffff; }
a:active { color: #ff0000; }
a:visited { color: #551a8b; }
a:link { color: #0000bb; }
a.title { font-weight: bold; font-size: 110%; }
h1, h2, h3, h4, h5, h6 { font-family: avantgarde, sans-serif;
font-weight: bold }
h1 { font-size: 180% }
h2 { font-size: 150% }
h3, h4 { font-size: 120% }
ul { margin-left: 1em; padding: 0pt; border: 0pt; }
</style>
</head>
<body>
<table align="center" height="40" width="100%" cellpadding="0"
cellspacing="2">
<tbody>
<tr>
<td><img src="src/documentation/resources/images/group-logo.gif"
alt="xml-apache" style="width: 220px; height: 65px;">
</td>
<td align="center" width="100%">
<h1> </h1>
<h1>Apache Forrest</h1>
<h1> </h1>
</td>
<td><img src="src/documentation/resources/images/project-logo.gif"
alt="forrest" style="width: 220px; height: 65px;">
</td>
</tr>
</tbody>
</table>
<table cellpadding="2" cellspacing="2" border="1"
style="text-align: left;" width="100%">
<tbody>
<tr>
<td valign="top">
<table align="center">
<tbody>
<tr>
<td>
<ul>
<li> <a
href="status.xml"
class="title">status.xml</a> <br br="br">
(status of the project and community)</li>
<li> <a
href="module.xml"
class="title">module.xml</a> <br br="br">
(extended Gump descriptor of the software module)</li>
<li> <a
href="build.xml"
class="title">build.xml</a> <br br="br">
(main build file)</li>
<li> <a
href="properties.xml"
class="title">properties.xml</a> <br br="br">
(properties used for building the project)</li>
</ul>
</td>
<td valign="top">
<ul>
<li> <a
href="build/docs/index.html"
class="title">Documentation</a> <br br="br">
(run "build docs" first)</li>
<li> <a
href="build/docs/javadocs/index.html"
class="title">Javadocs</a> <br br="br">
(run "build javadocs" first)</li>
<li> <a
href="build/docs/tests/junit/index.html"
class="title">Unit test results</a> <br br="br">
(run "build test" first)</li>
<li> <a
href="build/docs/metrics/jdepend/index.html"
class="title">Code metrics</a> <br br="br">
(run "build metrics" first)</li>
<li> <a
href="build.number"
class="title">Local build number</a> <br br="br">
(how many builds have been done locally)</li>
</ul>
</td>
<td>
<ul>
<li> <a href="http://xml.apache.org/forrest/"
class="title">Project Site</a> <br br="br">
(online)</li>
<li> <a href="http://www.krysalis.org/centipede/"
class="title">Krysalis Centipede build system site</a> <br
br="br">
(online)</li>
</ul>
</td>
</tr>
</tbody>
</table>
<br>
</td>
</tr>
</tbody>
</table>
<br>
<h3>&nbsp; What is this?</h3>
<p>
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.
</p>
<h3>&nbsp; Why?</h3>
&nbsp; If you ever participated in ASF open development you know why: there
is always<br>
&nbsp; the feeling that you are left on your own, that each project, effort,
<br>
&nbsp; community mail list and invidual has to struggle to keep up with the
others <br>
&nbsp; and to keep coherence.<br>
&nbsp; <br>
&nbsp; This effort was started by those who believe that a better and more
coherent<br>
&nbsp; technical infrastructure is a first step in the right direction.<br>
&nbsp; <br>
&nbsp; <br>
<h3>&nbsp; Ok, better infrastructure, what what do you mean exactly?</h3>
&nbsp; Ever seen 'sourceforge'? ok, than you know what a technological <br>
&nbsp; insfrastructure for open development is. Ever seen Mozilla's 'tinkerbox'
and <br>
&nbsp; 'bonsai'? ok, then you know what we mean for 'helping tools'.<br>
&nbsp; <br>
&nbsp; Take all the wishes/dreams that you ever had when you were participating
in<br>
&nbsp; an OSS community... well, we want Forrest to make them possible.<br>
&nbsp; <br>
<br>
<h3>&nbsp; Why the name 'Forrest'?</h3>
&nbsp; Oh, long story, but mainly out of the movie 'Forrest Gump', mostly<br>
&nbsp; to indicate that even dumb and simple things can go a long way when
done <br>
&nbsp; by heart.&nbsp; <br>
<br>
<br>
<h3>&nbsp; What will Forrest do?</h3>
&nbsp; The first development phase will bring:<br>
&nbsp; <br>
&nbsp;&nbsp; - a publishing system for documentation<br>
&nbsp;&nbsp; - analysis of logs and publishing of results<br>
&nbsp;&nbsp; <br>
&nbsp; Later phases will be decided after we reach this minimum functionality.<br>
<br>
&nbsp;<br>
<h3>&nbsp; Will I be able to use Forrest on my own sites?</h3>
&nbsp; We do Forrest for our own stuff, but there is no reason why we should<br>
&nbsp; restrict its use on external and unreleated sites.<br>
&nbsp; <br>
&nbsp; <br>
<h3>&nbsp; What will the license be?</h3>
&nbsp; The entire thing will be licensed with the Apache License. See the
/legal<br>
&nbsp; directory for more information.<br>
&nbsp; <br>
<br>
<h3>&nbsp; Getting started</h3>
&nbsp; After you have downloaded the xml-forrest source, you can build the
main<br>
&nbsp; Forrest documentation ...<br>
&nbsp; <br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; UNIX:&nbsp;&nbsp;&nbsp;&nbsp;
./build.sh docs <br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Windows:&nbsp; build docs<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br>
&nbsp; The HTML documents are then generated in ./build/xml-forrest/docs/<br>
<br>
&nbsp; <br>
<h3>&nbsp; Can I help?</h3>
&nbsp; Of course! We need you! Even your wish-list is a good way of contributing...<br>
&nbsp; so please, send email to <br>
&nbsp; <br>
&nbsp;&nbsp;&nbsp; forrest-dev-subscribe@xml.apache.org<br>
&nbsp;&nbsp;&nbsp; <br>
&nbsp; and join us!<br>
<br>
<br style="font-weight: bold;">
<span style="font-weight: bold;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
The Apache XML Project</span><br style="font-weight: bold;">
<span style="font-weight: bold;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
http://xml.apache.org/</span><br>
<br>
<br>
<br>
<address> </address>
<hr hr="hr"> Copyright &copy;2002 Apache Software Foundation. All rights
reserved. <br>
<br>
</body>
</html>