Switch to unified view

a/src/doc/user/usermanual.sgml b/src/doc/user/usermanual.sgml
...
...
985
    </sect1>
985
    </sect1>
986
986
987
    <sect1 id="rcl.search.complex">
987
    <sect1 id="rcl.search.complex">
988
      <title>Complex/advanced search</title>
988
      <title>Complex/advanced search</title>
989
989
990
      <para>The advanced search dialog has a number of fields that
990
      <para>The advanced search dialog helps you build more complex
991
        will allow a more refined search. Each entry field is
991
      queries. It can be opened through the <guilabel>Tools</guilabel>
992
      menu or through the main toolbar.</para>
993
994
      <para>The dialog has three parts:</para>
995
996
      <itemizedlist>
997
  <listitem><para>The top part allows constructing a query by
998
          combining multiple clauses of different types.
992
        configurable for the following modes:</para>
999
          Each entry field is configurable for the following modes:</para>
993
1000
994
        <itemizedlist>
1001
        <itemizedlist>
995
      <listitem><para>All terms.</para>
1002
      <listitem><para>All terms.</para>
996
      </listitem>
1003
      </listitem>
997
      <listitem><para>Any term.</para>
1004
      <listitem><para>Any term.</para>
...
...
1002
      adjustable window).</para>
1009
      adjustable window).</para>
1003
      </listitem>
1010
      </listitem>
1004
      <listitem><para>Proximity (terms in any order within an
1011
      <listitem><para>Proximity (terms in any order within an
1005
      adjustable window).</para>
1012
      adjustable window).</para>
1006
      </listitem>
1013
      </listitem>
1007
      <listitem><para>Filename search with wildcards.</para>
1014
      <listitem><para>Filename search.</para>
1008
      </listitem>
1015
      </listitem>
1009
    </itemizedlist>
1016
    </itemizedlist>
1010
1017
1011
      <para>Additional entry fields can be created by clicking the
1018
        <para>Additional entry fields can be created by clicking the
1012
      <guilabel>Add clause</guilabel> button.</para>
1019
          <guilabel>Add clause</guilabel> button.</para>
1013
1020
1014
      <para>You can choose that all relevant fields will be combined
1021
        <para>When searching, the non-empty clauses will be
1015
      by either an AND or an OR conjunction. All types of clauses
1022
          combined either with an AND or an OR conjunction, depending on
1016
      except "phrase" and "near" can accept a mix of single words and
1023
          the choice made on the left (<guilabel>All clauses</guilabel> or
1017
      phrases enclosed in double quotes. Stemming expansion will be
1024
          <guilabel>Any clause</guilabel>).</para>
1018
      performed for all terms not beginning with a capital letter,
1019
      except for terms inside "phrase" clauses. Wildcards will be
1020
      processed everywhere.</para>
1021
1025
1022
      <para>Advanced search will also let you search for documents of
1026
        <para>Entries of all types except "Phrase" and "Near" accept
1023
       specific mime types (ie: only <literal>text/plain</literal>, or
1027
          a mix of single words and phrases enclosed in double quotes. 
1024
        <literal>text/HTML</literal> or
1028
          Stemming and wildcard expansion will be performed as for simple
1025
        <literal>application/pdf</literal> etc...). The state of the
1029
          search. </para>
1026
        file type selection can be saved as the default (the file type
1030
  </listitem>
1027
        filter will not be activated at program start-up, but the lists
1028
        will be in the restored state).</para>
1029
1031
1030
      <para>You can also restrict the search results
1032
  <listitem><para>The next part allows filtering the
1033
          results by their mime types.</para> 
1034
    <para>The state of the file type selection can be saved as
1035
          the default (the file type filter will not be activated at
1036
          program start-up, but the lists will be in the restored
1037
          state).</para> 
1038
  </listitem>
1039
1040
  <listitem>
1041
          <para>The bottom part allows restricting the search results to a
1031
      to a sub-tree of the indexed area. If you need to do this often,
1042
            sub-tree of the indexed area. If you need to do this often, 
1032
      you may think of setting up multiple indexes instead, as the
1043
            you may think of setting up multiple indexes instead, as the
1033
      performance will be much better.</para>
1044
            performance will be much better.</para>
1045
  </listitem>
1046
1047
      </itemizedlist>
1048
1034
1049
1035
      <para>Click on the <guilabel>Start Search</guilabel> button in
1050
      <para>Click on the <guilabel>Start Search</guilabel> button in
1036
      the advanced search dialog, or type <keycap>Enter</keycap> in
1051
        the advanced search dialog, or type <keycap>Enter</keycap> in
1037
      any text field to start the search. The button in
1052
        any text field to start the search. The button in
1038
      the main window always performs a simple search.</para>
1053
        the main window always performs a simple search.</para>
