From c658d4265b055dad5082f3d61e6b04e9d756bbf3 Mon Sep 17 00:00:00 2001 From: Jean-Francois Dockes Date: Sat, 1 Dec 2018 11:10:40 +0100 Subject: [PATCH] doc --- src/doc/user/usermanual.html | 110 +++++++++++++++++------------------ src/doc/user/usermanual.xml | 107 ++++++++++++++++------------------ 2 files changed, 104 insertions(+), 113 deletions(-) diff --git a/src/doc/user/usermanual.html b/src/doc/user/usermanual.html index 5ff1d1fb..7c513844 100644 --- a/src/doc/user/usermanual.html +++ b/src/doc/user/usermanual.html @@ -10,7 +10,7 @@ + "Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license can be found at the following location: GNU web site. This document introduces full text search notions and describes the installation and use of the Recoll application. This version describes Recoll 1.25."> @@ -53,7 +53,7 @@ alink="#0000FF"> and describes the installation and use of the Recoll application. This version describes Recoll 1.24.

+ "application">Recoll 1.25.

@@ -436,7 +436,7 @@ alink="#0000FF">

This document introduces full text search notions and describes the installation and use of the Recoll application. It is updated for - Recoll 1.24.

+ Recoll 1.25.

Recoll was for a long time dedicated to Unix-like systems. It was only lately (2015) ported to MS-Windows. @@ -2338,26 +2338,26 @@ alink="#0000FF"> directives, this will look for documents containing all of the search terms (the ones with more terms will get better scores), just like the All - terms mode which will ignore such directives. - Any term will search for - documents where at least one of the terms appear.

+ terms mode. Any term + will search for documents where at least one of the terms + appear.

The Query Language features are described in a separate section.

-

All search modes allow wildcards inside terms - (*, ?, []). You - may want to have a look at the All search modes allow terms to be expanded with + wildcards characters (*, + ?, []). See the section about - wildcards for more information about this.

-

File name will - specifically look for file names. The point of having a - separate file name search is that wild card expansion can - be performed more efficiently on a small subset of the - index (allowing wild cards on the left of terms without - excessive penality). Things to know:

+ wildcards for more details.

+

The File name search + mode will specifically look for file names. The point of + having a separate file name search is that wild card + expansion can be performed more efficiently on a small + subset of the index (allowing wild cards on the left of + terms without excessive penality). Things to know:

-

You can search for exact phrases (adjacent words in a - given order) by enclosing the input inside double quotes. - Ex: "virtual reality".

-

When using a stripped index, character case has no - influence on search, except that you can disable stem - expansion for any term by capitalizing it. Ie: a search - for floor will also normally - look for flooring, - floored, etc., but a search - for Floor will only look for +

In all modes except File + name, you can search for exact phrases (adjacent + words in a given order) by enclosing the input inside + double quotes. Ex: "virtual + reality".

+

When using a stripped index (the default), character + case has no influence on search, except that you can + disable stem expansion for any term by capitalizing it. + Ie: a search for floor will + also normally look for flooring, floored, etc., but a search for + Floor will only look for floor, in any character case. Stemming can also be disabled globally in the preferences. When using a raw index, "3.7. Search case and diacritics sensitivity">the rules are a bit more complicated.

Recoll remembers the - last few searches that you performed. You can use the - simple search text entry widget (a combobox) to recall - them (click on the thing at the right of the text field). - Please note, however, that only the search texts are - remembered, not the mode (all/any/file name).

-

Typing Esc Space while entering a - word in the simple search entry will open a window with - possible completions for the word. The completions are - extracted from the database.

+ last few searches that you performed. You can directly + access the search history by clicking the clock button on + the right of the search entry, while the latter is empty. + Otherwise, the history is used for entry completion (see + next). Only the search texts are remembered, not the mode + (all/any/file name).

+

While text is entered in the search area, recoll will display + possible completions, filtered from the history and the + index search terms. This can be disabled with a GUI + Preferences option.

Double-clicking on a word in the result list or a preview window will insert it into the simple search entry field.

