doc

src/doc/man/recoll.conf.5

@@ -1,5 +1,4 @@
-.\" $Id: recoll.conf.5,v 1.5 2007-07-13 10:18:49 dockes Exp $ (C) 2005 J.F.Dockes\$
+.TH RECOLL.CONF 5 "14 November 2012"
-.TH RECOLL.CONF 5 "8 January 2006"
 .SH NAME
 recoll.conf \- main personal configuration file for Recoll
 .SH DESCRIPTION

src/doc/user/usermanual.xml

@@ -3,7 +3,7 @@
 
 <!ENTITY RCL "<application>Recoll</application>">
 <!ENTITY RCLAPPS "<ulink url='http://www.recoll.org/features.html'>http://www.recoll.org/features.html</ulink>">
-<!ENTITY RCLVERSION "1.19">
+<!ENTITY RCLVERSION "1.20">
 <!ENTITY XAP "<application>Xapian</application>">
 <!ENTITY WIKI "http://bitbucket.org/medoc/recoll/wiki/">
 ]>
@@ -22,7 +22,7 @@
     </author>
 
     <copyright>
-      <year>2005-2013</year>
+      <year>2005-2014</year>
       <holder role="mailto:jfd@recoll.org">Jean-Francois Dockes</holder>
     </copyright>
     <abstract>
@@ -1269,6 +1269,11 @@ fs.inotify.max_user_watches=32768
        <filename>mimeview</filename></link> configuration file if you find
        this more convenient.</para>
 
+       <para>Each result entry also has a right-click menu with an
+       <guilabel>Open With</guilabel> entry. This lets you choose an
+       application from the list of those which registered with the desktop
+       for the document MIME type.</para>
+
       <para>The <literal>Preview</literal> and <literal>Open</literal>
        edit links may not be present for all entries, meaning that
        &RCL; has no configured way to preview a given file type (which
@@ -2031,6 +2036,19 @@ fs.inotify.max_user_watches=32768
         also save the result list in CSV format.</para> 
       </formalpara>
 
+
+      <formalpara><title>Changing the GUI geometry</title>
+      <para>It is 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 
+	  <menuchoice>
+	    <guimenu>Preferences</guimenu>
+	    <guimenuitem>GUI configuration</guimenuitem>
+	    <guimenuitem>User interface</guimenuitem>
+          </menuchoice> panel).</para>
+      </formalpara>
+
       <formalpara><title>Query explanation</title>
         <para>You can get an exact description of what the query
         looked for, including stem expansion, and Boolean operators