1039
1040
      <para>Click on the <literal>Show query details</literal> link at
1054
      <para>Click on the <literal>Show query details</literal> link at
1041
      the top of the result page to see the query expansion.</para>
1055
        the top of the result page to see the query expansion.</para>
1042
1056
1043
    </sect1>
1057
    </sect1>
1044
1058
1045
    <sect1 id="rcl.search.termexplorer">
1059
    <sect1 id="rcl.search.termexplorer">
1046
      <title>The term explorer tool</title>
1060
      <title>The term explorer tool</title>
...
...
1240
      <guimenu>File</guimenu> menu.
1254
      <guimenu>File</guimenu> menu.
1241
1255
1242
    </sect1>
1256
    </sect1>
1243
1257
1244
    <sect1 id="rcl.search.sort">
1258
    <sect1 id="rcl.search.sort">
1245
      <title>Sorting search results</title>
1259
      <title>Sorting search results and collapsing duplicates</title>
1246
1260
1247
      <para>The documents in a result list are normally sorted in
1261
      <para>The documents in a result list are normally sorted in
1248
      order of relevance. It is possible to specify different sort
1262
        order of relevance. It is possible to specify different sort
1249
      parameters by using the <guimenu>Sort parameters</guimenu>
1263
        parameters by using the <guimenu>Sort parameters</guimenu>
1250
      dialog (located in the <guimenu>Tools</guimenu>
1264
        dialog (located in the <guimenu>Tools</guimenu> menu).</para>
1251
      menu).</para>
1252
1265
1253
      <para>The tool sorts a specified number of the most
1266
      <para>The tool sorts a specified number of the most
1254
      relevant documents in the result list, according to
1267
        relevant documents in the result list, according to specified
1255
      specified criteria. The currently available criteria are
1268
        criteria. The currently available criteria are
1256
      <emphasis>date</emphasis> and <emphasis>mime type</emphasis>.</para> 
1269
        <emphasis>date</emphasis> and <emphasis>mime
1270
        type</emphasis>.</para>
1257
1271
1258
      <para>The sort parameters stay in effect until they are explicitly
1272
      <para>The sort parameters stay in effect until they are
1259
      reset, or the program exits. An activated sort is indicated in
1273
        explicitly reset, or the program exits. An activated sort is
1260
      the result list header.</para>
1274
        indicated in the result list header.</para>
1261
1275
1262
      <para>Sort parameters are remembered between program
1276
      <para>Sort parameters are remembered between program
1263
      invocations, but result sorting is normally always inactive when
1277
        invocations, but result sorting is normally always inactive
1264
      the program starts. It is possible to keep the sorting
1278
        when the program starts. It is possible to keep the sorting
1265
      activation state between program invocations by checking the
1279
        activation state between program invocations by checking the
1266
      <guilabel>Remember sort activation state</guilabel>
1280
        <guilabel>Remember sort activation state</guilabel> option in
1267
      option in the preferences.</para>
1281
        the preferences.</para>
1282
1283
      <para>It is also possible to hide duplicate entries inside
1284
        the result list (documents with the exact same contents as the
1285
        displayed one). The test of identity is based on an MD5 hash
1286
        of the document container, not only of the text contents (so
1287
        that ie, a text document with an image added will not be a
1288
        duplicate of the text only). Duplicates hiding is controlled
1289
        by an entry in the <guilabel>Query configuration</guilabel>
1290
        dialog, and is off by default.</para>
1268
1291
1269
    </sect1>
1292
    </sect1>
1293
1270
1294
1271
    <sect1 id="rcl.search.tips">
1295
    <sect1 id="rcl.search.tips">
1272
      <title>Search tips, shortcuts</title>
1296
      <title>Search tips, shortcuts</title>
1273
1297
1274
    <sect2 id="rcl.search.tips.terms">
1298
    <sect2 id="rcl.search.tips.terms">
...
...
1420
    <para>
1444
    <para>
1421
      <itemizedlist>
1445
      <itemizedlist>
1422
1446
1423
    <listitem><para><guilabel>Number of results in a result
1447
    <listitem><para><guilabel>Number of results in a result
1424
          page</guilabel>: </para> 
1448
          page</guilabel>: </para> 
1449
  </listitem>
1450
1451
  <listitem><para><guilabel>Hide duplicate results</guilabel>:
1452
  decides if result list entries are shown for identical
1453
  documents found in different places.</para> 
1425
    </listitem>
1454
    </listitem>
1426
1455
1427
    <listitem><para><guilabel>Highlight color for query
1456
    <listitem><para><guilabel>Highlight color for query
1428
          terms</guilabel>:
1457
          terms</guilabel>:
1429
        Terms from the user query are highlighted in the result
1458
        Terms from the user query are highlighted in the result