|
a/src/README |
|
b/src/README |
|
... |
|
... |
| 10 |
|
10 |
|
| 11 |
Copyright (c) 2005-2011 Jean-Francois Dockes
|
11 |
Copyright (c) 2005-2011 Jean-Francois Dockes
|
| 12 |
|
12 |
|
| 13 |
This document introduces full text search notions and describes the
|
13 |
This document introduces full text search notions and describes the
|
| 14 |
installation and use of the Recoll application. It currently describes
|
14 |
installation and use of the Recoll application. It currently describes
|
| 15 |
Recoll 1.15.
|
15 |
Recoll 1.16.
|
| 16 |
|
16 |
|
| 17 |
[ Split HTML / Single HTML ]
|
17 |
[ Split HTML / Single HTML ]
|
| 18 |
|
18 |
|
| 19 |
----------------------------------------------------------------------
|
19 |
----------------------------------------------------------------------
|
| 20 |
|
20 |
|
|
... |
|
... |
| 1308 |
configuration file), or later added with recollindex -s (See the
|
1308 |
configuration file), or later added with recollindex -s (See the
|
| 1309 |
recollindex manual). Stemming languages which are dynamically added
|
1309 |
recollindex manual). Stemming languages which are dynamically added
|
| 1310 |
will be deleted at the next indexing pass unless they are also added
|
1310 |
will be deleted at the next indexing pass unless they are also added
|
| 1311 |
in the configuration file.
|
1311 |
in the configuration file.
|
| 1312 |
|
1312 |
|
| 1313 |
* Automatically add phrase to simple searches: a phrase will be
|
1313 |
* Dynamically add phrase to simple searches: a phrase will be
|
| 1314 |
automatically built and added to simple searches when looking for Any
|
1314 |
automatically built and added to simple searches when looking for Any
|
| 1315 |
terms. This will give a relevance boost to the results where the
|
1315 |
terms. This will give a relevance boost to the results where the
|
| 1316 |
search terms appear as a phrase (consecutive and in order).
|
1316 |
search terms appear as a phrase (consecutive and in order).
|
| 1317 |
|
1317 |
|
| 1318 |
* Dynamically build abstracts: synthetic abstracts are constructed by
|
|
|
| 1319 |
extracting context around the search terms out of the main document
|
|
|
| 1320 |
text. This is usually fast because it only uses index content, not the
|
|
|
| 1321 |
actual document, but still can slow down result list display, which is
|
|
|
| 1322 |
why there is a way to turn it off.
|
|
|
| 1323 |
|
|
|
| 1324 |
* Replace abstracts from documents: this decides if the synthetic
|
1318 |
* Replace abstracts from documents: this decides if we should synthesize
|
| 1325 |
abstract above should replace an explicit abstract field found within
|
1319 |
and display an abstract in place of an explicit abstract found within
|
| 1326 |
the document itself, or if the latter should take precedence.
|
1320 |
the document itself.
|
|
|
1321 |
|
|
|
1322 |
* Dynamically build abstracts: this decides if Recoll tries to build
|
|
|
1323 |
document abstracts when displaying the result list. Abstracts are
|
|
|
1324 |
constructed by taking context from the document information, around
|
|
|
1325 |
the search terms. This can slow down result list display significantly
|
|
|
1326 |
for big documents, and you may want to turn it off.
|
| 1327 |
|
1327 |
|
| 1328 |
* Synthetic abstract size: adjust to taste...
|
1328 |
* Synthetic abstract size: adjust to taste...
|
| 1329 |
|
1329 |
|
| 1330 |
* Synthetic abstract context words: how many words should be displayed
|
1330 |
* Synthetic abstract context words: how many words should be displayed
|
| 1331 |
around each term occurrence.
|
1331 |
around each term occurrence.
|
|
... |
|
... |
| 1359 |
of the Query configuration.
|
1359 |
of the Query configuration.
|
| 1360 |
|
1360 |
|
| 1361 |
This is a Qt HTML string where the following printf-like % substitutions
|
1361 |
This is a Qt HTML string where the following printf-like % substitutions
|
| 1362 |
will be performed:
|
1362 |
will be performed:
|
| 1363 |
|
1363 |
|
| 1364 |
* %A. Abstract. Depending on document and query parameters, this can be
|
1364 |
* %A. Abstract
|
| 1365 |
either an explicit abstract field from the document, a "keyword in
|
|
|
| 1366 |
context" synthetic abstract or just the beginning of the document
|
|
|
| 1367 |
text.
|
|
|
| 1368 |
|
1365 |
|
| 1369 |
* %D. Date
|
1366 |
* %D. Date
|
| 1370 |
|
1367 |
|
| 1371 |
* %I. Icon image name
|
1368 |
* %I. Icon image name
|
| 1372 |
|
1369 |
|
|
... |
|
... |
| 1540 |
|
1537 |
|
| 1541 |
The query language processor is activated in the GUI simple search entry
|
1538 |
The query language processor is activated in the GUI simple search entry
|
| 1542 |
when the search mode selector is set to Query Language. It can also be
|
1539 |
when the search mode selector is set to Query Language. It can also be
|
| 1543 |
used with the KIO slave or the command line search. It broadly has the
|
1540 |
used with the KIO slave or the command line search. It broadly has the
|
| 1544 |
same capabilities as the complex search interface in the GUI.
|
1541 |
same capabilities as the complex search interface in the GUI.
|
| 1545 |
Additionally, the query language is for now the only way to access the
|
|
|
| 1546 |
important Recoll field search capabilities.
|
|
|
| 1547 |
|
1542 |
|
| 1548 |
The language is roughly based on the Xesam user search language
|
1543 |
The language is roughly based on the Xesam user search language
|
| 1549 |
specification.
|
1544 |
specification.
|
| 1550 |
|
1545 |
|
| 1551 |
If the results of a query language search puzzle you and you doubt what
|
1546 |
If the results of a query language search puzzle you and you doubt what
|
|
... |
|
... |
| 2864 |
|
2859 |
|
| 2865 |
If this is set, the aspell dictionary generation is turned off.
|
2860 |
If this is set, the aspell dictionary generation is turned off.
|
| 2866 |
Useful for cases where you don't need the functionality or when it
|
2861 |
Useful for cases where you don't need the functionality or when it
|
| 2867 |
is unusable because aspell crashes during dictionary generation.
|
2862 |
is unusable because aspell crashes during dictionary generation.
|
| 2868 |
|
2863 |
|
| 2869 |
guesscharset
|
|
|
| 2870 |
|
|
|
| 2871 |
Decide if we try to guess the character set of files if no
|
|
|
| 2872 |
internal value is available (ie: for plain text files). This does
|
|
|
| 2873 |
not work well in general, and should probably not be used.
|
|
|
| 2874 |
|
|
|
| 2875 |
----------------------------------------------------------------------
|
2864 |
----------------------------------------------------------------------
|
| 2876 |
|
2865 |
|
| 2877 |
5.4.2. The fields file
|
2866 |
5.4.2. The fields file
|
| 2878 |
|
2867 |
|
| 2879 |
This file contains information about dynamic fields handling in Recoll.
|
2868 |
This file contains information about dynamic fields handling in Recoll.
|