| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <!-- |
| Copyright 2002-2004 The Apache Software Foundation |
| |
| Licensed under the Apache License, Version 2.0 (the "License"); |
| you may not use this file except in compliance with the License. |
| You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <!-- |
| Please note that this HTML file was _not_ created by Forrest. |
| --> |
| <html> |
| <head> |
| <title>Apache Forrest</title> |
| </head> |
| |
| <body> |
| <img src="src/documentation/resources/images/group-logo.gif" alt="xml-apache" /> |
| <img src="src/documentation/resources/images/project-logo.gif" alt="forrest" /> |
| <br /> |
| ><a href="http://www.apache.org/" class="title">Apache</a> |
| ><a href="http://xml.apache.org/" class="title">Xml</a> |
| ><a href="http://xml.apache.org/forrest/" class="title">Forrest</a> |
| |
| <hr /> |
| |
| <h2>What is this?</h2> |
| <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> |
| |
| <h2>What do I do now?</h2> |
| <p>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> |
| |
| <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> |
| |
| <p>If you have done this correctly, you are now ready to test out Forrest! |
| Here are three things to try.</p> |
| |
| <h3>Render the Forrest website</h3> |
| <p>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></p> |
| |
| <h3>Run a webapp of the Forrest site</h3> |
| <p>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.</p> |
| |
| <h3>Generate your own site</h3> |
| <p>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>.</p> |
| |
| <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> |
| |
| <p>Thanks for using Apache Forrest!</p> |
| |
| <hr hr="hr" /> |
| |
| <p>Copyright 2002-2003 Apache Software Foundation. All rights reserved.</p></body> |
| </html> |
| |
