| <!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/site/index.html" |
| class="title">Documentation</a> <br br="br"> |
| (run "build site" 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="etc/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://forrestbot.cocoondev.org" |
| class="title">Auto-generated project sites</a> <br br="br"> |
| (online)</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <br> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <br> |
| <h3> 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> What do I do now?</h3> |
| You are using a 'source' distribution of Forrest. You need to first build |
| Forrest, by typing <pre>build.bat</pre> (Windows) or <pre>./build.sh</pre> |
| (Unix). |
| <p> |
| This will create a "shbat" distribution in <pre>build/dist/shbat</pre>, or |
| whever the <pre>dist-shbat.dir</pre> property is set to. You should now add |
| the <pre>build/dist/shbat/bin</pre> directory to your PATH variable. |
| <p> |
| If you have done this correctly, you are now ready to test out Forrest! Here |
| are three things to try: |
| <ol> |
| <li><b>Render the Forrest website</b> -- simply type <pre>forrest</pre> in |
| this (Forrest's source distribution) directory. It should chug along for a |
| good while (Forrest's site is quite large), and render the HTML and PDFs to |
| <pre>build/site</pre>.</li> |
| |
| <li><b>Run a webapp of the Forrest site</b> -- type <pre>forrest run</pre> |
| in this directory. You can then point your browser to <a |
| href="http://localhost:8888/">http://localhost:8888/</a>, and view the |
| Forrest website generated dynamically. Experiment with editing docs in |
| <pre>build/webapp/content/xdocs</pre>, and watch them be (nearly) instantly |
| rendered.</li> |
| |
| <li><b>Generate your own site</b> -- create a new (clean) directory, and |
| type <pre>forrest seed</pre>. This will generate a skeleton directory |
| structure and template XML. If you like, edit the XML in |
| <pre>src/documentation/content/xdocs</pre>. Now type <pre>forrest</pre> to |
| render your new site, or <pre>forrest run</pre> to generate a <a |
| href="http://localhost:8888/">webapp</a>. |
| </li> |
| </ol> |
| <p> |
| For further information, please read our <a |
| href="http://xml.apache.org/forrest/your-project.html">Getting Started</a> |
| guide. If you have any questions or suggestions, please subscribe to the <a |
| href="http://xml.apache.org/forrest/mail-lists.html#forrest-dev">forrest-dev |
| mailing list</a>. |
| <p> |
| Thanks for using Apache Forrest! |
| |
| <hr hr="hr"> Copyright ©2002 Apache Software Foundation. All rights |
| reserved. <br> |
| <br> |
| </body> |
| </html> |
