From 4eaf47acb9e4202978e54410f87717df4ceeba23 Mon Sep 17 00:00:00 2001 From: Jean-Francois Dockes Date: Thu, 21 Jan 2016 18:05:38 +0100 Subject: [PATCH] web --- website/BUGS.html | 36 +- website/CHANGES.html | 2 +- website/credits.html | 2 +- website/custom.html | 4 +- website/download.html | 755 +++++++++++++++++++------------------- website/features.html | 4 +- website/helpernotes.html | 2 +- website/id3lib.html | 2 +- website/index.html.en | 9 +- website/release-1.16.html | 2 +- 10 files changed, 429 insertions(+), 389 deletions(-) diff --git a/website/BUGS.html b/website/BUGS.html index 9adeb84d..2fa33b9b 100644 --- a/website/BUGS.html +++ b/website/BUGS.html @@ -29,9 +29,43 @@ later versions. Bugs listed in the topmost section may also exist in older versions.

-

recoll 1.22.0

+

recoll 1.21.4, 1.22.0

@@ -88,7 +88,7 @@ a:hover .PZ3cap { padding:3px 5px; } "almost full" support for HTML capabilities, with a few restrictions due to the Qt QTextBrowser object. The details are described in the - + Recoll manual.

As of Recoll 1.17, the result list is a WebKit object by diff --git a/website/download.html b/website/download.html index 0f3beed7..68a9d024 100644 --- a/website/download.html +++ b/website/download.html @@ -1,422 +1,421 @@ - - Recoll download - - - - - - - + + Recoll download + + + + + + + - + - + - + -

- -
- -
-

Recoll downloads

- -
- - - - - - - - - - - - - - -
- General - Source - Linux Packages (.rpm and .deb) - Windows - Known bugs - Mac ports - Updated Filters - Translations
-
- -
-

General information

- -

The current version is 1.21.4. Release - notes.

- -

Recoll Installation / building -manual.

- -

The indexing filters used for some document types may need external -packages not installed on your system by default, and not installed -automatically with Recoll: take a -look at the list and decide what you need to install.

- -

The Recoll term explorer tool in phonetic mode (marginally useful and -optional) uses the aspell package, version 0.60 (utf-8 support) or -newer.

- -

If you find problems with this page, the package or its installation, -please report them.

- -

What do the release numbers mean?

- -

The Recoll releases are numbered X.Y.Z. The X would only change for really -major modifications like a big change in the index format, and possibly won't -ever reach 2.

- -

Y is for functional modifications. These may bring bugs, so if you don't -need the new features, you may want to wait a little, and especially skip the -first release (X.Y.0), at least for a few weeks.

- -

Z changes for bug fixes only, and moving from X.Y.Z -to X.Y.Z+u should in general involve little risk of regression. But, -any change can bring problems, if you are not affected by the -corrected bugs (check the release file), there -is probably no necessity to upgrade anyway.

-
- -
-

Known bugs

-

There is a history of known bugs, sorted - by fix release. Also see - the - issue tracker on Bitbucket. -

-
- -
-

Source

- -

Current release distribution: 1.21.4:

- - -

recoll-1.21.4.tar.gz.

- - - -

Ubuntu Unity Lens and Scope

- -

You will probably get these from the PPA, but - here are the source files. These are not included in the main tar file - any more. For recoll 1.19, 1.20 and 1.21 installations (choose on the - Ubuntu version, not the Recoll one): - -

- - recoll-lens-1.19.10.3543.tar.gz (Recoll 0.19 or 0.20, -Ubuntu up to 13.04 Raring)
- - - unity-scope-recoll-1.20.2.4.tar.gz (Recoll 0.19 or 0.20, Ubuntu - 13.10 and later).
- -
- -For Recoll 1.18: -recoll-lens-1.18.1.2997.tar.gz
-For Recoll 1.17: -recoll-lens-1.17.2.2697.tar.gz - -

- -

Prerequisites for building from source:

