From 9022294b8e553ddc76aad6e0190f214e207f8e8e Mon Sep 17 00:00:00 2001
From: David Cramer <david@thingbag.net>
Date: Mon, 9 Aug 2010 03:30:45 +0000
Subject: [PATCH] Adding callouts to explain .htaccess recommendations. Added
 one more future feature idea.

---
 xsl/webhelp/docsrc/readme.xml | 42 ++++++++++++++++++++++++++++++-----
 1 file changed, 36 insertions(+), 6 deletions(-)

diff --git a/xsl/webhelp/docsrc/readme.xml b/xsl/webhelp/docsrc/readme.xml
index 52f97811a..e0c6c08bf 100755
--- a/xsl/webhelp/docsrc/readme.xml
+++ b/xsl/webhelp/docsrc/readme.xml
@@ -341,6 +341,12 @@
           so that when a property is set, the build generates a pdf version of
           the document and includes a link to it from the header.</para>
         </listitem>
+
+        <listitem>
+          <para>Add <ulink
+          url="http://www.comparenetworks.com/developers/jqueryplugins/jbreadcrumb.html">breadcrumbs</ulink>
+          so the user will know what topics he's been to.</para>
+        </listitem>
       </itemizedlist></para>
   </chapter>
 
@@ -432,7 +438,7 @@
           <filename>saxon.jar</filename> in <xref
           linkend="edit-build-properties" /> below.<important>
               <para>Saxon 6.5 must not be in your <envar>CLASSPATH</envar>
-              when you generate webhelp. </para>
+              when you generate webhelp.</para>
             </important></para>
         </step>
 
@@ -658,10 +664,12 @@ indexer-language=en
         recommend you make the following additions or changes to your
         <filename>httpd.conf</filename> or <filename>.htaccess</filename>
         file. <remark>TODO: Explain what each thing
-        does.</remark><programlisting>AddDefaultCharSet UTF-8
+        does.</remark><programlisting>AddDefaultCharSet UTF-8 # <co
+              id="AddDefaultCharSet" />
 
 # 480 weeks
-&lt;FilesMatch "\.(ico|pdf|flv|jpg|jpeg|png|gif|js|css|swf)$"&gt;
+&lt;FilesMatch "\.(ico|pdf|flv|jpg|jpeg|png|gif|js|css|swf)$"&gt; # <co
+              id="CachingSettings" />
 Header set Cache-Control "max-age=290304000, public"
 &lt;/FilesMatch&gt;
 
@@ -676,7 +684,7 @@ Header set Cache-Control "max-age=7200, must-revalidate"
 &lt;/FilesMatch&gt;
 
 # compress text, html, javascript, css, xml:
-AddOutputFilterByType DEFLATE text/plain
+AddOutputFilterByType DEFLATE text/plain # <co id="CompressSetting" />
 AddOutputFilterByType DEFLATE text/html
 AddOutputFilterByType DEFLATE text/xml
 AddOutputFilterByType DEFLATE text/css
@@ -687,10 +695,32 @@ AddOutputFilterByType DEFLATE application/javascript
 AddOutputFilterByType DEFLATE application/x-javascript
 
 # Or, compress certain file types by extension:
-&lt;Files *.html&gt;
+&lt;Files *.html&gt; 
 SetOutputFilter DEFLATE
 &lt;/Files&gt;
-</programlisting></para>
+</programlisting><calloutlist>
+            <callout arearefs="AddDefaultCharSet">
+              <para>See <ulink
+              url="http://www.sagehill.net/docbookxsl/SpecialChars.html">Odd
+              characters in HTML output</ulink> in Bob Stayton's book
+              <citetitle>DocBook XSL: The Complete Guide</citetitle> for more
+              information about this setting.</para>
+            </callout>
+
+            <callout arearefs="CachingSettings">
+              <para>These lines and those that follow cause the browser to
+              cache various resources such as bitmaps and JavaScript files.
+              Note that caching JavaScript files could cause your users to
+              have stale search indexes if you update your document since the
+              search index is stored in JavaScript files.</para>
+            </callout>
+
+            <callout arearefs="CompressSetting">
+              <para>These lines cause the the server to compress html, css,
+              and JavaScript files and the brower to uncompress them to
+              improve download performance.</para>
+            </callout>
+          </calloutlist></para>
       </section>
     </section>
 
-- 
2.40.0