From 7402137955e9cea178214b14975aa4d3564ace6c Mon Sep 17 00:00:00 2001
From: Jean-Francois Dockes <jfd@recoll.org>
Date: Tue, 17 Jun 2014 09:53:56 +0200
Subject: [PATCH] doc

---
 website/BUGS.html         |   4 +-
 website/download.html     |  12 ++-
 website/index.html.en     |  10 +++
 website/release-1.20.html | 156 ++++++++++++++++++++++++++++++++++++++
 4 files changed, 177 insertions(+), 5 deletions(-)
 create mode 100644 website/release-1.20.html
diff --git a/website/BUGS.html b/website/BUGS.html
index d8096252..92de752c 100644
--- a/website/BUGS.html
+++ b/website/BUGS.html
@@ -72,8 +72,8 @@ versions.</i></p>
 
 <h2><a name="b_1_19_13">recoll 1.19.13</a></h2>
 <ul>
-  <li>Child process could hang during the fork-exec interval and cause a
-    20 mn filter timeout.</li>
+  <li>Indexing child process could hang during the fork-exec interval
+    and cause a 20 mn filter timeout.</li>
   <li>The use of separate read/write Xapian Database objects could cause
     errors while checking the up-to-date status of documents.</li>
   <li>Doc category filter names displayed in combobox were incorrect
diff --git a/website/download.html b/website/download.html
index 569efd27..f2363334 100644
--- a/website/download.html
+++ b/website/download.html
@@ -123,6 +123,12 @@ subdirectory, because of all the places they're referred from
 (package watches) -->
 
 <p><a href="recoll-1.19.14.tar.gz">recoll-1.19.14.tar.gz</a>. </p>
+
+<h3>1.20 preview</h3>
+
+<p>See the <a href="release-1.20.html">release notes</a>.</p>
+<p><a href="recoll-1.20.0.tar.gz">recoll-1.20.0.tar.gz</a>. </p>
+
 <!--
 <h3>Snapshot</h3>
 <p>I sometimes release a source tarfile when I consider that the
@@ -134,9 +140,9 @@ current <a href="release-1.16.html">1.16 release notes</a>).
 <p><a href="betarecoll-2240.tar.gz">betarecoll-2240.tar.gz</a>.</p>
 -->
 
-<p>Source code for the Ubuntu Unity lens and scope (not included in
-the main tar file any more):<br>
-For 1.19 installations: 
+<h3>Ubuntu Unity Lens and Scope</h3>
+<p>This are not included in the main tar file any more.</p>
+For 1.19 and 1.20 installations: 
 <a href="recoll-lens-1.19.10.3543.tar.gz">
   recoll-lens-1.19.10.3543.tar.gz</a> (up to Ubuntu 13.04 Raring)<br>
 <a href="unity-scope-recoll-1.19.12.tar.gz">
diff --git a/website/index.html.en b/website/index.html.en
index 492ef638..a76654c1 100644
--- a/website/index.html.en
+++ b/website/index.html.en
@@ -92,6 +92,16 @@
       <div class="news">
       
       <dl>
+        <dt>2014-06-17</dt> <dd>The source tarball for version 1.20.0
+          has been released. This version has
+          a <a href="release-1.20.html">number of improvements</a> over
+          1.19, but also some incompatibilities. The first minor
+          releases for 1.20 may contain some functional changes in
+          addition to bug fixes, so they may be slightly less stable
+          than 1.19, and 1.19 packages remain the "safe Recoll" for
+          now. Still, if you build from source, there are a few nice 
+          things in 1.20...</dd>
+
         <dt>2014-06-07</dt> <dd>Version 1.19.14 is out and fixes a
           handful of minor-to-ennoying indexing glitches (see the 
           <a href="release-1.19.html">Release notes</a>).</dd>