-
    -
  • C++ compiler. Its absence sometimes manifests itself by strange messages - about iconv_open (fixed after 1.13.04).
    • -

  • Xapian core development libraries. Most Linux distributions carry them - in their package repository. Or you will find source and binary packages on - the Xapian download page. -
    - Recoll should still work with Xapian 1.0, but it is highly recommended to - use a Xapian 1.2 version.

    -

    Note on building Xapian for older CPUs: The build - configurations for Xapian releases 1.0.21 and 1.2.1 or newer enable the use - of SSE2 floating point instructions. These instructions are not available - in CPUs older than Intel Pentium 4 or AMD Athlon 64. When building for such - a CPU, you need to add the --disable-sse flag to the Xapian library - configure command. If this is not done, the problem signals itself by - "Illegal instruction" crashes (SIGILL) in recollindex and recoll.

    -
    • -
  • X11 development files.
    • -
  • zlib development files.
    • -

  • Qt development files: Qt 4.4 or newer. The Recoll GUI will not build - with Qt releases older than 4.4.

    -
    • -

  • Qt webkit development: Qt WebKit is quite often distributed apart from - the main Qt lib. It is possible to configure Recoll not to use Qt WebKit - (see configure --help).

    -
    • -
  • Python development package: you can avoid needing this by configuring - with --disable-python-module.
    • -
- -

Source repository:

- -

The Recoll source repository is hosted on -bitbucket.org. The -trunk is usually a bit on the bleeding edge, but there is always a maintenance -branch for the current production version.

- -

Instructions for building

- -

Normally, it's just ./configure; make; make install. If a bit - more detail is needed, - - there is some in the manual. - -

- -
-

Packages

- -

Packages or ports for Recoll are available in the standard repositories for -many distributions.

- -

However they are often a bit older or built with older Xapian releases. Here - follow some pointers to find newer packages for some - distributions. In most cases, you will just need to use an - alternate repository.

- -

I sometimes build binary packages when no appropriate repository - exists. Any binary package directly linked from this page need a Qt - 4 (4.4 at least) runtime environment. To make things easier, on - systems where Xapian is not available from the standard package - repositories, the Recoll package will have a static link to Xapian - so that you do not need to build/install it separately.

- -

Debian

- -

The Debian Recoll packages are usually fairly up to date, just use - the appropriate Debian repository.

- -

Except they're not at the moment (2015-10).... So - I am maintaining a repository for packages built for Debian Wheezy, - and Jessie. This currently has recoll 1.20.6 (the - standard repos have 1.17...) To add the repository to your - sources:

- -

The public part of the key used to sign the repositories can - be downloaded and installed as follows:

- -
- wget -O - http://www.lesbonscomptes.com/key/jf@dockes.org.gpg.key | sudo apt-key add - -
- -
    -
  • Create and edit - /etc/apt/sources.list.d/recoll.list - and add the following lines:
    - for wheezy (debian 7.x):
    -
    -deb http://www.lesbonscomptes.com/recoll/debian/ wheezy main -deb-src http://www.lesbonscomptes.com/recoll/debian/ wheezy main +
    +
    - for jessie (debian 8.x):
    -
    -deb http://www.lesbonscomptes.com/recoll/debian/ jessie main -deb-src http://www.lesbonscomptes.com/recoll/debian/ jessie main -
    -
  • Then: -
    -sudo apt-get update -sudo apt-get install recoll [python-recoll python3-recoll] -
    -
    • -
-

If you prefer to manually install the packages, they are here: -debian/pool/main/r/recoll/
-

+
+

Recoll downloads

-

Ubuntu

+
-

There are Personal Package Archives on launchpad.net for Recoll, -kio-recoll and recoll-lens. These were built from the latest versions, for -a set of Ubuntu series. starting at Lucid. The installation is very simple:

-

-          sudo add-apt-repository ppa:recoll-backports/recoll-1.15-on
-          sudo apt-get update
-          sudo apt-get install recoll
-
+ + + + + + + + + + + + + +
+ General + Source + Linux Packages (.rpm and .deb) + Windows + Known bugs + Mac ports + Updated Filters + Translations
+
-

The 1.19/1.20 packages in the PPA now have a separate package - for the Python extension, like the standard ones, so there should be - no more conflict issues while switching from the PPA to the normal - repositories and back.

+
+

General information

-

Linux Mint

+

The current version is 1.21.4. Release + notes.

-

The Ubuntu PPA works perfectly for Mint 13 (and probably other releases -too). Just follow the instructions for Ubuntu.

+

Recoll Installation / building + manual.

-

RPMS

+

The indexing filters used for some document types may need external + packages not installed on your system by default, and not installed + automatically with Recoll: take a + look at the list and decide what you need to install.

-

You'll need to install the Xapian, Qt, Qt-Webkit and zlib development -packages if you want use the source rpms.

+

The Recoll term explorer tool in phonetic mode (marginally useful and + optional) uses the aspell package, version 0.60 (utf-8 support) or + newer.

-

Fedora

+

If you find problems with this page, the package or its installation, + please report them.

-

