From 45e4597e6a20f8a1711c2497ff81708f6f4fc3c9 Mon Sep 17 00:00:00 2001
From: Jean-Francois Dockes <jfd@recoll.org>
Date: Fri, 4 May 2012 11:54:30 +0200
Subject: [PATCH] doc

---
 website/BUGS.html     | 23 ++++++++++++++---
 website/custom.html   | 60 ++++++++++++++++++++++++++++++++-----------
 website/download.html |  7 +++--
 3 files changed, 70 insertions(+), 20 deletions(-)

diff --git a/website/BUGS.html b/website/BUGS.html
index ec65fded..569b5f40 100644
--- a/website/BUGS.html
+++ b/website/BUGS.html
@@ -35,11 +35,28 @@
           supposedly fixed in later versions. Bugs listed in the
           topmost section may also exist in older versions.</i></p>
 
-      <h2><a name="b_latest">recoll 1.17.10</a></h2> 
+      <h2><a name="b_latest">recoll 1.17.1</a></h2> 
 
       <ul>
-        <li>The version string was not correctly updated for 1.17.1, the
-        help dialog and recollindex -v will print 1.17.0.</li>
+        <li>The version string is not correctly updated for 1.17.1, the
+          help dialog and recollindex -v will print 1.17.0.</li>
+
+        <li>chm filter: url-encoded internal paths are mishandled.</li>
+
+        <li>Does not compile on Solaris (flock() issue).</li>
+
+        <li>The KDE recoll applet does not work.</li>
+
+        <li>configure --disable-python-module breaks the installation
+          script.</li>
+
+        <li>Does not display thumbnails for files with an URL which
+          should be encoded (ie: with embedded spaces).</li>
+
+        <li>Does not compile with gcc 4.7 (missing include).</li>
+        
+        <li>Html output from Python (rclexecm) filters is not
+          correctly escaped.</li>
 
         <li>It will sometimes happen that the result list paragraph format
           stored in the Qt preferences file will get garbled,
diff --git a/website/custom.html b/website/custom.html
index dc652b9d..c1dd5cd5 100644
--- a/website/custom.html
+++ b/website/custom.html
@@ -80,6 +80,7 @@ a:hover .PZ3cap { padding:3px 5px; }
     <div class="content">
 
       <h1>Recoll result list customising exemples</h1>
+
       <p>The Recoll result list is actually made of html text
         displayed inside a Qt Widget. In all Recoll versions, you
         can specify the format for the list entries: what data is
@@ -89,23 +90,52 @@ a:hover .PZ3cap { padding:3px 5px; }
 
       <p>As of Recoll 1.17, the result list is by default a WebKit
         object (WebKit is the basis for several major browsers), which
-        yields full CSS and even Javascript support. For these
-        versions you can specify both the individual result format and
-        code to be included in the html header (ie: CSS or
-        Javascript).</p>
+        yields full CSS and even Javascript support.</p>
 
       <h2>New in Recoll 1.17: the WebKit result list</h2>
 
-      <p>With WebKit, things that used to not work are now
-        possible. The exemple which follow are probably not generally
-        very useful (else they'd be included in the standard Recoll),
-        but they provide samples of what can be done, and may be of use
-        anyway.</p>
 
+      <p>For newer Recoll versions, you can specify the
+        individual result format, as for previous versions. You can
+        also define code to be included in the HTML
+        header (ie: CSS or Javascript), using 
+        <tt>Preferences->Query&nbsp;Configuration->Result&nbsp;List->Edit&nbsp;result&nbsp;page&nbsp;html&nbsp;header&nbsp;insert</tt></p>
+
+      <p>This, plus the full Javascript and CSS support in WebKit,
+        open a world of possibilities for result list formatting and
+        even behaviour.</p>
+
+      <p>The examples which follow are probably not generally
+        very useful but they show the kinds of things you can do, if
+        you can use Javascript/CSS which is not my case.</p>
+      
+      <h3>Using the icons as links</h3>
       <p>You can now make the list icons links that activate the
         preview or open action (or the document url which you can then
-        drag/drop to other windows) (turning images into links did
-        not work with QTextBrowser).</p>
+        drag/drop to other windows). Using images as links did
+        not work with QTextBrowser.</p>
+
+      <h3>Alternating result backgrounds</h3>
+      <p>Using the following Javascript inside the header will yield
+        alternating backgrounds for the results:</p>
+
+<pre>
+&lt;script type="text/javascript">
+function altRows() {
+    var rows = document.getElementsByClassName("rclresult");
+    for (i = 0; i &lt; rows.length; i++) {
+        if (i % 2 == 0) {
+            rows[i].style.backgroundColor = "#d4e3e5";
+        }
+    }
+}
+
+window.onload = function() {
+    altRows();
+}
+&lt;/script>
+</pre>
+
 
       <h3>Zooming the paragraph font size</h3>
       <p>If you are using a format with small fonts, it may be useful
@@ -114,9 +144,9 @@ a:hover .PZ3cap { padding:3px 5px; }
           format, which is a table</em>- would be to include the following
         code in the header:</p>
 <pre>
-&lt;STYLE type="text/css">
-table:hover {font-size: 130%;}
-&lt;/STYLE>
+&lt;style type="text/css">
+    table:hover {font-size: 130%;}
+&lt;/style>
 </pre>
 
         <p>Of course, the selector should be adapted to your own
@@ -181,7 +211,7 @@ table:hover {font-size: 130%;}
 
 
 
-      <h2>Result list paragraph format samples</h2>
+      <h2>Result list paragraph format samples (for all versions)</h2>
 
       <p>The format for paragraphs inside the Recoll GUI result list is
         customisable by specifying an html fragment (menu:
diff --git a/website/download.html b/website/download.html
index 08eb33bc..e9486088 100644
--- a/website/download.html
+++ b/website/download.html
@@ -340,10 +340,13 @@ I now use the OpenSUSE build service to create Recoll OpenSUSE packages.
 
       <h3>Solaris</h3>
       <blockquote>
-        <p>I did not test building on Solaris for this version. You will
-          need at least Qt 4.4. The old hints
+        <p>I did not test building the GUI on Solaris for this version. You
+          will need at least Qt 4.4. The old hints
           in <a href="download-1.14.html">the previous page</a> may
           still be valid.</p>
+        <p>Someone did test the indexer and Python module build, they
+          do work, with a few minor glitches. Be sure to use
+          GNU <b>make</b> and <b>install</b>.</p>
       </blockquote>