forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: rev 51862 - forrest/trunk/src/documentation/content/xdocs/docs
Date Mon, 04 Oct 2004 03:14:32 GMT
Author: crossley
Date: Sun Oct  3 20:14:32 2004
New Revision: 51862

Modified:
   forrest/trunk/src/documentation/content/xdocs/docs/sitemap-ref.xml
Log:
Add Note that they should understand Cocoon sitemaps.
Refer to the "Project sitemaps" doc.


Modified: forrest/trunk/src/documentation/content/xdocs/docs/sitemap-ref.xml
==============================================================================
--- forrest/trunk/src/documentation/content/xdocs/docs/sitemap-ref.xml	(original)
+++ forrest/trunk/src/documentation/content/xdocs/docs/sitemap-ref.xml	Sun Oct  3 20:14:32
2004
@@ -33,26 +33,42 @@
       is constructed.  Understanding the sitemap is the key to understanding
       Forrest.
     </p>
+    <note>
+      We advise you to spend time to understand the Apache Cocoon sitemap.
+      See <link href="ext:cocoon/sitemap">Cocoon sitemap</link>
+      and <link href="ext:cocoon/concepts">Cocoon concepts</link>
+      and related component documentation.
+      The Forrest sitemap is broken into multiple files. The main one is
+      <strong>sitemap.xmap</strong> which delegates to others.
+    </note>
     <p>
-      The Cocoon sitemap syntax is documented fully 
-      <link href="site:cocoon/sitemap">in Cocoon's documentation</link>.  This
page
-      provides an overview of the sitemap we have written for Forrest.
+      This document provides an overview of the special sitemap which
+      is used at the core of Apache Forrest.
     </p>
+
     <section id="getting_started">
       <title>Getting started</title>
       <p>
-        If you have a binary distribution, Forrest's sitemap comprises the
-        $FORREST_HOME/context/*.xmap files.  Projects may override these files
-        by copying them into the project's src/documentation/ directory.
+        Forrest's sitemap comprises the $FORREST_HOME/context/*.xmap files.
+      </p>
+
+      <p>
+        You can add pre-processing sitemaps to your project
+        <code>src/documentation</code> directory (or wherever
+        <code>${project.sitemap-dir}</code> points to). Any match that
+        is not handled, passes through to be handled by the default Forrest
+        sitemaps - obviously extremely powerful. The capability is described
+        in 
+        "<link href="site:project-sitemap">Using project sitemaps</link>".
       </p>
+
       <p>
-        The best way to experiment with the sitemap is to do '<code>forrest
-          run</code>' on a Forrest-using site.  Changes to the
+        Another way to experiment with the sitemap is to do '<code>forrest
+        run</code>' on a Forrest-using site.  Changes to the core
         <code>*.xmap</code> files will now be immediately visible
         at <code>>http://localhost:8888/</code>
       </p>
     </section>
-
 
     <section id="overview">
       <title>Sitemap Overview</title>

Mime
View raw message