forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r414098 - /forrest/trunk/site-author/content/xdocs/forrest-contract.xml
Date Wed, 14 Jun 2006 06:12:09 GMT
Author: crossley
Date: Tue Jun 13 23:12:09 2006
New Revision: 414098

URL: http://svn.apache.org/viewvc?rev=414098&view=rev
Log:
Call it Apache Forrest.
Rearrange existing items in "Forrest will" section.
Add another item about providing the plugin framework.
Add to "TheProject can" section:
- Specify other properties (e.g. additional plugins).
- Develop its own additional functionality using plugins.

Modified:
    forrest/trunk/site-author/content/xdocs/forrest-contract.xml

Modified: forrest/trunk/site-author/content/xdocs/forrest-contract.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/forrest-contract.xml?rev=414098&r1=414097&r2=414098&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/forrest-contract.xml (original)
+++ forrest/trunk/site-author/content/xdocs/forrest-contract.xml Tue Jun 13 23:12:09 2006
@@ -28,15 +28,14 @@
       any of the bullets listed here are out of sync with the real
       implementation.</notice>
     <abstract>This document describes, in a very techy bullet-style way, how
-      to use Forrest.</abstract> 
+      to use Apache Forrest.</abstract> 
   </header> 
   <body> 
     <note>
-      This document describes the formal contract between the
-      <strong>Forrest distribution code</strong>, hereafter referred as 
-      "Forrest", and
-      the <strong>Project (team)</strong> that is using it for generating
-      its documentation and  web-site, hereafter referred to as "TheProject".
+      This document describes the formal contract between
+      <strong>Apache Forrest</strong> and
+      the <strong>Project (your development team)</strong> that is using it for
generating
+      its documentation, hereafter referred to as "TheProject".
     </note>
     <note>
       Some terminology will assist: <code>{docroot}</code> is the location
@@ -46,17 +45,19 @@
     </note> 
 
     <section id="forrest-will"> 
-      <title>Forrest will:</title> 
+      <title>Apache Forrest will:</title> 
       <p>Provide infrastructure ...</p>
       <ul> 
-        <li>Provide document type definitions (DTDs), skins, default sitemaps,
-         Cocoon pipelines.
+        <li>Use Apache Cocoon to generate the HTML and PDF documentation for
+          TheProject.</li> 
+        <li>Provide default Cocoon sitemaps, Cocoon pipelines, skins and other
+         theme abilities, document type definitions (DTDs) and other appropriate schema.
         </li>
-        <li>Provide a willing team of supporting developers at the forrest-dev
-          <link href="site:mail-lists">mail list</link>.
+        <li>Provide a framework for plugins and various input/output capabilities as
plugins.
+        </li>
+        <li>Provide a willing group of supporting developers at the
+          <link href="site:mail-lists">mail lists</link>.
         </li>
-        <li>Use Cocoon to generate the HTML and PDF documentation for
-          TheProject.</li> 
       </ul>
     </section>
 
@@ -65,7 +66,7 @@
       <p>Provide content and configuration ...</p>
       <ul> 
         <li>Provide XML content in <code>{docroot}/content/xdocs</code>
-          according to the Forrest DTDs or one of the other input formats.
+          according to the Forrest DTDs, or one of the other input formats.
         </li> 
         <li>Provide navigation metadata using the configuration files
           <code>site.xml</code> and <code>tabs.xml</code>
@@ -80,6 +81,8 @@
       <title>TheProject can:</title> 
       <p>Add extra abilities ...</p>
       <ul> 
+        <li>Specify other properties (e.g. additional plugins) in 
+          <code>{docroot}/forrest.properties</code></li>
         <li>Provide its own skin in
           <code>{docroot}/skins/{your-skin-name}</code> (Check the current
           Forrest skins and the related pipelines to see what they are doing.
@@ -97,8 +100,10 @@
         <li>Provide its own overwriting versions of sitemaps
           (<code>{docroot}/sitemap.xmap</code> and other *.xmap files)
           ... (be sure you know what you are doing since you are then leaving
-          the area where other Forresters can help you out.
+          the area where other people can help you out.
         </li> 
+        <li>Develop its own additional functionality using plugins.
+        </li>
       </ul> 
     </section> 
   </body>



Mime
View raw message