From 297ff2d225f93178c8a11cead14db7d06d1c6ffc Mon Sep 17 00:00:00 2001 From: Jean-Francois Dockes Date: Sat, 7 May 2011 09:32:42 +0200 Subject: [PATCH] comments and doc --- src/doc/user/usermanual.sgml | 26 ++++++++---- src/qtgui/confgui/confguiindex.cpp | 8 ++-- src/utils/circache.h | 7 +++- website/BUGS.html | 66 +++++++++++++++++------------- website/release-1.15.html | 3 -- 5 files changed, 64 insertions(+), 46 deletions(-) diff --git a/src/doc/user/usermanual.sgml b/src/doc/user/usermanual.sgml index 918f25d5..0f456718 100644 --- a/src/doc/user/usermanual.sgml +++ b/src/doc/user/usermanual.sgml @@ -479,24 +479,32 @@ recoll Using Beagle WEB browser plugins - Beagle is a concurrent desktop + Beagle is (was?) a concurrent desktop indexer, built on Lucene and the Mono project (C#), for which a number of add-on browser plugins were written. These work by copying visited web pages to an indexing queue directory, which the - indexer then processes. + indexer then processes. Especially, there is a + Firefox extension. If, for any reason, you so happen to prefer &RCL; to - Beagle, you can still use - the browser plugins (they are written in Javascript and completely - independant of C#, Beagle, Lucene...). &RCL; can process the - Beagle queue directory. Of course, this - supposes that Beagle is not running, - else both programs will fight for the same files. + Beagle, you can still use the + Firefox plugin, which is written in + Javascript and completely independant of C#, Beagle, Lucene..., and + set &RCL; to process the Beagle queue + directory. This supposes that Beagle is + not running, else both programs will fight for the same + files. This feature can be enabled in the GUI indexing configuration panel, or by editing the configuration file (set processbeaglequeue to 1). - + + There are more recent instructions about how to find and + install the Firefox extension on the + + Recoll wiki. + + Periodic indexing diff --git a/src/qtgui/confgui/confguiindex.cpp b/src/qtgui/confgui/confguiindex.cpp index a517a738..a4f4f30b 100644 --- a/src/qtgui/confgui/confguiindex.cpp +++ b/src/qtgui/confgui/confguiindex.cpp @@ -141,9 +141,9 @@ ConfBeaglePanelW::ConfBeaglePanelW(QWidget *parent, ConfNull *config) ConfLink lnk2(new ConfLinkRclRep(config, "webcachedir")); ConfParamFNW* cp2 = - new ConfParamFNW(this, lnk2, tr("Web cache directory name"), - tr("The name for a directory where to store the cache " - "for visited web pages.
" + new ConfParamFNW(this, lnk2, tr("Web page store directory name"), + tr("The name for a directory where to store the copies " + "of visited web pages.
" "A non-absolute path is taken relative to the " "configuration directory."), true); cp2->setEnabled(cp1->m_cb->isChecked()); @@ -152,7 +152,7 @@ ConfBeaglePanelW::ConfBeaglePanelW(QWidget *parent, ConfNull *config) ConfLink lnk3(new ConfLinkRclRep(config, "webcachemaxmbs")); ConfParamIntW *cp3 = - new ConfParamIntW(this, lnk3, tr("Max. size for the web cache (MB)"), + new ConfParamIntW(this, lnk3, tr("Max. size for the web store (MB)"), tr("Entries will be recycled once the size is reached"), -1, 1000); cp3->setEnabled(cp1->m_cb->isChecked()); diff --git a/src/utils/circache.h b/src/utils/circache.h index d7403f4f..e2b11a58 100644 --- a/src/utils/circache.h +++ b/src/utils/circache.h @@ -58,7 +58,12 @@ public: virtual string getReason(); - enum CreateFlags {CC_CRNONE=0, CC_CRUNIQUE=1, CC_CRTRUNCATE = 2}; + enum CreateFlags {CC_CRNONE=0, + // Unique entries: erase older instances when same udi + // is stored. + CC_CRUNIQUE=1, + // Truncate file (restart from scratch). + CC_CRTRUNCATE = 2}; virtual bool create(off_t maxsize, int flags); enum OpMode {CC_OPREAD, CC_OPWRITE}; diff --git a/website/BUGS.html b/website/BUGS.html index ca2a8662..3d951b2e 100644 --- a/website/BUGS.html +++ b/website/BUGS.html @@ -89,24 +89,46 @@

recoll 1.15.7

-
  • Using search preview while the indexing thread is running will - sometimes crash the GUI or provoke other strangeness. This is - apparently due to insufficient protection of resources shared by - several threads. After recent cleanup, the problem occurs quite - seldom but it is not completely gone. The current and - unsatisfying workaround, is to avoid the situation, for example - by using the standalone recollindex program instead of the GUI +
      +
    • Using the result preview while the indexing thread is + running will sometimes crash the GUI or provoke other + strangeness. This is apparently due to insufficient + protection of resources shared by several threads. After + recent cleanup, the problem occurs quite seldom but it is + not completely gone. The current and unsatisfying + workaround, is to avoid the situation, for example by using + the standalone recollindex program instead of the GUI indexing thread.
      • -
    • The GUI preview function sometimes failed with a +
    • The GUI preview function sometimes fails with a non-sensical message about a non-related missing helper.
      • -
    • The ignored suffixes list (recoll_noindex) is - ignored in some cases.
      • +
    • Most operations on the parent document in the result table + view are not connected and do nothing.
      • + +
    • The operations on the parent document in the result list + right click menu (Preview and Open), do not work, they + access the file's parent directory instead.
    • The GUI option to remember sort state between invocations only works for sort by date.
      • + +
    • The rclzip filter can't handle utf-8 in path names for archive + members. An + updated filter is available.
      • + +
    • The rclzip and rclchm filters can't handle archive members + with a colon (':') in the file name or path. The files are normally + indexed and can be searched for, but they can't be displayed + (neither opened nor previewed). There is a + + patch which fixes the issue (then needs full reindex for these + files).
      • + +
    • The ignored suffixes list (recoll_noindex) is itself + ignored in some cases.
      • +
    • The man filter creates groff temporary png files in the home directory.
      • @@ -120,31 +142,17 @@ user ends the section at this point.
    • Starting the indexing thread inside the GUI while another - indexer (batch or real-time) was active would silently + indexer (batch or real-time) is active will silently failed. It should show an error dialog.
    • When an open error occurs on an external index while starting the GUI, the initial indexing dialog is started, which is incorrect because it cannot fix the problem.
      • -
    • The operations on the parent document in the result list - right click menu (Preview and Open), do not work, they - access the file's parent directory instead.
      • - -
    • Most operations on the parent document in the result table - view are not connected and do nothing.
      • - -
    • The rclzip filter can't handle utf-8 in path names for archive - members. An - updated filter is available.
      • - -
    • The rclzip and rclchm filters can't handle archive members - with a colon (':') in the file name or path. The files are normally - indexed and can be searched for, but they can't be displayed - (neither opened nor previewed). There is a - - patch which fixes the issue (then needs full reindex for these - files).
      • +
    • The result table row height is not adjusted according to + default font size, and the vertical position of text in cells + is often bad.
      • +

    recoll 1.15.5

    diff --git a/website/release-1.15.html b/website/release-1.15.html index 5dfc4500..310db905 100644 --- a/website/release-1.15.html +++ b/website/release-1.15.html @@ -72,9 +72,6 @@ etc.).
  • Estimated result counts are displayed in the status line.
    • -
  • Set row height according to default font size, and better - adjust row height and vertical text position in - cells.