svn commit: r366030 - /forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml

[cr...@apache.org]

Author: crossley
Date: Wed Jan  4 15:37:10 2006
New Revision: 366030

URL: http://svn.apache.org/viewcvs?rev=366030&view=rev
Log:
Issue: FOR-778 "Addition of Enabling Cocoon Checksum FAQ"
Contributed by: Paul Kronenwetter

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

Modified: forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml?rev=366030&r1=366029&r2=366030&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml Wed Jan  4 15:37:10 2006
@@ -756,6 +756,44 @@
         file. Don't forget to ensure the property is uncommented in that file.</p>
       </answer>
     </faq>
+    <faq id="checksums">
+      <question>How do I enable Cocoon's document checksum feature?</question>
+      <answer>
+        <p>
+        Why might you want to do this?  There is really no effect
+        on Cocoon processing, but a little time can be
+        saved on filesystem writes, which will accumulate
+        to a big savings for a site with thousands of files.
+        </p>
+        <p>
+        There was some discussion about this on the Forrest developer mailing
+        list.  An archive of these discussions can be found here:
+        <link href="http://marc.theaimsgroup.com/?l=forrest-dev&amp;s=cocoon+checksum">Cocoon Checksum</link> 
+        Specifically note that this feature only stops Cocoon from writing to 
+        disk that which is the same as the existing file.  Cocoon still spends
+        the same amount of time generating the content as it would if checksums
+        were not enabled.
+        </p>
+        <p>
+        There are two steps required to enable checksums within Cocoon and 
+        Forrest.  The first is to add this line to your forrest.properties
+        file: 
+        <code>project.configfile=${project.home}/src/documentation/conf/cli.xconf</code>
+        </p>
+        <p>
+        The second is to copy a template of this file from the Forrest
+        tree under <code>main/site-author/conf/cli.xconf</code> to the
+        <code>src/documentation/conf</code> directory.
+        </p>
+        <p>
+        An optional last step is to edit the cli.xconf file to specify
+        the directory where the checksums file will be stored.  By default this
+        file is stored in the forrest tree and not in your site's tree. 
+        Locate the <code>checksums-uri</code> tag within cli.xconf and replace
+        the contents with an absolute path and filename for the checksums file.
+        </p>
+      </answer>
+    </faq>
   </part>
   <part id="old_faqs">
     <title>Older version: 0.6</title>