Recoll is present in the standard Fedora package repositories starting from - F-12. Fedora 21 has up to date packages. Here are some packages - for Fedora 20. There are only x86_64 binaries - for now, use the source rpm for other archs.

+

What do the release numbers mean?

-

CentOS 7.1

+

The Recoll releases are numbered X.Y.Z. The X would only change for really + major modifications like a big change in the index format, and possibly won't + ever reach 2.

-

CentOS ships neither Xapian nor Recoll. Here are - some packages.. There are only x86_64 binaries - for now, use the source rpm for other archs. As far as I know, the - only specific issue is that CentOS does not seem to have the Qt - WebKit module. The Recoll build uses QTextBrowser instead of a - WebKit QWebView, so no Javascript or advanced CSS in the result list - or snippets window for you.

+

Y is for functional modifications. These may bring bugs, so if you don't + need the new features, you may want to wait a little, and especially skip the + first release (X.Y.0), at least for a few weeks.

+ +

Z changes for bug fixes only, and moving from X.Y.Z + to X.Y.Z+u should in general involve little risk of regression. But, + any change can bring problems, if you are not affected by the + corrected bugs (check the release file), there + is probably no necessity to upgrade anyway.

+
+ +
+

Known bugs

+

There is a history of known bugs, sorted + by fix release. Also see + the + issue tracker on Bitbucket. +

+
+ +
+

Source

+ +

Current release distribution: 1.21.4:

+ + +

recoll-1.21.4.tar.gz.

+ + + +

Ubuntu Unity Lens and Scope

+ +

You will probably get these from the PPA, but + here are the source files. These are not included in the main tar file + any more. For recoll 1.19, 1.20 and 1.21 installations (choose on the + Ubuntu version, not the Recoll one): + +

+ + recoll-lens-1.19.10.3543.tar.gz (Recoll 0.19 or 0.20, + Ubuntu up to 13.04 Raring)
+ + + unity-scope-recoll-1.20.2.4.tar.gz (Recoll 0.19 and later, Ubuntu + 13.10 and later).
+ +
+ + For Recoll 1.18: + recoll-lens-1.18.1.2997.tar.gz
+ For Recoll 1.17: + recoll-lens-1.17.2.2697.tar.gz + +

+ +

Prerequisites for building from source:

+
    +
  • C++ compiler. Its absence sometimes manifests itself by strange messages + about iconv_open (fixed after 1.13.04).
    • +

  • Xapian core development libraries. Most Linux distributions carry them + in their package repository. Or you will find source and binary packages on + the Xapian download page. +
    + Recoll should still work with Xapian 1.0, but it is highly recommended to + use a Xapian 1.2 version.

    +

    Note on building Xapian for older CPUs: The build + configurations for Xapian releases 1.0.21 and 1.2.1 or newer enable the use + of SSE2 floating point instructions. These instructions are not available + in CPUs older than Intel Pentium 4 or AMD Athlon 64. When building for such + a CPU, you need to add the --disable-sse flag to the Xapian library + configure command. If this is not done, the problem signals itself by + "Illegal instruction" crashes (SIGILL) in recollindex and recoll.

    +
    • +
  • X11 development files.
    • +
  • zlib development files.
    • +

  • Qt development files: Qt 4.4 or newer. The Recoll GUI will not build + with Qt releases older than 4.4.

    +
    • +

  • Qt webkit development: Qt WebKit is quite often distributed apart from + the main Qt lib. It is possible to configure Recoll not to use Qt WebKit + (see configure --help).

    +
    • +
  • Python development package: you can avoid needing this by configuring + with --disable-python-module.
    • +
+ +

Source repository:

+ +

The Recoll source repository is hosted on + bitbucket.org. The + trunk is usually a bit on the bleeding edge, but there is always a maintenance + branch for the current production version.

+ +

Instructions for building

+ +

Normally, it's just ./configure; make; make install. If a bit + more detail is needed, + + there is some in the manual. + +

+ +
+

Packages

+ +

Packages or ports for Recoll are available in the standard repositories for + many distributions.

+ +

However they are often a bit older or built with older Xapian releases. Here + follow some pointers to find newer packages for some + distributions. In most cases, you will just need to use an + alternate repository.

+ +

I sometimes build binary packages when no appropriate repository + exists. Any binary package directly linked from this page need a Qt + 4 (4.4 at least) runtime environment. To make things easier, on + systems where Xapian is not available from the standard package + repositories, the Recoll package will have a static link to Xapian + so that you do not need to build/install it separately.

+ +

Debian

+ +

The Debian Recoll packages are usually fairly up to date, just use + the appropriate Debian repository.

