svn commit: rev 45945 - forrest/trunk/src/documentation/content/xdocs/docs

[rg...@apache.org]

Author: rgardler
Date: Sun Sep 12 18:40:47 2004
New Revision: 45945

Modified:
   forrest/trunk/src/documentation/content/xdocs/docs/upgrading_06.xml
Log:
expanding an what needs to be done for new project sitemap.xmap functionlality

Modified: forrest/trunk/src/documentation/content/xdocs/docs/upgrading_06.xml
==============================================================================
--- forrest/trunk/src/documentation/content/xdocs/docs/upgrading_06.xml	(original)
+++ forrest/trunk/src/documentation/content/xdocs/docs/upgrading_06.xml	Sun Sep 12 18:40:47 2004
@@ -102,22 +102,41 @@
     <section id="sitemap">
       <title>Sitemap</title>
       <p>
-        If your old project did not use its own sitemap, then your upgrade
-        process will be easy. If you did use your own sitemap, then you will
-        need to be prepared to make some changes. Hopefully with the new
-        functionality of Forrest, you can do away with it and just use the
-        Forrest default sitemaps.
-      </p>
-      <p>
-        If you have your own matchers for handling special circumstances
-        (for example special doctypes that you were handling), then you will 
-        need to make some changes to your sitemaps. However, you will be pleased
-        to know that the mechanism for extending Forrest is greatly improved in 
-        version 0.6 and this will be the last time you will need to make
-        changes to the sitemap when upgrading. 
-        See <link href="site:project-sitemap">Using project sitemaps</link>
-        for details.
-      </p>
+        If your old project did not use any customised <code>*.xmap</code> 
+        files, then your upgrade process will be easy (you can safely skip this
+        section).</p>
+        
+      <p>If your project did use custom <code>*.xmaps</code>, with matchers for 
+        special circumstances (for example special doctypes that you 
+        were handling) then you will need to be prepared to make some changes. 
+        Hopefully with the new functionality of Forrest, you can do away with 
+        your customisations altogether and just use the Forrest default 
+        sitemaps, if not read on...</p>
+        
+      <p>Prior to 0.6 it was possible to replace *any* of the xmaps by placing 
+      your own versions in your project directory, these were then copied over 
+      the Forrest ones at build time. However, with the move to 
+      <link href="#copyless">copyless</link> this no longer happens, instead 
+      there is now an extension mechanism for the sitemap (as opposed to 
+      a replacement mechanism).</p>
+      
+      <p>When upgrading to Forrest 0.6 you need to copy customised matchers 
+      in any of your projects <code>*.xmap</code> files into your projects 
+      <code>sitemap.xmap</code> file. Any matchers in your project 
+      <code>*.xmap</code> files that duplicate ones in Forrests own 
+      <code>*.xmaps</code> can now be removed. This will ensure that future 
+      enhancements to these matchers in Forrest will automatically be included 
+      in your project.</p>
+      
+      <p>The good news is that this process makes upgrading to future versions
+      of Forrest much simpler since your project <code>*.xmap</code> files will 
+      only contain your customisations. As a result there will no longer be a
+      need to merge your custom xmaps with the updated ones in new versions of 
+      Forrest.</p>
+      
+      <p>See <link href="site:project-sitemap">Using project 
+      sitemaps</link> for more details.</p>
+        
     </section>
 
     <section id="skin-config-1">