From 38fa35402a5c9704c19e9288ba3e1e3b5c74db77 Mon Sep 17 00:00:00 2001 From: Jean-Francois Dockes Date: Wed, 10 Aug 2022 13:37:41 +0200 Subject: [PATCH] kio doc --- src/doc/user/usermanual.xml | 67 ++--------------- src/kde/kioslave/kio_recoll/data/help.html | 86 ++++++---------------- 2 files changed, 30 insertions(+), 123 deletions(-) diff --git a/src/doc/user/usermanual.xml b/src/doc/user/usermanual.xml index a7b28bee..f4b17f4b 100644 --- a/src/doc/user/usermanual.xml +++ b/src/doc/user/usermanual.xml @@ -3807,68 +3807,15 @@ fs.inotify.max_user_watches=32768 Searching with the KDE KIO slave - - What's this + The &RCL; KIO slave allows performing a &RCL; search by entering an appropriate URL in a + KDE open dialog, or a Dolphin URL. The results are displayed as + directory entries. - The &RCL; KIO slave allows performing a &RCL; search - by entering an appropriate URL in a KDE open dialog, or with an - HTML-based interface displayed in - Konqueror. + The instructions for building this module are located in the source + tree. See: kde/kio/recoll/00README.txt. Some Linux distributions do + package the kio-recoll module, so check before diving into the build process, maybe it's + already out there ready for one-click installation. - The HTML-based interface is similar to the Qt-based - interface, but slightly less powerful for now. Its advantage is - that you can perform your search while staying fully within the - KDE framework: drag and drop from the result list works normally - and you have your normal choice of applications for opening - files. - - The alternative interface uses a directory view of search - results. Due to limitations in the current KIO slave interface, - it is currently not obviously useful (to me). - - The interface is described in more detail inside a help - file which you can access by entering - recoll:/ inside the - konqueror URL line (this works only if the - recoll KIO slave has been previously installed). - - - The instructions for building this module are located in the - source tree. See: - kde/kio/recoll/00README.txt. Some Linux - distributions do package the kio-recoll module, so check before - diving into the build process, maybe it's already out there ready for - one-click installation. - - - - - Searchable documents - - As a sample application, the &RCL; KIO slave could allow - preparing a set of HTML documents (for example a manual) so that - they become their own search interface inside - konqueror. - - This can be done by either explicitly inserting - ]]> links - around some document areas, or automatically by adding a - very small javascript program to the - documents, like the following example, which would initiate a search by - double-clicking any term: - - <script language="JavaScript"> - function recollsearch() { - var t = document.getSelection(); - window.location.href = 'recoll://search/query?qtp=a&p=0&q=' + - encodeURIComponent(t); - } - </script> - .... - <body ondblclick="recollsearch()"> - - - diff --git a/src/kde/kioslave/kio_recoll/data/help.html b/src/kde/kioslave/kio_recoll/data/help.html index 2db64f80..97608ea8 100644 --- a/src/kde/kioslave/kio_recoll/data/help.html +++ b/src/kde/kioslave/kio_recoll/data/help.html @@ -4,87 +4,47 @@ Recoll Kio Slave - Recoll search -

Recoll kio slave

+

Recoll KDE KIO slave

-

Use this module to perform Recoll searches from any program with - a KIO interface.

+

Use this module to perform Recoll searches from any program with a KIO interface.

-

The module can work in two modes:

+

The module used to work in two modes:

-

With recent KDE versions (now: 2016), the file manager - interface works in Dolphin, and both the file manager and the HTML - interface work in Konqueror.

+

The HTML interface has been broken for some time (2022), and only the file manager interface + currently works (in, e.g., Dolphin or Konqueror).

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 or Dolphin have no way to access.

+ you have any remarks or ideas about improving kio_recoll, or observe an interesting and + reproducible sequence, please report it.

-

File manager (e.g. Dolphin) interface

+

File manager interface

-

The path part of the URI is taken as a Recoll query - language string and executed. The results are displayed as - directory entries.

+

The path part of an URI with a recoll: scheme + (e.g. recoll: some query) is taken as a + + Recoll query language string and + executed. The results are displayed 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.

-

There are several ways to enter this interface:

- - -

No search result details (samples, relevance etc.) are available, - but this interface allows multiple selections and copies, usage - inside any KDE open dialog, etc.

- -

To avoid swamping the interface with too many thousands of - results, the result count is limited to 10000 by default. You can - change this value by setting the kio_max_direntries - parameter in your recoll configuration file (typically - ~/.recoll/recoll.conf)

- -

Recoll Search

+

To avoid swamping the interface with too many results, the result count is limited to 10000 by + default. You can change this value by setting the kio_max_direntries parameter in + your recoll configuration file (typically ~/.recoll/recoll.conf)

(Obsolete) HTML interface

-

This used to work in konqueror, but appears to be broken in recent konqueror versions. Doc +

This used to work in Konqueror, but appears to be broken in recent Konqueror versions. Doc kept for nostalgy.

This works more or less like the Recoll QT GUI, much simplified. The - + Recoll manual describes the queries that can be performed.

Most pages in the interface should quite self-explanatory.