diff --git a/src/kde/kioslave/recoll/data/help.html b/src/kde/kioslave/recoll/data/help.html index d6619ade..6e86f180 100644 --- a/src/kde/kioslave/recoll/data/help.html +++ b/src/kde/kioslave/recoll/data/help.html @@ -5,60 +5,86 @@
Recoll search -Use this module to perform Recoll searches from any program with - a KIO interface (sort of...). kio_recoll is primarily + a KIO interface. kio_recoll is primarily designed and tested with konqueror, and you will undoubtedly get even more surprising effects with other tools.
-The module can work in two different modes, depending on the form - of the URLS that it is given:
-The module can work in two modes:
+Please note that this module is still in its infancy and that it - is still more a toy than anything else. The semantics of the - KIO slaves interface is still a bit unstable between KDE releases, - you will certainly get surprising effects from time to time.
+The module is still in its infancy. You will undoubtedly obtain + strange effects from time to time. If you have any remarks or + ideas about improving kio_recoll, or observe an interesting and + reproducible sequence, please + report it.
-The module is particularly unhelpful with search hits inside + email folders, which Konqueror has no way to access.
-This works more or less like the Recoll QT GUI, much - simplified. The + +
This works more or less like the Recoll QT GUI, much simplified. The - Recoll manual describes the queries that can be - performed.
+ Recoll manual describes the queries that can be performed. +Most pages in the interface should quite self-explanatory.
-You normally enter this interface by entering "recoll:" or
+ "recoll:/" in the Konqueror URL entry, and following the "search"
+ link.
In most circumstances, entering a link like
+ "recoll:/some search terms" will also yield an HTML result
+ list.
kio_recoll enters this mode when it receives an URL ending with - a '/', ie:
-recoll:///xapian recoll ext:.html/+ +
Search results are returned as directory entries. No search + result details (samples, relevance etc.) are available, but this + interface allows multiple selections and copies, usage inside any + KDE open dialog, etc.
The path part of the URI is taken as a Recoll query language string and executed. The results are displayed as directory entries.
-This works fine with normal documents, very badly with message - inside folders, which Konqueror has no way to access.
+To avoid swamping the interface with thousands of results, the
+ result count is limited to 100 by default. You can change this value
+ by setting the kio_max_direntries parameter in your recoll
+ configuration file (typically ~/.recoll/recoll.conf)
As there is no provision to page directory listings, the number - of results returned is limited to a fixed value, 100 by default, - which you can change by setting the kio_max_direntries in your - Recoll configuration file (usually ~/.recoll). - - More information about Recoll configuration.
+There are several ways to enter this interface:
+This interface is very limited, but allows performing multiple - selection, copies, and other file operations on the results, which - may be useful in some cases (or not :))
+recoll:/red apples ext:.html/
kio_max_direntries
+ limit. In most cases, you will have to reload the file
+ manager page to obtain this synchronization.RECOLL_KIO_ALWAYS_DIR environment
+ variable or the kio_always_dir recoll.conf variable
+ to 1. The HTML interface will then only be accessible
+ through the search link in the top "recoll:" view.