Author: crossley Date: Fri Apr 6 01:00:22 2007 New Revision: 526085 URL: http://svn.apache.org/viewvc?view=rev&rev=526085 Log: Whitespace changes only, using xmlformat. Modified: forrest/trunk/index.html Modified: forrest/trunk/index.html URL: http://svn.apache.org/viewvc/forrest/trunk/index.html?view=diff&rev=526085&r1=526084&r2=526085 ============================================================================== --- forrest/trunk/index.html (original) +++ forrest/trunk/index.html Fri Apr 6 01:00:22 2007 @@ -19,104 +19,97 @@ Please note that this HTML file was _not_ created by Forrest. --> - - Apache Forrest - quick start - - - - forrest -
- Apache + + Apache Forrest - quick start + + + forrest +
Apache >XML >Forrest - -
- -

What is this?

-

- Apache Forrest is a publishing framework that transforms - input from various sources into a unified presentation - in one or more output formats. The modular and extensible - plugin architecture is based on Apache Cocoon and relevant - standards, which separates presentation from content. - Forrest can generate static documents, or be used as a - dynamic server, or be deployed by its automated facility. -

- -

What do I do now?

-

Apache Forrest requires that Java 1.4 (or newer) be installed on your system. - If you need help with that, then see the Forrest FAQ. Basically, - if you are only going to use Forrest as-is then you need only the - Java Runtime Environment (JRE) and if you intend to enhance and rebuild - Forrest then you need the full JDK. -

-

With a downloaded distribution, Forrest is already built. Just set the - environment variables for convenience: FORREST_HOME to refer to this - top-level of the distribution - and add FORREST_HOME/bin to your PATH. That is it, ready. -

-

The source code is also provided, so you can alter it or extend it, - and then re-build by doing - 'cd main; build.bat clean; build.bat' (Windows) - or 'cd main; ./build.sh clean; ./build.sh' (Unix). - If you need more instructions, then see the +


+

What is this?

+

+ Apache Forrest is a publishing framework that transforms input from + various sources into a unified presentation in one or more output formats. + The modular and extensible plugin architecture is based on Apache Cocoon + and relevant standards, which separates presentation from content. Forrest + can generate static documents, or be used as a dynamic server, or be + deployed by its automated facility. +

+

What do I do now?

+

+ Apache Forrest requires that Java 1.4 (or newer) be installed on your + system. If you need help with that, then see the Forrest FAQ. Basically, + if you are only going to use Forrest as-is then you need only the Java + Runtime Environment (JRE) and if you intend to enhance and rebuild Forrest + then you need the full JDK. +

+

+ With a downloaded distribution, Forrest is already built. Just set the + environment variables for convenience: FORREST_HOME to refer to this + top-level of the distribution and add FORREST_HOME/bin to your PATH. That + is it, ready. +

+

+ The source code is also provided, so you can alter it or extend it, and + then re-build by doing 'cd main; build.bat clean; build.bat' + (Windows) or 'cd main; ./build.sh clean; ./build.sh' (Unix). If + you need more instructions, then see the Building Forrest document. -

- -

Forrest is ready to go! Here are some things to try ...

- +

+

+ Forrest is ready to go! Here are some things to try ... +

Run a webapp of the Apache Forrest documentation

-

Type 'forrest run' in the site-author directory. - You can then point your browser to - http://localhost:8888/ - and view the Forrest documentation generated dynamically. - To stop Apache Forrest just press Ctrl+C. -

- -

Render the Forrest core documentation

-

Simply type 'forrest' in the - site-author directory. This will render all of the HTML - and PDFs for the Forrest - documentation into the - build/site/ directory. - Point your web browser to the index.html file there. -

- -

Generate your own site

-

Create a new (empty) directory in your home space, cd to it, and type - 'forrest seed' - which will generate a skeleton directory structure and template XML. - If you like, edit the XML in the - src/documentation/content/xdocs/ directory. - Now type 'forrest' to render your new site, - or 'forrest run' - to generate a webapp then - experiment with editing docs in - src/documentation/content/xdocs/ and watch them be - instantly rendered. -

- -

Further information

- -

- Type 'forrest -projecthelp' to list the available Forrest commands. - NOTE: use the 'forrest.bat' version when running under Cygwin! -

- -

Your distribution has a copy of the Apache Forrest core documentation. - Refer to the online or SVN version for the up-to-date documentation. -

- -

For further information please read the - Using Forrest - guide. If you have any questions or suggestions, please subscribe to the - Forrest mailing lists.

- -

Thanks for using Apache Forrest.

- -
- -

Copyright 2002-2005 Apache Software Foundation. All rights reserved.

+

+ Type 'forrest run' in the site-author directory. You + can then point your browser to + http://localhost:8888/ and view the + Forrest documentation generated dynamically. To stop Apache Forrest just + press Ctrl+C. +

+

Render the Forrest core documentation

+

+ Simply type 'forrest' in the site-author directory. + This will render all of the HTML and PDFs for the Forrest documentation + into the build/site/ directory. Point your web browser to the + index.html file there. +

+

Generate your own site

+

+ Create a new (empty) directory in your home space, cd to it, and type + 'forrest seed' which will generate a skeleton directory structure + and template XML. If you like, edit the XML in the + src/documentation/content/xdocs/ directory. Now type + 'forrest' to render your new site, or 'forrest run' to + generate a webapp then experiment + with editing docs in src/documentation/content/xdocs/ and watch + them be instantly rendered. +

+

Further information

+

+ Type 'forrest -projecthelp' to list the available Forrest commands. NOTE: + use the 'forrest.bat' version when running under Cygwin! +

+

+ Your distribution has a copy of the Apache Forrest core documentation. + Refer to the online or SVN version for the up-to-date documentation. +

+

+ For further information please read the + Using Forrest + guide. If you have any questions or suggestions, please subscribe to the + Forrest mailing + lists. +

+

+ Thanks for using Apache Forrest. +

+
+

+ Copyright 2002-2005 Apache Software Foundation. All rights reserved. +