You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by cr...@apache.org on 2004/09/23 08:06:46 UTC
svn commit: rev 47085 - forrest/trunk/src/documentation/content/xdocs
Author: crossley
Date: Wed Sep 22 23:06:45 2004
New Revision: 47085
Modified:
forrest/trunk/src/documentation/content/xdocs/index.xml
Log:
Start to refine the home page.
Modified: forrest/trunk/src/documentation/content/xdocs/index.xml
==============================================================================
--- forrest/trunk/src/documentation/content/xdocs/index.xml (original)
+++ forrest/trunk/src/documentation/content/xdocs/index.xml Wed Sep 22 23:06:45 2004
@@ -22,7 +22,7 @@
<body>
<section>
<title>Introduction</title>
- <p>Forrest is an XML standards-oriented documentation framework
+ <p>Apache Forrest is an XML standards-oriented 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
@@ -38,23 +38,29 @@
<strong>simple</strong>:
</p>
<ul>
- <li><strong>Step 1</strong>: Type <code>'forrest seed'</code>, to populate
+ <li><strong>Step 1</strong>: Do <code>'forrest seed'</code> to populate
the directory with template site structure and contents.</li>
<li><strong>Step 2</strong>: Add content by editing docs in
task-specific, presentation-neutral XML.</li>
- <li><strong>Step 3</strong>: Type <code>'forrest'</code> to generate a
- complete website from the XML. Various website styles (known as skins)
- are available, and custom skins can be developed.</li>
+ <li><strong>Step 3</strong>: Do <code>'forrest run'</code> then use
+ the web browser to immediately review
+ changes at <code>http://localhost:8888/</code>
+ </li>
+ <li><strong>Step 4</strong>: Do <code>'forrest'</code> to generate the
+ complete website from the XML sources.
+ Various styles (known as skins) are available. Custom skins
+ can be developed.</li>
+ <li><strong>Step 5</strong>: For more information about installation
+ and use, see the
+ <link href="site:your-project">Using Forrest</link> guide.
+ </li>
</ul>
- <note>For more information on Forrest installation and use, see the
- <link href="site:your-project">Using Forrest</link> guide.
- </note>
<p>
Forrest's focus on low "startup cost" makes it ideal for rapid
development of small sites, where time and budget constraints do not
allow time-wasting HTML experiments. Of course, that same methodology
- can be applied to large projects.
- Your development team does not need Java experience or even XML skills,
+ can scale up to large projects.
+ Your development team does not need Java experience, or even XML skills,
to use Forrest. The framework lets you concentrate on content and design.
</p>
<p>
@@ -90,8 +96,8 @@
<link href="ext:fop">Apache FOP</link>).
</li>
<li>SVG to PNG rendering (using <link href="ext:batik">Apache
- Batik</link>); simply drop a SVG in the appropriate directory and it
- will be rendered as PNG.</li>
+ Batik</link>). Simply drop the SVG in the appropriate directory
+ and it will be rendered as PNG.</li>
<li>
Transparent inclusion and aggregation of external content, like
<link href="site:changes-rss">RSS feeds</link>.
@@ -136,7 +142,7 @@
<section>
<title>History</title>
- <p>Forrest was started in January 2002, with the major use-case being to
+ <p>Apache Forrest was started in January 2002, with the major use-case being to
create a consistent and efficient
<link href="http://xml.apache.org/">xml.apache.org</link> group of project
websites with a
@@ -146,7 +152,7 @@
the name 'Forrest').
</p>
<p>
- The focus shifted for Forrest to primarily be a generic documentation
+ The focus shifted for Apache Forrest to primarily be a generic documentation
tool capable of meeting many needs. Certain relevant project management
facilities are being added.
</p>
@@ -154,7 +160,7 @@
<section>
<title>Project Status</title>
- <p>Forrest is currently progressing rapidly through a series of 0.x
+ <p>Apache Forrest is currently progressing rapidly through a series of 0.x
releases. It is certainly usable now (despite not yet being version 1.x).
See the growing list of
<link href="site:live-sites">example sites</link> including
@@ -172,17 +178,17 @@
<section id="website-status">
<title>Website status</title>
<p>
- The documentation on the Forrest website relates to the current
+ The documentation on the Apache Forrest website relates to the current
head development version of the source repository. Whatever version
- of Forrest that you are using provides the local documentation for
+ of Forrest that you are using, will provide the local documentation for
that specific version.
Do '<link href="build.html#run">forrest run</link>'
to view it.
</p>
<p>
- The <link href="ext:forrest">Forrest website</link> is updated
+ The <link href="ext:forrest">Apache Forrest website</link> is updated
manually as needed, while we develop the
- <link href="site:forrestbot">forrestbot</link> facility.
+ <link href="site:forrestbot">forrestbot</link> deployment facility.
<!-- FIXME: It is out-of-date.
which produces the
<link href="http://forrestbot.cocoondev.org/">automatically
@@ -198,17 +204,17 @@
project. We are making good progress towards the 0.6 release
which has many efficiency and usability improvements.
</li>
- <li>Forrest 0.5 was released on 2003-09-13 - much faster, new flexible
- tab and menu system, numerous skin improvements, DocBook support,
- Wiki support, improved PDF output, eased maintenance of sitemaps,
- and more.
+ <li>Apache Forrest 0.5 was released on 2003-09-13 - much faster, new flexible
+ tab and menu system, numerous skin improvements, support for a sub-set
+ of DocBook and Wiki source formats,
+ improved PDF output, eased maintenance of sitemaps, and more.
</li>
</ul>
</section>
<section>
<title>Help Wanted!</title>
<p>
- Forrest is fairly new, and is in need of developers. If you know (or
+ Apache Forrest is fairly new, and is in need of developers. If you know (or
want to learn) XML, Ant, HTML or CSS, then you are qualified to help!
</p>
<p>