forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: rev 43433 - forrest/trunk/src/documentation/content/xdocs/docs
Date Mon, 06 Sep 2004 23:32:58 GMT
Author: crossley
Date: Mon Sep  6 16:32:57 2004
New Revision: 43433

Modified:
   forrest/trunk/src/documentation/content/xdocs/docs/project-sitemap.xml
Log:
Re-formatting only. Make "How it works" and "Example uses" a top-level section.


Modified: forrest/trunk/src/documentation/content/xdocs/docs/project-sitemap.xml
==============================================================================
--- forrest/trunk/src/documentation/content/xdocs/docs/project-sitemap.xml	(original)
+++ forrest/trunk/src/documentation/content/xdocs/docs/project-sitemap.xml	Mon Sep  6 16:32:57
2004
@@ -26,44 +26,49 @@
       <p>With Forrest 0.6 it's now possible for projects to "plugin" 
       to our sitemaps without having to copy stuff; this will make possible 
       hassle-free update fo future Forrest versions.</p>
+    </section>
 
-      <section>
-        <title>How does it work?</title>
+    <section>
+      <title>How does it work?</title>
 
-        <p>If a project has a <code>sitemap.xmap</code> file in it's 
-        documentation dir, it gets mounted automatically by Forrest and 
-        it becomes part of the processing: it's a preprocessing step, and 
-        it's the first one to handle the request. Because of this it can 
-        serve any file directly instead of Forrest: if it doesn't want to 
-        serve a file, it can simply not match the URL and Forrest will take 
-        care of it as usual.</p>
-
-        <p>The cool thing is that if that pipeline serves an xml representation, 
-        Forrest will provide a skinned version of it.</p>
-
-        <p>So if the project sitemap matches test.xml, and serves a correct 
-        documentDTD file, then the user will see test.html fully rendered by 
-        Forrest.</p>
-
-        <p>Of course, to resolve the directories in your sitemap it's important 
-        to use the 'project:' and 'forrest:' variables, to prevent any possible 
-        issue in the future.</p>
-      </section>
+      <p>If a project has a <code>sitemap.xmap</code> file in it's 
+      documentation dir, it gets mounted automatically by Forrest and 
+      it becomes part of the processing: it's a preprocessing step, and 
+      it's the first one to handle the request. Because of this it can 
+      serve any file directly instead of Forrest: if it doesn't want to 
+      serve a file, it can simply not match the URL and Forrest will take 
+      care of it as usual.</p>
+
+      <p>The cool thing is that if that pipeline serves an xml representation, 
+      Forrest will provide a skinned version of it.</p>
+
+      <p>So if the project sitemap matches test.xml, and serves a correct 
+      documentDTD file, then the user will see test.html fully rendered by 
+      Forrest.</p>
+
+      <p>Of course, to resolve the directories in your sitemap it's important 
+      to use the 'project:' and 'forrest:' variables, to prevent any possible 
+      issue in the future.</p>
     </section>
     
     <section>
-      <title>Generating site.xml and tabs.xml</title>
-      <p>If you are using some other content packaging technique, such as
-      IMS Content Packages, you will want to generate the site.xml and tabs.xml
-      files from your content package. This can be done by creating custom
-      versions of <code>linkmap.xmap</code>, <code>menu.xmap</code>
and
-      <code>tabs.xmap</code> in your project directory.</p>
-      
-      <p>As will custom sitemaps (see above) Forrest will automatically detect
-      the presence of a customised version of any of these files and will
-      use them appropriately. These files act as a preprocessor stage and
-      any unhandled matches will be processed by the normal Forrest Xmap files.
-      </p>
+      <title>Example uses of this technique</title>
+      <p>Here are some examples ...</p>
+
+      <section>
+        <title>Generating site.xml and tabs.xml</title>
+        <p>If you are using some other content packaging technique, such as
+        IMS Content Packages, you will want to generate the site.xml and tabs.xml
+        files from your content package. This can be done by creating custom
+        versions of <code>linkmap.xmap</code>, <code>menu.xmap</code>
and
+        <code>tabs.xmap</code> in your project directory.</p>
+
+        <p>As will custom sitemaps (see above) Forrest will automatically detect
+        the presence of a customised version of any of these files and will
+        use them appropriately. These files act as a preprocessor stage and
+        any unhandled matches will be processed by the normal Forrest Xmap files.
+        </p>
+      </section>
     </section>
   </body>
 </document>

Mime
View raw message