From 8305bb37c0bdd1a36308ff1aa42f290d167ad4cf Mon Sep 17 00:00:00 2001 From: Jean-Francois Dockes Date: Mon, 7 Oct 2013 12:03:54 +0200 Subject: [PATCH] doc --- website/filters/filters.html | 79 ++++++++++++++++++------------------ 1 file changed, 40 insertions(+), 39 deletions(-) diff --git a/website/filters/filters.html b/website/filters/filters.html index e0894eeb..e3ac1515 100644 --- a/website/filters/filters.html +++ b/website/filters/filters.html @@ -35,11 +35,11 @@

Updated filters for Recoll

The following describe new and updated filters, which will be - part of the next release, but can be installed on the current - release if you need them.

+ part of the next release, but can be installed on an older + release if you need them.

For updated filters, you just need to copy the script to the - filters directory which may be typically either /usr/share/recoll/filters, or /usr/local/share/recoll/filters. Please check that the script is executable after copying it, and make it so if @@ -62,44 +62,50 @@ these updated and complete versions: mimemap mimeconf - mimeview

+ mimeview.

-
-

There is a new rclepub filter for EPUB ebooks. It is new for - all recoll versions before 1.18.0.

-

rclchm needs to be updated for all Recoll versions up - to and including 1.17.1.

-

If you are running an older Recoll version, you really - should upgrade.

-
+

There is a slightly more detailed description of the filter + installation procedure on the + + Recoll Wiki.

+

The following entries are in reverse chronologic order. Each + lists the latest Recoll release on which the update makes sense + (newer releases have an up to date version of the filter).

-

EPUB documents

+

However, if you are running a Recoll version older than 1.17, + you should really upgrade.

+ +

EPUB documents (1.17 and older)

New rclepub filter for EPUB documents. This needs the - python epub decoding module. The mimeview/mimemap and - mimeconf files in this directory have the appropriate - entries.

+ python epub decoding module.

-

Updated Open Document filter

+

CHM files (1.17.1 and older)

+

rclchm. The previous version of the + filter mishandled files which had encoded internal URLs (not + very frequent, but happens).

+ +

Updated Open Document filter (1.17 and older)

The new filter will correctly handle - exported Google Docs - documents and also Open/LibreOffice ones in some cases. The - previous filters concatenated all the text inside the exported - Google docs without any spacing...

+ exported Google Docs documents and also Open/LibreOffice ones in + some cases. The previous filters concatenated all the text + inside the exported Google docs without any spacing...

-

TAR archives

+

TAR archives (1.17 and older)

New rcltar filter for tar archives. The indexing of tar archives is disabled by default in the sample - configuration (stored here). You'll need to add - an application/x-tar = execm rcltar line in the - [index] section of your $HOME/mimeconf to enable it.

+ configuration (stored here). This is an execm + filter !. You'll need to add an
+ application/x-tar = execm rcltar
+ line in the [index] section of your + $HOME/mimeconf to enable it, not an exec one.

-

XML files

+

XML files (1.17 and older)

By default, the current recoll version does not index xml content (except for known formats like dia, svg etc.). This @@ -109,24 +115,19 @@ one (see comment in mimeconf), and index everything, including a lot of garbage.

- -

DIA files

+

DIA files (1.16 and older)

rcldia is a new filter for Dia files, contributed by Stefan Friedel.

-

CHM files

-

rclchm. The previous version of the - filter mishandled files which had encoded internal URLs (not - very frequent, but happens).

-

Okular annotations

+

Okular annotations (1.16 and older)

rclokulnote. Okular lets you create annotations for PDF documents and stores them in xml format somewhere under ~/.kde. This filter does not do a nice job to format the data, but will at least let you find it...

-

Gnumeric

+

Gnumeric (1.16 and older)

rclgnm. Needs xsltproc and gunzip. As .gnumeric was in the list of explicitely ignored suffixes, you can't just add the mime @@ -136,25 +137,25 @@ contains .gnumeric). The simplest approach may be to just replace the system files with those above.

-

Rar archive support

+

Rar archive support (1.15 and older)

rclrar. This is up to date in Recoll 1.16.2 but may be added to Recoll 1.15. It needs the Python rarfile module.

-

Mimehtml support

+

Mimehtml support (1.15)

This is based on the internal mail filter, you just need to download and install the configuration files (mimemap and mimeconf. Will only work with 1.15 and later.

-

Konqueror webarchive (.war) filter

+

Konqueror webarchive (.war) filter (1.15)

rclwar

-

Updated zip archive filter

+

Updated zip archive filter (1.15)

The filter is corrected to handle utf-8 paths in zip archives: rclzip. Up to date in Recoll 1.16, but may be useful with Recoll 1.15

-

Updated audio tag filter

+

Updated audio tag filter (1.14)

The mutagen-based rclaudio filter delivered with recoll 1.14.2 used a very recent mutagen interface which will only work with mutagen versions after 1.17 (probably. at least works with 1.19,