@@ -3802,18 +3805,12 @@ alink="#0000FF">

  • Choose editor - applicationsr: this opens a dialog which + application: this opens a dialog which allows you to select the application to be used to - open each MIME type. The default is nornally to use - the xdg-open utility, - but you can override it.

    -
    • -
  • -

    Exceptions: even - wen xdg-open is used - by default for opening documents, you can set + but you can use this dialog to override it, setting exceptions for MIME types that will still be opened according to Recoll preferences. This is @@ -3824,6 +3821,14 @@ alink="#0000FF"> "command">xdg-open which only supports passing one parameter.

    • +
  • +

    Disable Qt autocompletion + in search entry: this will disable the + completion popup. Il will only appear, and display + the full history, either if you enter only white + space in the search area, or if you click the clock + button on the right of the area.

    +

  • Document filter choice style: this will let you choose if the @@ -3838,15 +3843,6 @@ alink="#0000FF"> Language, or the value in use when the program last exited.

    • -
  • -

    Auto-start simple search - on white space entry: if this is checked, a - search will be executed each time you enter a space - in the simple search input field. This lets you - look at the result list as you enter new terms. - This is off by default, you may like it or - not...

    -

  • Start with advanced search dialog open : If you use this dialog diff --git a/src/doc/user/usermanual.xml b/src/doc/user/usermanual.xml index 21171287..91e48f00 100644 --- a/src/doc/user/usermanual.xml +++ b/src/doc/user/usermanual.xml @@ -5,7 +5,7 @@ Recoll"> http://www.recoll.org/features.html"> - + Xapian"> Windows"> @@ -1614,26 +1614,24 @@ language. Without special directives, this will look for documents containing all of the search terms (the ones with more terms will get better scores), just like the All - terms mode which will ignore such - directives. Any term will search for documents - where at least one of the terms appear. + terms mode. Any term will search + for documents where at least one of the terms appear. The Query Language features are described in a separate section. - All search modes allow wildcards inside terms - (*, ?, - []). You may want to have a look at the - section about wildcards - for more information about this. + All search modes allow terms to be expanded with wildcards + characters (*, ?, + []). See the section about wildcards for + more details. - File name will specifically look for file - names. The point of having a separate file name - search is that wild card expansion can be performed more - efficiently on a small subset of the index (allowing - wild cards on the left of terms without excessive penality). - Things to know: + The File name search mode will + specifically look for file names. The point of having a separate + file name search is that wild card expansion can be performed more + efficiently on a small subset of the index (allowing wild cards on + the left of terms without excessive penality). Things to know: White space in the entry should match white space in the file name, and is not treated specially. @@ -1655,31 +1653,33 @@ - You can search for exact phrases (adjacent words in a - given order) by enclosing the input inside double quotes. Ex: - "virtual reality". + In all modes except File name, you can + search for exact phrases (adjacent words in a given order) by + enclosing the input inside double quotes. Ex: "virtual + reality". - When using a stripped index, character case has no influence on - search, except that you can disable stem expansion for any term by - capitalizing it. Ie: a search for floor will also - normally look for flooring, - floored, etc., but a search for - Floor will only look for floor, - in any character case. Stemming can also be disabled globally in the - preferences. When using a raw index, the rules are a bit more - complicated. + When using a stripped index (the default), character case has + no influence on search, except that you can disable stem expansion + for any term by capitalizing it. Ie: a search for + floor will also normally look for + flooring, floored, etc., but + a search for Floor will only look for + floor, in any character case. Stemming can also + be disabled globally in the preferences. When using a raw index, + the rules are a bit more + complicated. - &RCL; remembers the last few searches that you - performed. You can use the simple search text entry widget (a - combobox) to recall them (click on the thing at the right of the - text field). Please note, however, that only the search texts - are remembered, not the mode (all/any/file name). + &RCL; remembers the last few searches that you performed. You + can directly access the search history by clicking the clock button + on the right of the search entry, while the latter is + empty. Otherwise, the history is used for entry completion (see + next). Only the search texts are remembered, not the mode + (all/any/file name). - Typing Esc Space while - entering a word in the simple search entry will open a window - with possible completions for the word. The completions are - extracted from the database. + While text is entered in the search area, + recoll will display possible completions, + filtered from the history and the index search terms. This can be + disabled with a GUI Preferences option. Double-clicking on a word in the result list or a preview window will insert it into the simple search entry field. @@ -2861,21 +2861,23 @@ Choose editor - applicationsr: this opens a dialog which allows you + application: this opens a dialog which allows you to select the application to be used to open each MIME - type. The default is nornally to use the - xdg-open utility, but you can override it. + type. The default is to use the xdg-open + utility, but you can use this dialog to override it, setting + exceptions for MIME types that will still be opened according + to &RCL; preferences. This is useful for passing parameters + like page numbers or search strings to applications that + support them (e.g. evince). This + cannot be done with xdg-open which only + supports passing one parameter. - Exceptions: even wen - xdg-open is used by default for opening - documents, you can set exceptions for MIME types that will - still be opened according to &RCL; preferences. This is useful - for passing parameters like page numbers or search strings to - applications that support them - (e.g. evince). This cannot be done - with xdg-open which only supports passing - one parameter. + Disable Qt autocompletion in search + entry: this will disable the completion popup. Il + will only appear, and display the full history, either if you + enter only white space in the search area, or if you click + the clock button on the right of the area. Document filter choice @@ -2890,13 +2892,6 @@ (e.g. Query Language, or the value in use when the program last exited. - Auto-start simple search on white - space entry: if this is checked, a search will be - executed each time you enter a space in the simple search input - field. This lets you look at the result list as you enter new - terms. This is off by default, you may like it or not... - - Start with advanced search dialog open : If you use this dialog frequently, checking the entries will get it to open when recoll starts.