+ +

Except they're not at the moment (2015-10).... So + I am maintaining a repository for packages built for Debian Wheezy, + and Jessie. This currently has recoll 1.21.x (the + standard repos have 1.17...) To add the repository to your + sources:

+ +

The public part of the key used to sign the repositories can + be downloaded and installed as follows:

+ +
+ wget -O - http://www.lesbonscomptes.com/key/jf@dockes.org.gpg.key | sudo apt-key add - +
+ +
    +
  • Create and edit + /etc/apt/sources.list.d/recoll.list + and add the following lines:
    + for wheezy (debian 7.x):
    +
    + deb http://www.lesbonscomptes.com/recoll/debian/ wheezy main + deb-src http://www.lesbonscomptes.com/recoll/debian/ wheezy main +
    + for jessie (debian 8.x):
    +
    + deb http://www.lesbonscomptes.com/recoll/debian/ jessie main + deb-src http://www.lesbonscomptes.com/recoll/debian/ jessie main +
    +
  • Then: +
    + sudo apt-get update + sudo apt-get install recoll [python-recoll python3-recoll] +
    +
    • +
+ +

If you prefer to manually install the packages, they are here: + debian/pool/main/r/recoll/
+

+ +

Ubuntu

+ +

There are Personal Package Archives on launchpad.net for Recoll, + kio-recoll and recoll-lens. These were built from the latest versions, for + a set of Ubuntu series. starting at Lucid. The installation is very simple:

+ 

+            sudo add-apt-repository ppa:recoll-backports/recoll-1.15-on
+            sudo apt-get update
+            sudo apt-get install recoll
+
+ +

The packages in the PPA now have a separate package for the Python + extension, like the standard ones, so there should be no more + conflict issues while switching from the PPA to the normal + repositories and back.

+ +

Linux Mint

+ +

The Ubuntu PPA works perfectly for Mint 13 (and probably other releases + too). Just follow the instructions for Ubuntu.

+ +

RPMS

+ +

You'll need to install the Xapian, Qt, Qt-Webkit and zlib development + packages if you want use the source rpms.

+ +

Fedora

+ +

Recoll is present in the standard Fedora package repositories starting from + F-12. Recoll packages in Fedora are usually fairly up to + date. Please get in touch if you have a need for a Recoll package + for Fedora.

+ +

CentOS 7.1

+ +

CentOS ships neither Xapian nor Recoll. Here are + some packages.. There are only x86_64 binaries + for now, use the source rpm for other archs. As far as I know, the + only specific issue is that CentOS does not seem to have the Qt + WebKit module. The Recoll build uses QTextBrowser instead of a + WebKit QWebView, so no Javascript or advanced CSS in the result list + or snippets window for you.

-

OpenSUSE

+

OpenSUSE

-

Recoll is in the KDE:Extra repository. You just need to add the - repository to your software - sources (Yast2->software->Software repositories).
- - Repository list (supported Suse versions). - After adding the appropriate repository to your software sources, - you will be able to install recoll and kio_recoll from the software - management interface. The Xapian dependancy will also be satisfied - from the build service repository. Some of the older repositories do - not build antiword, just tell the software manager to "break" recoll - by installing anyway, and get antiword somewhere else.

-
+

Recoll is in the KDE:Extra repository. You just need to add the + repository to your software + sources (Yast2->software->Software repositories).
+ + Repository list (supported Suse versions). + After adding the appropriate repository to your software sources, + you will be able to install recoll and kio_recoll from the software + management interface. The Xapian dependancy will also be satisfied + from the build service repository. Some of the older repositories do + not build antiword, just tell the software manager to "break" recoll + by installing anyway, and get antiword somewhere else.

-
-

Packages

-

Microsoft Windows

+ - + +

The port of Recoll to Windows is still a bit experimental and + lacking things like real-time indexing or spelling + suggestions. However it works well enough to be useful. More info + and links to the setup + files here.

+
-
-

Ports

+
-

Mac port

+
+

Ports

-

It seems that Recoll will sometimes find data that Spotlight misses -(especially inside pdfs apparently, which is probably more to the credit of -poppler than recoll itself).

+

Mac port

-

Recoll is in MacPorts and really easy to install:

-
    -
  1. Install - MacPorts.
    2. -
  2. Type "sudo port install recoll"
    3. -
+

It seems that Recoll will sometimes find data that Spotlight misses + (especially inside pdfs apparently, which is probably more to the credit of + poppler than recoll itself).

-

Recoll is then available from the command line and as an icon in the usual -MacPorts applications place.

-
+

