diff --git a/src/doc/user/usermanual.sgml b/src/doc/user/usermanual.sgml index 5e8dee3e..16c460f0 100644 --- a/src/doc/user/usermanual.sgml +++ b/src/doc/user/usermanual.sgml @@ -2,7 +2,7 @@ Recoll"> Recoll helper applications page"> - + Xapian"> ]> @@ -20,7 +20,7 @@ - 2005-2011 + 2005-2012 Jean-Francois Dockes @@ -1511,20 +1511,12 @@ fvwm interface itself, the parameters used for searching and returning results, and what indexes are searched. + User interface parameters: - Number of results in a result - page: - - - Hide duplicate results: - decides if result list entries are shown for identical - documents found in different places. - - Highlight color for query terms: Terms from the user query are highlighted in the result list samples and the preview window. The color can @@ -1533,26 +1525,15 @@ fvwm default is blue. - Result list font: There is - quite a lot of information shown in the result list, and you - may want to customize the font and/or font size. The rest of - the fonts used by &RCL; are determined by your generic Qt - config (try the qtconfig command). - - - - Result paragraph format string: - allows you to change the presentation of each result list - entry. This is - described in its own section. - - - - Abstract snippet separator: - for synthetic abstracts built from index data, which are - usually made of several snippets from different parts of the - document, this defines the snippet separator, an ellipsis by - default. + Style sheet: + The name of a Qt style sheet + text file which is applied to the whole Recoll application + on startup. The default value is empty, but there is a + skeleton style sheet (recoll.qss) + inside the /usr/share/recoll/examples + directory. Using a style sheet, you can change most Recoll + graphical parameters: colors, fonts, etc. See the sample + file for a few simple examples. Maximum text size highlighted for @@ -1562,6 +1543,25 @@ fvwm text size to speed up loading. + Prefer HTML to plain text for + preview if set, Recoll will display HTML as such + inside the preview window. If this causes problems with the Qt + HTML display, you can uncheck it to display the plain text + version instead. + + + Use <PRE> tags instead of + <BR> to display plain text as HTML in preview: + when displaying plain text inside the preview window, &RCL; + tries to preserve some of the original text line breaks and + indentation. It can either use PRE HTML tags, which will + well preserve the indentation but will force horizontal + scrolling for long lines, or use BR tags to break at the + original line breaks, which will let the editor introduce + other line breaks according to the window width, but will + lose some of the original indentation. + + Use desktop preferences to choose document editor: if this is checked, the xdg-open utility will be used to open files @@ -1601,24 +1601,62 @@ fvwm stat between invocations. It normally starts with sorting disabled. - Prefer HTML to plain text for preview - - if set, Recoll will display HTML as such inside the - preview window. If this causes problems with the Qt HTML - display, you can uncheck it to display the plain text version - instead. - + + Result list parameters: + + + + Number of results in a result + page + + + Result list font: There is + quite a lot of information shown in the result list, and you + may want to customize the font and/or font size. The rest of + the fonts used by &RCL; are determined by your generic Qt + config (try the qtconfig command). + + + + Result paragraph format string: + allows you to change the presentation of each result list + entry. This is + described in its own section. + + + + Date format: allows specifying the + format used for displaying dates inside the result list. This + should be specified as an strftime() string (man strftime). + + + + Abstract snippet separator: + for synthetic abstracts built from index data, which are + usually made of several snippets from different parts of the + document, this defines the snippet separator, an ellipsis by + default. + + + + + Search parameters: + Hide duplicate results: + decides if result list entries are shown for identical + documents found in different places. + + Stemming language: stemming obviously depends on the document's language. This listbox will let you chose among the stemming databases which @@ -1631,7 +1669,7 @@ fvwm file. - Dynamically add phrase to simple + Automatically add phrase to simple searches: a phrase will be automatically built and added to simple searches when looking for Any terms. This will give a relevance boost to the @@ -1639,6 +1677,13 @@ fvwm and in order). + Autophrase term frequency threshold + percentage: very frequent terms should not be included + in automatic phrase searches for performance reasons. The + parameter defines the cutoff percentage (percentage of the + documents where the term appears). + + Replace abstracts from documents: this decides if we should synthesize and display an abstract in place of an explicit abstract found @@ -3271,16 +3316,6 @@ while query.next >= 0 and query.next < nres: place ($HOME/.config/Recoll.org/recoll.conf). You probably do not want to edit this by hand. - One of these parameters is the name of a - Qt style sheet text file which is applied - to the whole Recoll application on startup. The default value is - empty, but there is a skeleton style sheet - (recoll.qss) inside the - /usr/share/recoll/examples directory. Using a - style sheet, you can change most Recoll graphical parameters: colors, - fonts, etc. See the sample file for a few simple examples. - - &RCL; indexing options are set inside text configuration files located in a configuration directory. There can be several such directories, each of which define the parameters