You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by cr...@apache.org on 2006/01/05 02:17:33 UTC
svn commit: r366046 - in /forrest/site: docs_0_80/faq.html docs_0_80/faq.pdf
docs_0_80/faq.xml skin/CommonMessages_en_US.xml
Author: crossley
Date: Wed Jan 4 17:17:22 2006
New Revision: 366046
URL: http://svn.apache.org/viewcvs?rev=366046&view=rev
Log:
Automatic publish from forrestbot
Modified:
forrest/site/docs_0_80/faq.html
forrest/site/docs_0_80/faq.pdf
forrest/site/docs_0_80/faq.xml
forrest/site/skin/CommonMessages_en_US.xml
Modified: forrest/site/docs_0_80/faq.html
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/faq.html?rev=366046&r1=366045&r2=366046&view=diff
==============================================================================
--- forrest/site/docs_0_80/faq.html (original)
+++ forrest/site/docs_0_80/faq.html Wed Jan 4 17:17:22 2006
@@ -493,6 +493,9 @@
<li>
<a href="#debugging">3.14. Can I run Forrest with Java debugging turned on?</a>
</li>
+<li>
+<a href="#checksums">3.15. How do I enable Cocoon's document checksum feature?</a>
+</li>
</ul>
</li>
<li>
@@ -1392,9 +1395,43 @@
to the <span class="codefrag">forrest.jvmargs</span> property in the <span class="codefrag">forrest.properties</span>
file. Don't forget to ensure the property is uncommented in that file.</p>
</div>
-<a name="N1042D"></a><a name="old_faqs"></a>
+<a name="N1042D"></a><a name="checksums"></a>
+<h4 class="faq">3.15. How do I enable Cocoon's document checksum feature?</h4>
+<div align="right">
+<a href="#checksums-menu">^</a>
+</div>
+<div style="margin-left: 15px">
+<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>
+ Another reason could be if you are not using the forrestbot to
+ deploy the generated site. Some tools depend on the "date-last-modified"
+ timestamp of the generated files.
+ </p>
+<p>
+ There was some discussion about this on the Forrest developer mailing
+ list:
+ <a href="http://marc.theaimsgroup.com/?l=forrest-dev&s=cocoon+checksum">Cocoon Checksum</a>
+ Specifically note that this feature only stops Cocoon from writing to
+ disk if the new file 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>
+ Locate the <span class="codefrag">checksums-uri</span> tag within cli.xconf and replace
+ the contents with an absolute path and filename for the checksums file.
+ Projects can supply their own (see FAQ:
+ <a href="#cli-xconf">Cocoon cli.xconf</a>) or use the default
+ installation-wide cli.xconf file.
+ </p>
+</div>
+<a name="N10449"></a><a name="old_faqs"></a>
<h3 class="underlined_5">4. Older version: 0.6</h3>
-<a name="N10431"></a><a name="old_claimed_patterns"></a>
+<a name="N1044D"></a><a name="old_claimed_patterns"></a>
<h4 class="faq">4.1. Some of my files are not being processed because they use common filenames. </h4>
<div align="right">
<a href="#old_claimed_patterns-menu">^</a>
@@ -1410,9 +1447,9 @@
with this issue (<a href="http://issues.apache.org/jira/browse/FOR-217">FOR-217</a>).
</p>
</div>
-<a name="N10443"></a><a name="general"></a>
+<a name="N1045F"></a><a name="general"></a>
<h3 class="underlined_5">5. General</h3>
-<a name="N10447"></a><a name="generating_menus"></a>
+<a name="N10463"></a><a name="generating_menus"></a>
<h4 class="faq">5.1. What is the relationship between site.xml and book.xml? </h4>
<div align="right">
<a href="#generating_menus-menu">^</a>
@@ -1426,7 +1463,7 @@
<span class="codefrag">site.xml</span>-generated menus aren't appropriate. See <a href="../docs_0_80/linking.html">Menus and
Linking</a>. </p>
</div>
-<a name="N10462"></a><a name="docbook"></a>
+<a name="N1047E"></a><a name="docbook"></a>
<h4 class="faq">5.2. How do I use DocBook as the XML documentation format? </h4>
<div align="right">
<a href="#docbook-menu">^</a>
@@ -1472,7 +1509,7 @@
different DTDs, then see <a href="../docs_0_80/your-project.html#new_dtd">Using Forrest</a> for
configuration guidance. </p>
</div>
-<a name="N10490"></a><a name="version"></a>
+<a name="N104AC"></a><a name="version"></a>
<h4 class="faq">5.3. How to report which version of Forrest is being used and the properties that are
set? </h4>
<div align="right">
@@ -1485,7 +1522,7 @@
watch the build messages. Doing <span class="codefrag">'forrest -v'</span> will provide verbose build
messages. </p>
</div>
-<a name="N104A4"></a><a name="logs"></a>
+<a name="N104C0"></a><a name="logs"></a>
<h4 class="faq">5.4. Where are the log files to find more infomation about errors? </h4>
<div align="right">
<a href="#logs-menu">^</a>
@@ -1504,7 +1541,7 @@
<p> Doing <span class="codefrag">'forrest -v'</span> will provide verbose build messages to the standard
output. </p>
</div>
-<a name="N104C8"></a><a name="how_can_I_help"></a>
+<a name="N104E4"></a><a name="how_can_I_help"></a>
<h4 class="faq">5.5. How to help? </h4>
<div align="right">
<a href="#how_can_I_help-menu">^</a>
@@ -1515,7 +1552,7 @@
particularly from newcomers—often, close proximity blinds software developers to
faults that are obvious to everyone else. Don't be shy! </p>
</div>
-<a name="N104D4"></a><a name="patch"></a>
+<a name="N104F0"></a><a name="patch"></a>
<h4 class="faq">5.6. How to contribute a patch? </h4>
<div align="right">
<a href="#patch-menu">^</a>
Modified: forrest/site/docs_0_80/faq.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/faq.pdf?rev=366046&r1=366045&r2=366046&view=diff
==============================================================================
Binary files - no diff available.
Modified: forrest/site/docs_0_80/faq.xml
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/faq.xml?rev=366046&r1=366045&r2=366046&view=diff
==============================================================================
--- forrest/site/docs_0_80/faq.xml (original)
+++ forrest/site/docs_0_80/faq.xml Wed Jan 4 17:17:22 2006
@@ -558,6 +558,34 @@
to add <code>-Xdebug -Xrunjdwp:transport=dt_socket,address=8000,server=y,susp end=n</code>
to the <code>forrest.jvmargs</code> property in the <code>forrest.properties</code>
file. Don't forget to ensure the property is uncommented in that file.</p>
+ </section><section id="checksums"><title>3.15. How do I enable Cocoon's document checksum feature?</title>
+ <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>
+ Another reason could be if you are not using the forrestbot to
+ deploy the generated site. Some tools depend on the "date-last-modified"
+ timestamp of the generated files.
+ </p>
+ <p>
+ There was some discussion about this on the Forrest developer mailing
+ list:
+ <link href="http://marc.theaimsgroup.com/?l=forrest-dev&s=cocoon+checksum">Cocoon Checksum</link>
+ Specifically note that this feature only stops Cocoon from writing to
+ disk if the new file 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>
+ Locate the <code>checksums-uri</code> tag within cli.xconf and replace
+ the contents with an absolute path and filename for the checksums file.
+ Projects can supply their own (see FAQ:
+ <link href="#cli-xconf">Cocoon cli.xconf</link>) or use the default
+ installation-wide cli.xconf file.
+ </p>
</section></section><section id="old_faqs"><title>4. Older version: 0.6</title><section id="old_claimed_patterns"><title>4.1. Some of my files are not being processed because they use common filenames. </title>
<p> Certain patterns are claimed by the default sitemaps for special processing. These
include: <code>site, changes, todo, faq, images, my-images, skinconf, community,
Modified: forrest/site/skin/CommonMessages_en_US.xml
URL: http://svn.apache.org/viewcvs/forrest/site/skin/CommonMessages_en_US.xml?rev=366046&r1=366045&r2=366046&view=diff
==============================================================================
--- forrest/site/skin/CommonMessages_en_US.xml (original)
+++ forrest/site/skin/CommonMessages_en_US.xml Wed Jan 4 17:17:22 2006
@@ -19,5 +19,5 @@
<message key="Font size:">Font size:</message>
<message key="Last Published:">Last Published:</message>
<message key="Search">Search</message>
- <message key="Search the site with">Search the site with</message>
+ <message key="Search the site with">Search site with</message>
</catalogue>