The manual will be progressively updated for Windows. Until this happens, most
- references to files can be translated by looking under the
- Recoll installation directory (esp. the Windows. The manual will be
+ progressively updated. Until this happens, most references to
+ shared files can be translated by looking under the Recoll
+ installation directory (esp. the Share subdirectory). The user configuration
is stored by default under AppData/Local/Recoll inside the user
@@ -546,12 +543,18 @@ alink="#0000FF">
the Top directories
section).
Also be aware that you may need to install the - appropriate supporting - applications for document types that need them (for - example antiword for - Microsoft Word files).
+Also be aware that, on Unix/Linux, you may need to + install the appropriate supporting applications + for document types that need them (for example antiword for Microsoft Word files).
+ +The Recoll installation + for Windows is + self-contained and includes most useful auxiliary programs. + You will just need to install Python 2.7.
There are a number of different uses for synonyms in - text search. They can be used at index time (either to - increase or decrease the number of indexed terms), or at - query time, to reduce user terms to a set of canonical - ones, or to expand queries to match texts containing - synonyms of the user terms.
+Term synonyms: there are a number of ways to + use term synonyms for searching text:
-Only the last approach is used in Recoll. Synonym groups can be defined - so that a user query term which is found to be part of a - synonym group will be optionally expanded into an OR query - for all synonyms.
+At index creation time, they can be used to alter + the indexed terms, either increasing or decreasing + their number, by expanding the original terms to all + synonyms, or by reducing all synonym terms to a + canonical one.
+What is it good for ? The synonyms function is probably - not going to help you find your letters to Mr. Smith. It is - best used for domain-specific searches. For example, it was - initially suggested by a user performing searches among - historical documents: the synonyms file would contains - nicknames and aliases for each of the persons of - interest.
+At query time, they can be used to match texts + containing terms which are synonyms of the ones + specified by the user, either by expanding the query + for all synonyms, or by reducing the user entry to + canonical terms (the latter only works if the + corresponding processing has been performed while + creating the index).
+In practise, synonym groups are defined inside ordinary - text files. Each line in the file defines a group. - Example:
+Recoll only uses
+ synonyms at query time. A user query term which part of a
+ synonym group will be optionally expanded into an
+ OR query for all terms in the
+ group.
Synonym groups are defined inside ordinary text files. + Each line in the file defines a group.
+ +Example:
hi hello "good morning"
@@ -4601,29 +4614,39 @@ bye goodbye "see you" \
- As usual lines beginning with a As usual, lines beginning with a # are comments, empty lines are ignored,
and lines can be continued by ending them with a
backslash.
The synonyms are searched for matches with user terms - after these are stem-expanded, but the contents of the - synonyms file itself is not subjected to stem expansion - (1.22). This means that a match will not be found if the - form present in the synonyms file is not present anywhere - in the document set.
-Multi-word synonyms are supported, but be aware that these will generate phrase queries, which may degrade - performance (and also, no stemming).
+ performance and will disable stemming expansion for the + phrase terms. -A synonyms file can be specified in the GUI preferences, - or as an option to recollq.
+The synonyms file can be specified in the Search parameters tab of the GUI configuration Preferences menu entry, or as an option + for command-line searches.
-This feature is new in Recoll 1.22 and will probably need to - be refined after some user feedback.
+Once the file is defined, the use of synonyms can be + enabled or disabled directly from the Preferences menu.
+ +The synonyms are searched for matches with user terms + after the latter are stem-expanded, but the contents of the + synonyms file itself is not subjected to stem expansion. + This means that a match will not be found if the form + present in the synonyms file is not present anywhere in the + document set.
+ +The synonyms function is probably not going to help you + find your letters to Mr. Smith. It is best used for + domain-specific searches. For example, it was initially + suggested by a user performing searches among historical + documents: the synonyms file would contains nicknames and + aliases for each of the persons of interest.