From a3a7081a7fa811b309f8f3f60cea4c7ac2c4db78 Mon Sep 17 00:00:00 2001
From: Jean-Francois Dockes <jfd@recoll.org>
Date: Tue, 3 Nov 2015 08:26:13 +0100
Subject: [PATCH] doc

---
 website/pages/recoll-mingw.txt   |  14 +++-
 website/pages/recoll-windows.txt | 111 +++++++++++++++++--------------
 2 files changed, 71 insertions(+), 54 deletions(-)

diff --git a/website/pages/recoll-mingw.txt b/website/pages/recoll-mingw.txt
index 25fae6e1..46849ed9 100644
--- a/website/pages/recoll-mingw.txt
+++ b/website/pages/recoll-mingw.txt
@@ -5,8 +5,8 @@ This document describes building a Recoll distribution, starting from a
 pristine Windows machine, using the http://www.mingw.org/[MinGW] port of gcc
 and associated tools. 
 
-The resulting package only needs Python and 7-zip to be installed on the
-target system.
+The resulting package only needs Python (and optionally 7-zip) to be
+installed on the target system.
 
 == Installing MinGW and MSYS
 
@@ -263,4 +263,12 @@ the recoll install dir by the install script.
 == Building the install directory
 
 Once the builds above are performed, edit the mkinstdir.sh script to adjust
-the locations, and use it to build the installation directory
+the locations, and use it to build the installation directory. The
+innosetup script expects it to be c:/install/recoll
+
+== Building the setup executable
+
+Install Inno Setup and use src/windows/recoll-setup.iss to generate the
+installation executable.
+
+
diff --git a/website/pages/recoll-windows.txt b/website/pages/recoll-windows.txt
index 6f51f729..eb3fd182 100644
--- a/website/pages/recoll-windows.txt
+++ b/website/pages/recoll-windows.txt
@@ -3,71 +3,80 @@ Jean-Francois Dockes <jf at dockes.org>
 
 image:recoll-windows10-thumb.png[link="recoll-windows10.png"]
 
-The Windows port of Recoll has reached a point where it can be tested. At
-least, it will not break your system, and it does not crash too often.
+Recoll for Windows was built on Windows 7, and tried on Windows 7 and
+10. It is quite usable. At least, it should not break your system.
 
-It was built on Windows 7, and tried on Windows 7 and 10.
+Recoll is free and licensed under the GPL. You will be asked to accept the
+license during the installation. For a regular user, and in a nutshell, the
+license means that you are free to do what you want with the program (use,
+copy, share, etc.). If you are a developper and intend to modify and
+distribute the program, you probably know the GPL. Else you should read it.
+  
+I would very much like to get some feedback from actual Windows users (I am
+only a visitor to Windows...). Is this useful at all ? What would make it
+more useful ? You can use the Disqus comments section at the bottom of this
+page, send an email, or use the
+https://bitbucket.org/medoc/recoll/issues[BitBucket Recoll issues tracker].
 
-I would be very eager to get some feedback from some actual Windows user
-(I am only a visitor to Windows...). Is this useful at all ? What would 
-make it more useful ? 
 
-There is no installer for the moment, the program and its auxiliary files
-are stored in a Zip file. This is quite big, because it contains a good
-part of the Qt 5.5.0 dlls (I can't produce a static build because of WebKit).
+Procedure: 
 
-The Zip creates a `recoll` directory. As far as I know, there is no
-assumption where it should reside, I use `c:/recoll`, but anywhere
-else should be ok.
+- Download the Recoll setup file from the
+  http://www.recoll.org/windows/recoll-setup-1.22.0-20151103.exe[Recoll
+  web site], or (probably faster) from 
+  https://bitbucket.org/medoc/recoll/downloads/recoll-setup-1.22.0-20151103.exe[BitBucket].
 
-You can get the Zip file either from the 
-http://www.lesbonscomptes.com/recoll/windows/[download directory on
-lesbonscomptes] or from 
-https://bitbucket.org/medoc/recoll/downloads/[the one on bitbucket].
+- Execute the setup file. This is a vanilla installer generated by Inno
+  Setup, and it will ask the usual questions.
 
-Besides extracting the Zip, you need to:
+- Download and install
+  https://www.python.org/ftp/python/2.7.10/python-2.7.10.msi[Python
+  2.7.10].
+  *_On the `Customize installation` screen, select "Add python.exe to Path"_*
+  
+- Optional: download and install the 7-zip program from
+  http://www.7-zip.org/. This is only useful if you need to index files
+  compressed with Unix methods (not needed for zip files).
 
- - Download and install Python 2.7 from
-   https://www.python.org/downloads/release/python-2710/. Most Recoll data
-   extraction filters have at least a Python part, so you will not be able
-   to do much without this.
- - Download and install the 7-zip program from http://www.7-zip.org/. This
-   is only useful if you need to index compressed files.
+- Start recoll. It will ask if you want to customize the configuration.
+  The default is to index the content of your user directory. Then start
+  indexing. This can take some time.
 
- - Update your PATH variable with the locations of the `python` and `7z`
-   executables.
+The default result list font is particularly ugly. Change it from 
+`Preferences->GUI Configuration->Result List->Result List Font`
+  
+== Recoll Windows tips and tricks
 
-   * From Windows Explorer, click `Computer` in the left pane, then 
-     `System Properties` from the top, then `Avanced System Settings` from
-     the left pane, then `Environment Variables` at the bottom of the
-     popup. 
-   * Check that the locations for `python` (`C:\Python27`), and `7z`
-     (`C:\Program Files\7-Zip`) are either in the User or System PATH
-     variable. If they are not in there already , update or create the user
-     PATH and add them as: `C:\Python27;C:\Program Files\7-Zip` (use a
-     semi-colon as separator).
+(not much for now...)
 
-Windows tricks:
+When filtering the search with a `dir:` clause, an absolute path
+should be specified as `/c/mydir` instead of `c:/mydir`
 
- - When filtering the search with a `dir:` clause, an absolute path
-   should be specified as `/c/mydir` instead of `c:/mydir`
+== Known problems:
 
-Known problems:
 
- - The default result list font is particularly ugly. Change it from 
-   `Preferences->GUI Configuration->Result List->Result List Font`
+- The GUI sometimes crashes when you click `Preview` or `Open`. This does
+  not occur often, and usually for one of the first tries after starting
+  the program. Don't despair.
 
- - The GUI sometimes crashes when you click `Preview` or `Open`. This does
-   not occur often, and usually for one of the first tries after starting
-   the program. Don't despair.
+- There is no real-time or scheduled indexing as on Linux. For now, you
+  create and update the index by using the `File` menu (or executing
+  `recollindex.exe` from a command window).
 
- - There is no real-time or scheduled indexing as on Linux. For now, you
-   create and update the index by using the `File` menu (or executing
-   `recollindex.exe` from a command window).
+- I'll add the others here as they are found ...
 
- - I'm quite convinced that there are still problems with file path case
-   insensitivity. The best approach when setting up the config is
-   to use the exact case for now.
-
- - I'll add the others here as they are found ...
+++++
+<h2 id="comments">Comments</h2>
 
+      <div id="disqus_thread"></div>
+      <script type="text/javascript">
+        var disqus_shortname = 'lesbonscomptes'; 
+        (function() {
+            var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
+            dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
+            (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
+        })();
+      </script>
+      <noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
+      <a href="http://disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
+++++