tris/recoll
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

kio doc

Browse Source
This commit is contained in:
Jean-Francois Dockes 2022-08-10 13:37:41 +02:00
parent 00f29bf3ed
commit 38fa35402a
2 changed files with 30 additions and 123 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
src/doc/user/usermanual.xml
View File

@ -3807,68 +3807,15 @@ fs.inotify.max_user_watches=32768
<sect1 id="RCL.SEARCH.KIO">
<title>Searching with the KDE KIO slave</title>
<sect2 id="RCL.SEARCH.KIO.INTRO">
<title>What's this</title>
<para>The &RCL; KIO slave allows performing a &RCL; search by entering an appropriate URL in a
KDE open dialog, or a <command>Dolphin</command> URL. The results are displayed as
directory entries.</para>
<para>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
<command>Konqueror</command>.</para>
<para>The instructions for building this module are located in the source
tree. See: <filename>kde/kio/recoll/00README.txt</filename>. 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.</para>
<para>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.</para>
<para>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).</para>
<para>The interface is described in more detail inside a help
file which you can access by entering
<filename>recoll:/</filename> inside the
<command>konqueror</command> URL line (this works only if the
recoll KIO slave has been previously installed).</para>
<para>The instructions for building this module are located in the
source tree. See:
<filename>kde/kio/recoll/00README.txt</filename>. 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.</para>
</sect2>
<sect2 id="RCL.SEARCH.KIO.SEARCHABLEDOCS">
<title>Searchable documents</title>
<para>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
<command>konqueror</command>.</para>
<para>This can be done by either explicitly inserting
<literal><![CDATA[<a href="recoll://...">]]></literal> links
around some document areas, or automatically by adding a
very small <application>javascript</application> program to the
documents, like the following example, which would initiate a search by
double-clicking any term:</para>
<programlisting>&lt;script language="JavaScript">
function recollsearch() {
var t = document.getSelection();
window.location.href = 'recoll://search/query?qtp=a&amp;p=0&amp;q=' +
encodeURIComponent(t);
}
&lt;/script>
....
&lt;body ondblclick="recollsearch()">
</programlisting>
</sect2>
</sect1>

86
src/kde/kioslave/kio_recoll/data/help.html
View File

@ -4,87 +4,47 @@
<title>Recoll Kio Slave</title>
</head>
<body>
<a href="recoll:///search.html">Recoll search</a>
<h2>Recoll kio slave</h2>
<h2>Recoll KDE KIO slave</h2>
<p>Use this module to perform Recoll searches from any program with
a KIO interface.</p>
<p>Use this module to perform Recoll searches from any program with a KIO interface.</p>
<p>The module can work in two modes:</p>
<p>The module used to work in two modes:</p>
<ul>
<li><b>Html interface</b>, close to a simplified QT Recoll
interface.</li>
<li><b>File manager interface</b>, <em>Only with KDE 4.1 and
newer</em>, which presents results as directory entries</li>
newer</em>, which presents results as directory entries</li>
<li><b>HTML interface</b>, close to a simplified QT Recoll interface.</li>
</ul>
<p>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.</p>
<p>The HTML interface has been broken for some time (2022), and only the file manager interface
currently works (in, e.g., Dolphin or Konqueror).</p>
<p>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 <a href="mailto:jfd@recoll.org"> report it</a>.</p>
<p>The module is particularly unhelpful with search hits inside
email folders, which Konqueror or Dolphin have no way to access.</p>
you have any remarks or ideas about improving kio_recoll, or observe an interesting and
reproducible sequence, please <a href="mailto:jfd@recoll.org"> report it</a>.</p>
<h3>File manager (e.g. Dolphin) interface</h3>
<h3>File manager interface</h3>
<p>The <i>path</i> part of the URI is taken as a Recoll query
language string and executed. The results are displayed as
directory entries.</p>
<p>The <i>path</i> part of an URI with a <i>recoll:</i> scheme
(e.g. <i>recoll:&nbsp;some&nbsp;query</i>) is taken as a
<a href="https://www.lesbonscomptes.com/recoll/usermanual/webhelp/docs/RCL.SEARCH.LANG.html">
Recoll query language</a> string and
executed. The results are displayed as directory entries.</p>
<p>No search result details (samples, relevance etc.) are available, but this interface allows
multiple selections and copies, usage inside any KDE open dialog, etc.</p>
<p>There are several ways to enter this interface:</p>
<ul>
<li>Dolphin will only present the file manager interface. Enter
<i>recoll:/some&nbsp;query</i>
or <i>recoll:&nbsp;some&nbsp;query</i> in the address bar. Note:
single-slash, not double, you will get something like "Protocol
unknown" if you enter 2 slashes.</li>
<li>Konqueror: this supports both the file manager and HTML
interfaces. You can force using the file manager interface in the
following ways:
<ul>
<li>Using "recollf" as protocol name instead of "recoll". This is
probably the easiest option inside open dialogs.</li>
<li>Using an URL ending with a&nbsp;'/', ie:
<blockquote>
<a href="recoll:/red apples ext:html/">
recoll:/red apples ext:html/</a>
</blockquote>
</li>
<li>If you would like to use the file manager view most of the
time, you can set the <code>RECOLL_KIO_ALWAYS_DIR</code> environment
variable or the <code>kio_always_dir</code> recoll.conf variable
to&nbsp;1. The HTML interface will then only be accessible
through the search link in the top "recoll:" view.</li>
</ul>
</ul>
<p>No search result details (samples, relevance etc.) are available,
but this interface allows multiple selections and copies, usage
inside any KDE open dialog, etc.</p>
<p>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 <code>kio_max_direntries</code>
parameter in your recoll configuration file (typically
~/.recoll/recoll.conf)</p>
<p><a href="recoll:///search.html">Recoll Search</a></p>
<p>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 <code>kio_max_direntries</code> parameter in
your recoll configuration file (typically ~/.recoll/recoll.conf)</p>
<h3>(Obsolete) HTML interface</h3>
<p>This used to work in konqueror, but appears to be broken in recent konqueror versions. Doc
<p>This used to work in Konqueror, but appears to be broken in recent Konqueror versions. Doc
kept for nostalgy.</p>
<p>This works more or less like the Recoll QT GUI, much simplified. The
<a href="http://www.recoll.org/usermanual/rcl.search.lang.html">
<a href="https://www.lesbonscomptes.com/recoll/usermanual/usermanual.html#RCL.SEARCH.LANG">
Recoll manual</a> describes the queries that can be performed.</p>
<p>Most pages in the interface should quite self-explanatory.</p>