Recollrunner 0.1

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!

Version 0.2

Full configuration options for Recoll's CLI runner options for refining search.
Note: Since there are new .desktop files, run kbuildsyscoca4.

Version 0.3

Corrected recoll CLI output parsing. According to the author, this is still not
guaranteed as the text parsed as a file path URL is not completely legal as such.
As changes are made here, recollrunner will be updated accordingly.

Corrected file name search syntax. Note that this is an exclusive option and
other query syntax does not apply in file name searches. Note that name text
beginning with a capital letter is directly quoted, otherwise the implication is
a wildcard search *text*. This, again, may be changed in the future.

Implemented "live" configuration and re-search from "activities" icon. This may
not be "legal" usage in a runner, but since this is a data search, being able
to refine the search with far fewer clicks is a desirable convenience. As of
now, changing the options here will NOT refresh the search--One must make some
change, i.e. delete and replace a letter to do so. Still quicker than redoing
everything. If someone can figure out how to hack in this functionality, let me
know :-)

Version 0.4

Corrected in and out codepage conversions 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.

This will be the last version working with recoll < 1.16.2. The newer recoll
introduces many more CLI options for more consistent parsing and much more
capability. So stay tuned!

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 krunner 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.

This could be considered feature complete (or over-kill) now.

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 (to make sure runner and its desktop file are installed)

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

Restart krunner or plasma to load the runner or newer version.

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