Recoll is in MacPorts and really easy to install:

+
    +
  1. Install + MacPorts.
    2. +
  2. Type "sudo port install recoll"
    3. +
-
-

Updated filters

-

new or updated filters - sometimes become available after a release. As a rule, all - filters are compatible with all Recoll versions. Any - compatibility problem will be explicitely mentionned.

-
+

Recoll is then available from the command line and as an icon in the usual + MacPorts applications place.

+
-
-

Translations

+
+

Updated filters

+

new or updated filters + sometimes become available after a release. As a rule, all + filters are compatible with all Recoll versions. Any + compatibility problem will be explicitely mentionned.

+
-

Most of the translations for 1.21 are incomplete The source translation -files are included in the source release. If your language has some english -messages left and you want to take a shot at fixing the problem, you can send -the results to me and earn my gratefulness -(and your less multilingual compatriot's)...

+
+

Translations

-

You can use the .ts file to alter the translations if you wish (use -Qt's linguist tool to edit the source file, then lrelease to -produce the .qm file.). The .qmfile should be -copied to /usr/[local/]share/recoll/translations -

+

Most of the translations for 1.21 are incomplete The source translation + files are included in the source release. If your language has some english + messages left and you want to take a shot at fixing the problem, you can send + the results to me and earn my gratefulness + (and your less multilingual compatriot's)...

-

recoll_xx.ts is a blank -Recoll 1.21 message file, handy to work on a new translation. You can -also list the directory to see all the -translation files (same as those in the 1.20 source branch on -Bitbucket).

+

You can use the .ts file to alter the translations if you wish (use + Qt's linguist tool to edit the source file, then lrelease to + produce the .qm file.). The .qmfile should be + copied to /usr/[local/]share/recoll/translations +

-

Updated 1.20/21 translations that became available after the release:

+

recoll_xx.ts is a blank + Recoll 1.21 message file, handy to work on a new translation. You can + also list the directory to see all the + translation files (same as those in the 1.20 source branch on + Bitbucket).

-

A Danish translation by Morten Langlo: -recoll_da.ts -recoll_da.qm
-

+

Updated 1.20/21 translations that became available after the release:

-

Note that, if you are running an older release, you may find updated -messages by looking inside the appropriate maintenance branch on bitbucket.

+

A Danish translation by Morten Langlo: + recoll_da.ts + recoll_da.qm
+

-
+

Note that, if you are running an older release, you may find updated + messages by looking inside the appropriate maintenance + branch on + bitbucket.

-
+
+
- + diff --git a/website/features.html b/website/features.html index e65eca7c..a1ae72f5 100644 --- a/website/features.html +++ b/website/features.html @@ -26,7 +26,7 @@
  • Downloads
    • -
  • User manual
    • +
  • Documentation
  • Support
    • @@ -418,7 +418,7 @@ application/x-tar = execm rcltar Web UI lets you query a Recoll index from a web browser

    Recoll also has - + Python and PHP modules which can allow easy integration with web or other applications.

    diff --git a/website/helpernotes.html b/website/helpernotes.html index 486c40bc..d8f5a9b9 100644 --- a/website/helpernotes.html +++ b/website/helpernotes.html @@ -28,7 +28,7 @@
  • Downloads
    • -
  • User manual
    • +
  • User manual
  • Support
    • diff --git a/website/id3lib.html b/website/id3lib.html index a96ac4ff..13bb6eba 100644 --- a/website/id3lib.html +++ b/website/id3lib.html @@ -24,7 +24,7 @@
  • Features
  • Screenshots
  • Downloads
    • -
  • User manual
    • +
  • User manual
  • Support
  • Development
    • diff --git a/website/index.html.en b/website/index.html.en index 192d013e..80c85a0f 100644 --- a/website/index.html.en +++ b/website/index.html.en @@ -97,7 +97,14 @@
    - + +
    2016-01-12
    It seems that we currently have a + relatively frequent problem resulting in damaged indexes. If + you are experimenting heavy reindexing (incremental indexing + takes longer than it should), or missing search results, + please take a look at the top of + the known bugs page
    +
    2016-01-12
    Release 1.21.4 is out.
    2015-11-09
    diff --git a/website/release-1.16.html b/website/release-1.16.html index 2b67c884..b0bf9ce9 100644 --- a/website/release-1.16.html +++ b/website/release-1.16.html @@ -96,7 +96,7 @@ the text). This is useful for example in the very common case where the metadata for the author list was not created. More details about this feature are to be found in - the user + the user manual.
  • It is possible to configure the result list snippet