recollrunner

Recollrunner 0.6

This is a simple, down-and-dirty, recoll plugin fro krunner for those of us
still resisting the use of Nepomuk because of its resource usage.

Recoll's indexing runs nicely, niced to 19, unnoticed, in the background.
Hopefully, someday soon, all of KDE's background processes will do the same!

Suggestions and participation most welcome. TRANSLATIONS?

-- Build instructions --

cd /where/your/runner/is/installed

If you compiled you recoll, set the correct path to the icon in the .desktop.
Recoll should be on your PATH. If not, set RECOLLCMD in recollrunner.h

mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=$KDEDIRS ..
make
make install (with root privileges)
kbuildsycoca4 (if this be your first install of recollrunner)

(your $KDEDIRS is where you install your KDE 4)

Restart krunner or plasma to load the runner

Alt-F2 to launch KRunner and in the runners list you will find your runner.

0.2:
Full configuration options for Recoll's CLI, runner options for refining search.

0.3:
Corrections to command line issued for file name searches.
Corrections to parsing of recoll CLI output.
Access to configuration from the main view's activity icon.

0.4

Corrected in and out codepage onversions for non-ASCII paths in searches and krunner display. Note that base system bash LANG codepage must be consistent
with that of the KDE desktop. Indexing needs be rerun if these are changed.
Größe Danke to Jean Dockes, recoll author, and Denis Prost, a French user, for their help and great patience sorting this one out!

Improved icon handling as suggested in KDE's development tutorials.

Assign relevance to get executables (see below) first and directories before other file entries.

Option to include or not include non-file hits such as obsolete index entries. Of course, one will not be able to open these. Useful also for diagnostics.

Option to include an entry to run the query in recoll's GUI application or using the kio_recoll protocol in Dolphin as requested by sxe. Note that kio-recoll might not be packaged in the distro and then one might need to install from recoll sources. Neither will use recollrunner's filter options and kio_recoll only runs a default query.

Option to mark or not mark (general krunner default) content entries.

Version 0.5

Implement Recoll 1.16.2 capabilities which is now required:

Parse using recommended and assured base64 encodings

Inclusion of recoll index parameters made available in new version:

Sorts by relevancy, doc name, date or mimetype. Recoll CLI handles the sorts but the runner maps them to groups for directories, files, and non-file entries if there are any and this is enabled.

Hits with minimum relevancy.

There is now an alternate viewer for the available file properties. This viewer can scroll through the selections and the document can be opened from the viewer. As opposed to the default runner action, the viewer dialog remains active and additional documents may be opened from it. This is, in effect, an alternate GUI for recoll using krunner. Could be a code foundation for standalone or plasmoid interface to recoll using the runner.

Additional options to help refine the number of hits:

Option to exclude archives. Archives can produce numerous hits and what the runner opens is the archive rather than the cited document.

Option to require a prefix (syntax). Recoll selections can very easily swamp
krunner which can show a limited number of selections. Using the syntax, one can
use recollrunner or not by choice. Note that the default "recoll:" may also enable a http interface for kio_recoll. Also useful and nicer than the requested kio_recoll into dolphin.

Version 0.6

Default runner action to use open file or launch the viewer GUI. This can be changed per session from the run options menu (click on tool icon at right).

Viewer can launch the configuration dialog with a page added for a new query. The page displays help for the Recoll query syntax.