diff --git a/website/release-1.20.html b/website/release-1.20.html
new file mode 100644
index 00000000..d60fbdc5
--- /dev/null
+++ b/website/release-1.20.html
@@ -0,0 +1,156 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+  <head>
+    <title>Recoll 1.20 series release notes</title>
+    <meta name="Author" content="Jean-Francois Dockes">
+    <meta name="Description"
+          content="recoll is a simple full-text search system for unix and linux     based on the powerful and mature xapian engine">
+    <meta name="Keywords" content="full text search, desktop search, unix, linux">
+    <meta http-equiv="Content-language" content="en">
+    <meta http-equiv="content-type" content="text/html; charset=UTF-8">
+    <meta name="robots" content="All,Index,Follow">
+    <link type="text/css" rel="stylesheet" href="styles/style.css">
+  </head>
+
+  <body>
+
+    <div class="rightlinks">
+      <ul>
+        <li><a href="index.html">Home</a></li>
+        <li><a href="download.html">Downloads</a></li>
+        <li><a href="doc.html">Documentation</a></li>
+      </ul>
+    </div>
+
+    <div class="content">
+      <h1>Release notes for Recoll 1.20.x</h1>
+
+      <h2>Caveats</h2>
+
+      <p><em>Installing over an older version</em>: 1.19 </p>
+
+      <p>Installing 1.20 over an 1.19 index is possible, but there
+        have been small changes in the way compound words (e.g. email
+        addresses) are indexed, so it will be best to reset the
+        index. Still, in a pinch, 1.20 search can mostly use an 1.19
+        index.</p>
+
+      <p>Case/diacritics sensitivity is off by default. It can be
+        turned on <em>only</em> by editing
+        recoll.conf (
+        <a href="usermanual/usermanual.html#RCL.INDEXING.CONFIG.SENS">
+          see the manual</a>). If you do so, you must then reset the
+        index.</p> 
+
+      <p>Always reset the index if you do not know by which version it
+        was created (you're not sure it's at least 1.18). The best method
+        is to quit all Recoll programs and delete the index directory 
+        (<span class="literal">
+          rm -rf ~/.recoll/xapiandb</span>), then start <code>recoll</code>
+        or <code>recollindex</code>. <br> 
+
+        <span class="literal">recollindex -z</span> will do the same
+        in most, but not all, cases. It's better to use
+        the <tt>rm</tt> method, which will also ensure that no debris
+        from older releases remain (e.g.: old stemming files which are
+        not used any more).</p>
+
+
+      <h2><a name="minor_releases">Minor releases at a glance</a></h2>
+      <p>The rhythm of change in Recoll is slowing as the software is
+        approaching maturity, so, in order to avoid stopping progress
+        by excessive intervals between releases, the first versions 
+        of 1.20 will be allowed to contain some functional changes (as
+        opposed to only bug fixes). There will be a freeze at some
+        point.
+
+        <h2>Changes in Recoll 1.20.0</h2>
+        <ul>
+          
+          <li>An <em>Open With</em> entry was added to the result list
+            and result table popup menus. This lets you choose an
+            alternative application to open a document. The list of
+            applications is built from the information inside
+            the <span class="filename">
+              /usr/share/applications</span> desktop files.</li>
+
+          <li>A new way for specifying multiple terms to be searched
+            inside a given field: it used to be that an entry lacking
+            whitespace but splittable, like [term1,term2] was
+            transformed into a phrase search, which made sense in some
+            cases, but no so many. The code was changed so that
+            [term1,term2] now means [term1&nbsp;AND&nbsp;term2], and
+            [term1/term2] means [term1&nbsp;OR&nbsp;term2]. This is
+            useful for field searches where you would previously be
+            forced to repeat the field name for every term.
+            [somefield:term1&nbsp;somefield:term2] can now be expressed as
+            [somefield:term1,term2].
+          </li>
+
+          <li>We changed the way terms are generated from a compound
+            string (e.g. an email address). Previously, for an address
+            like <em>jfd@recoll.org</em>, only the simple terms and
+            the terms anchored at the start were generated
+            (<em>jfd</em>, <em>recoll</em>, <em>org</em>, <em>jfd@recoll</em>, <em>jfd@recoll.org</em>). The
+            new text splitter generates all the other possible terms
+            (here, <em>recoll.org</em> only), so that it is now
+            possible to search for left-truncated versions of the
+            compound, e.g., all emails from a given domain.</li>
+
+          <li>It is now possible to configure the GUI in wide form
+            factor by dragging the toolbars to one of the sides (their
+            location is remembered between sessions), and moving the
+            category filters to a menu (can be set in the 
+            "Preferences->GUI configuration" panel).</li>
+            
+          <li>We added the <em>indexedmimetypes</em> and
+            <em>excludedmimetypes</em> variables to the configuration
+            GUI, which was also compacted a bit. A bunch of
+            ininteresting variables were also removed.</li>
+            
+          <li>When indexing, we no longer add the top container
+            file-name as a term for the contained sub-documents (if
+            any). This made no sense at all in most cases. However,
+            this was sometimes useful when searching email
+            folders. Complain if you do not like this change, and I'll
+            make it configurable.</li>
+
+          <li>You can now use both <em>-e</em> and  <em>-i</em> for
+            erasing then updating the index for the given file
+            arguments with the same <em>recollindex</em> command.</li>
+
+          <li>We now allow access to the Xapian docid for Recoll
+            documents in <span class="command">recollq</span> and
+            Python API search results. This allows writing scripts
+            which combine Recoll and pure Xapian operations. A sample
+            Python program to find document duplicates, using MD5
+            terms was added. See 
+            <span class="filename">src/python/samples/docdups.py</span></li>
+
+          <li><span class="filename">/media</span> was added to the default
+            skippedPaths list mostly as a reminder that blindly
+            processing these with the general indexer is a bad idea
+            (use separate indexes instead).</li>
+
+          <li><span class="command">recollq</span>
+            and <span class="command">recoll&nbsp;-t</span> get a new 
+            option <span class="literal">-N</span>  to print field
+            names between values when 
+            <span class="literal">-F</span> is used. In addition, 
+            <span class="literal">-F&nbsp;""</span> is taken as a
+            directive to print all fields.</li>
+
+          <li>Unicode <span class="literal">hyphen</span> (0x2010) is
+            now translated to ASCII
+            <span class="literal">minus</span>
+            during indexing and searching. There is no good way to
+            handle this character, given the varius misuses of minus
+            and hyphen. This choice was deemed "less bad" than the
+            previous one.</li>
+
+        </ul>
+
+
+    </div>
+  </body>
+</html>