@@ -2793,6 +2811,16 @@ text/html       [file:///Users/uncrypted-dockes/projets/bateaux/ilur/factEtCie/r
       <replaceable>title:prejudice title:pride</replaceable>, and is
       unlikely to find a result.</para> 
 
+      <para>To save you some typing, recent &RCL; versions (1.20 and later)
+      interpret a comma-separated list of terms as an AND list inside the
+      field. Use slash characters ('/') for an OR list. No white space
+      is allowed. So
+      <programlisting>author:john,lennon</programlisting> will search for
+      documents with <literal>john</literal> and <literal>lennon</literal>
+      inside the <literal>author</literal> field (in any order), and
+      <programlisting>author:john/ringo</programlisting> would search for
+      <literal>john</literal> or <literal>ringo</literal>.</para>
+
       <para>Modifiers can be set on a phrase clause, for example to specify
         a proximity search (unordered). See 
         <link linkend="RCL.SEARCH.LANG.MODIFIERS">the modifier
@@ -2823,14 +2851,38 @@ text/html       [file:///Users/uncrypted-dockes/projets/bateaux/ilur/factEtCie/r
             any).</para>
            </listitem>
 
-        <listitem><para><literal>filename</literal> for the document's
+           <listitem><para><literal>filename</literal> for the document's
-            file name.</para></listitem>
+            file name. This is not necessarily set for all documents:
+           internal documents contained inside a compound one (for example
+           an EPUB section) do not inherit the container file name any more,
+           this was replaced by an explicit field (see next). Sub-documents
+           can still have a specific <literal>filename</literal>, if it is
+           implied by the document format, for example the attachment file
+           name for an email attachment.</para></listitem> 
 
+           <listitem><para><literal>containerfilename</literal>. This is
+           set for all documents, both top-level and contained
+           sub-documents, and is always the name of the filesystem directory
+           entry which contains the data. The terms from this field can
+           only be matched by an explicit field specification (as opposed
+           to terms from <literal>filename</literal> which are also indexed
+           as general document content). This avoids getting matches for
+           all the sub-documents when searching for the container file
+           name.</para></listitem> 
+           
         <listitem><para><literal>ext</literal> specifies the file
             name extension (Ex: <literal>ext:html</literal>)</para>
            </listitem>
 
-         </itemizedlist>
+      </itemizedlist>
+
+      <para>&RCL; 1.20 and later have a way to specify aliases for the
+      field names, which will save typing, for example by aliasing
+      <literal>filename</literal> to <replaceable>fn</replaceable> or
+      <literal>containerfilename</literal> to
+      <replaceable>cfn</replaceable>. See the <link
+      linkend="RCL.INSTALL.CONFIG.FIELDS">section about the
+      <filename>fields</filename> file</link></para> 
 
       <para>The field syntax also supports a few field-like, but
         special, criteria:</para>
@@ -5088,8 +5140,8 @@ skippedPaths = ~/somedir/*.txt
           </varlistentry>
 
           <varlistentry><term><varname>usesystemfilecommand</varname></term>
-            <listitem><para>Decide if we use the
+            <listitem><para>Decide if we execute a system command 
-            <command>file</command> <option>-i</option> system command
+            (<command>file</command> <option>-i</option> by default)
             as a final step for determining the MIME type for a file
             (the main procedure uses suffix associations as defined in
             the <filename>mimemap</filename> file). This can be useful
@@ -5098,6 +5150,14 @@ skippedPaths = ~/somedir/*.txt
             </listitem> 
 	  </varlistentry>
 
+          <varlistentry><term><varname>systemfilecommand</varname></term>
+            <listitem><para>Command to use for mime for mime type
+            determination if <literal>usesystefilecommand</literal> is
+            set. Recent versions of <command>xdg-mime</command> sometimes
+            work better than <command>file</command>.</para>
+            </listitem> 
+	  </varlistentry>
+
           <varlistentry><term><varname>processwebqueue</varname></term>
             <listitem><para>If this is set, process the directory where
             Web browser plugins copy visited pages for indexing.</para>
@@ -5669,7 +5729,8 @@ mondelaypatterns = *.log:20 "this one has spaces*:10"
 	behaviour.</para>
 
 	<para>We will only give a short description here, you should refer
-	to the comments inside the file for more detailed information.</para>
+	to the comments inside the default file for more detailed
+	information.</para>
 
 	<para>Field names should be lowercase alphabetic ASCII.</para>
 
@@ -5695,6 +5756,14 @@ mondelaypatterns = *.log:20 "this one has spaces*:10"
             and <literal>[stored]</literal> sections</para>
             </listitem>
           </varlistentry>
+          <varlistentry>
+            <term>[queryaliases]</term>
+            <listitem><para>This section also defines aliases for the
+            canonic field names, with the difference that the substitution
+            will only be used at query time, avoiding any possibility that
+            the value would pick-up random metadata from documents.</para>
+            </listitem>
+          </varlistentry>
           <varlistentry>
             <term>handler-specific sections</term>
             <listitem><para>Some input handlers may need specific
@@ -5725,6 +5794,10 @@ mailmytag = XMTAG
 # displayed - as %(mailmytag) - in result lists).
 mailmytag = 
 
+[queryaliases]
+filename = fn
+containerfilename = cfn
+
 [mail]
 # Extract the X-My-Tag mail header, and use it internally with the
 # mailmytag field name

website/download.html

@@ -126,8 +126,12 @@ subdirectory, because of all the places they're referred from
 
 <h3>1.20 preview</h3>
 
-<p>See the <a href="release-1.20.html">release notes</a>.</p>
+<p>Recoll 1.20 will contain no revolutionary changes, but a set of
-<p><a href="recoll-1.20.0.tar.gz">recoll-1.20.0.tar.gz</a>. </p>
+useful adjustments. 1.20.0 will be released in a set of incremental
+snapshots. The current snapshot is 1.20.0p1.  See
+the <a href="release-1.20.html">release notes</a> for what's in
+there.</p>
+<p><a href="recoll-1.20.0.tar.gz">recoll-1.20.0p1.tar.gz</a>. </p>
 
 <!--
 <h3>Snapshot</h3>

website/release-1.20.html

@@ -64,7 +64,7 @@
         opposed to only bug fixes). There will be a freeze at some
         point.
 
-        <h2>Changes in Recoll 1.20.0</h2>
+        <h2>Changes in Recoll 1.20.0p1</h2>
         <ul>
           
           <li>An <em>Open With</em> entry was added to the result list
@@ -109,11 +109,40 @@
             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
+            file name as a term for the contained sub-documents (if
-            any). This made no sense at all in most cases. However,
+            any). This made no sense in most cases, as it meant that
-            this was sometimes useful when searching email
+            you would get hits on all the sections from a chm or epub
-            folders. Complain if you do not like this change, and I'll
+            when the top file name matched the search, when you
-            make it configurable.</li>
+            probably wanted only the parent document in this case.<br>
+            However, the container file name was sometimes useful for
+            filtering results, and it is still accessible, in a
+            different way: the top container file name is added as a
+            term to all the sub-documents, <em>only for searching with
+            a prefix</em>. The field name
+            is <span class="literal">containerfilename</span>, and no
+            match on the subdocuments will occur if the field is not
+            specified (this is different from
+            previous <span class="literal">filename</span> processing,
+            which was indexed as a general
+            term. <span class="literal">containerfilename</span> is
+            also set on files without sub-documents (e.g. a pdf).</li>
+
+          <li>A new attribute, <span class="literal">pfxonly</span>,
+            was created. This can be set on any metadata field inside
+            the <span class="literal">[prefixes]</span> section of
+            the <span class="filename">fields</span> file.</li>
+
+          <li>A new <span class="literal">[queryaliases]</span>
+            section was created in
+            the <span class="filename">fields</span>, for definining
+            field name aliases to be used only at query time (to avoid
+            unwanted collection of data on random fields during
+            indexing). The section is empty by default, but 2 obvious
+            alias are in
+            comment: <span class="literal">filename=fn</span>
+            and <span class="literal">containerfilename=cfn</span>. Setting
+            them in your personal file may save you some typing if you
+            search on file names.</li> 
 
           <li>You can now use both <em>-e</em> and  <em>-i</em> for
             erasing then updating the index for the given file
@@ -127,6 +156,20 @@
             terms was added. See 
             <span class="filename">src/python/samples/docdups.py</span></li>
 
+          <li>The command used to identify the mime types of files
+            when the internal method is <span class="literal">file
+            -i</span> by default. It is now possible to customize this
+            command by setting
+            the <span class="literal">systemfilecommand</span> in the
+            configuration. A suggested value would
+            be <span class="filename">xdg-mime</span>, which sometimes
+            works better than <span class="filename">file</span>.</li>
+
+          <li>The result list has two new elements: %P substitution
+            for printing the parent folder name, and an <tt>F</tt>
+            link target which will open the parent folder in a
+            file manager window.</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