tris/recoll
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc

Browse Source
This commit is contained in:
Jean-Francois Dockes 2013-04-30 08:25:54 +02:00
parent c7ccedf365
commit f70a45b60f
2 changed files with 178 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
website/BUGS.html
View File

@ -36,7 +36,36 @@
topmost section may also exist in older versions.</i></p> topmost section may also exist in older versions.</i></p>
<h2><a name="b_latest">recoll 1.18.2</a></h2> <h2><a name="b_latest">recoll 1.19.0</a></h2>
<ul>
<li>On systems such as Debian Stable which use Evince version
2.x (not 3.x) as PDF viewer, the default "Open" command for
PDF files will not work. You need to use the GUI preferences
tool to change the --page-index option to --page-label for
the evince command line used for PDF.</li>
<li>It will sometimes happen that the result list paragraph
format stored in the Qt preferences file will get garbled,
causing result lists with no displayed paragraphs (the
counts and pages are ok, the results can be seen in table
mode, but not in list mode). The workaround is to go to
<blockquote>
Preferences->Query configuration->User interface
</blockquote> and erase the result paragraph format string
(^A DEL in the text area), this will reset the string to the
default value.</li>
<li>Real time indexer: when running with gamin on FreeBSD, the
indexer can deadlock in the gamin dialog in some
cases.</li>
<li>After an upgrade, the recoll GUI sometimes crashes on
startup. This is fixed by removing (back it up just in case)
~/.config/Recoll.org/recoll.conf, the QSettings storage for
recoll.</li>
</ul>
<h2><a name="b_1_18_2">recoll 1.18.2</a></h2>
<ul>
<li>When no indexing helper applications are actually missing, <li>When no indexing helper applications are actually missing,
an ennoying popup is shown in the GUI at each end of a batch an ennoying popup is shown in the GUI at each end of a batch
indexing run (it's supposed to be shown only once).</li> indexing run (it's supposed to be shown only once).</li>
@ -61,36 +90,32 @@ video/x-msvideo = exec rclbad
</li> </li>
<li>On systems such as Debian Stable which use Evince version <li>It's possible to add an external index with a
2.x (not 3.x) as PDF viewer, the default "Open" command for case/diacritics stripping option different from the main
PDF files will not work. You need to edit the command: index'. Searches will mostly not work.</li>
in <em>Preferences->GUI&nbsp;configuration</em>,
uncheck <em>Use&nbsp;desktop&nbsp;preferences...</em>, then
click <em>Choose&nbsp;editor&nbsp;applications</em>, and for
application/pdf, application/postscript and text/dvi, change
the --page-index option to --page-label. Then
re-check <em>Use&nbsp;desktop&nbsp;preferences...</em> if
it was initially set.</li>
<li>It will sometimes happen that the result list paragraph <li>fnmatch() errors sometimes encountered because of
format stored in the Qt preferences file will get garbled, character set and locale issues were treated as
causing result lists with no displayed paragraphs (the matches.</li>
counts and pages are ok, the results can be seen in table
mode, but not in list mode). The workaround is to go to
<blockquote>
Preferences->Query configuration->User interface
</blockquote> and erase the result paragraph format string
(^A DEL in the text area), this will reset the string to the
default value.</li>
<li>Real time indexer: when running with gamin on FreeBSD, the <li>When an advanced search finds no result, the spelling
indexer can deadlock in the gamin dialog in some suggestions screen which is displayed contains links which can
cases.</li> only be useful for a simple search. Clicking them will
result in confusion.</li>
<li>When the real-time indexer updates a compound document
which has been shortened (typically, a truncated mbox folder),
the obsolete documents beyond the new end were not deleted,
resulting in confusing behaviour.</li>
<li>Expansions of '*' were sometimes done against the whole
indexes in cases where it would have been able data restricted
to a field, resulting in much degraded performance.</li>
<li>Wildcards were wrongly handled when splitting a string
before a query, so that things like <tt>recoll@*</tt> could
end up being split as <tt>recoll *</tt>.</li>
<li>After an upgrade, the recoll GUI sometimes crashes on
startup. This is fixed by removing (back it up just in case)
~/.config/Recoll.org/recoll.conf, the QSettings storage for
recoll.</li>
</ul> </ul>

168
website/release-1.19.html
View File

@ -47,20 +47,22 @@
do this is to quit all recoll programs and just delete the do this is to quit all recoll programs and just delete the
index directory index directory
(<span class="literal">rm&nbsp;-rf&nbsp;~/.recoll/xapiandb</span>), (<span class="literal">rm&nbsp;-rf&nbsp;~/.recoll/xapiandb</span>),
then start recoll or then start recoll or recollindex. <br/>
recollindex. <span class="literal">recollindex&nbsp;-z</span> <span class="literal">recollindex&nbsp;-z</span> &nbsp;will do
&nbsp;will do the same in most, but not all, cases, it's the same in most, but not all, cases. It's better to use
better to use the <tt>rm</tt> method, which will also ensure the <tt>rm</tt> method, which will also ensure that no debris
that no debris from older releases remain (e.g.: old stemming from older releases remain (e.g.: old stemming files which are
files which are not used any more).</p> not used any more).</p>
<p>Installing 1.19 over an 1.18 index will force a lot of <p>Installing 1.19 over an 1.18 index will force a lot of
reindexing anyway because we switched from using st_ctime instead reindexing anyway because Recoll switched from using st_ctime
of st_mtime to detect file modifications, meaning that all files instead of st_mtime to detect file modifications, meaning that
which were modified since created will be updated.</p> all files which were modified since created will be
updated.</p>
<p><span class="important">Viewer exceptions</span>: <p><span class="important">Viewer exceptions</span>: as in 1.18
There is a new list of mime types that should be opened with (but we kept this section for 1.17 users),
there is a list of mime types that should be opened with
the locally configured application even when <em>Use the locally configured application even when <em>Use
Desktop Preferences</em> is checked. This allows making Desktop Preferences</em> is checked. This allows making
use of new functions (direct access to page), which could not use of new functions (direct access to page), which could not
@ -73,35 +75,128 @@
installation . This can be done from the <em>Preferences->Gui installation . This can be done from the <em>Preferences->Gui
Configuration</em> menu.</p> Configuration</em> menu.</p>
<h2>Changes</h2> <h2>Changes in Recoll 1.19.0</h2>
<p>Recoll 1.19 .... Changes documented from 1.18.1 to rev 3159</p>
<ul> <ul>
<li>Indexing can use multiple threads. This can be a
major performance boost for people with multiprocessor
machines and big indexes. The threads setup is
roughly auto-configured when recollindex starts, based on
the number of processors, but it is also possible to taylor
it in the configuration. Here are some
<a href="http://www.recoll.org/idxthreads/threadingRecoll.html">
notes about the transformation and the performance
improvements</a>. There is also a
<a href="http://www.recoll.org/usermanual/usermanual.html#RCL.INSTALL.CONFIG.RECOLLCONF.IDXTHREADS">
section in the manual</a> to describe the configuration.
</li>
<li>There is a new result list/table popup menu option to
display all the sub-documents for a given one. This is
mostly useful to display the attachments to an email. The
resulting screen can be used to save a multiple selection of
the entries to files.</li>
<li>It is now possible to use OR with "dir:" clauses, and
wildcards have been enabled.</li>
<li>When the option to follow symbolic links is not set
-which is the default- symbolic links are now indexed as
such (name and content).</li>
<li>There are new GUI configuration options to run in "search
as you type" mode (which I don't find useful at all...), and
to disable the Qt auto-completion inside the simple search
string. The completion was often more confusing and ennoying than
useful, especially because it is case-insensitive when case
sometimes matter for Recoll searches (capitalization to
disable stemming).</li>
<li>When the option to collapse identical results is used,
documents which do have duplicates are shown with a
link to list the clones. This function needs new data from
the index, so it will only completely work after a full 1.19
reindex.</li>
<li>Recoll should now behave reasonably on video files: index
the name and propose an Open button in the result list to
start the configured player.</li>
<li>Thanks to Recoll
user <a href="https://github.com/koniu">Koniu</a>, you can now
access your Recoll indexes through a Web
browser interface. The server side is based on
the <a href="http://bottlepy.org/docs/dev/">Bottle Python
Web frameork</a> and the Recoll Python module, and can run
self-contained (no necessity to run apache or another web
server), so it's quite simple to set up. See:
See the <a href="https://github.com/koniu/recoll-webui/">
Recoll WebUI project</a> on GitHub. </li>
<li>There is a new path translation facility, with a GUI
interface, to make it easier to share an index from a network
share on clients on which the mount points might be
different. This could also probably be put to use to design
a "portable index" feature (for removable media).</li>
<li>The first indexing run after Recoll installation (for a new
user) will run in a fashion which will put data likely to be
useful into the index faster, so that an impatient user can
more quickly try searches.</li>
<li>Implemented cache for last file uncompressed. This will
much improve usage, e.g. for people fetching successive
messages from a compressed mail folder.</li>
<li>Recollindex will now change its current directory to a
temporary one (e.g. /tmp) to mitigate the problems of some
filters creating temporary files and not cleaning them.</li>
<li>There is a new recursive reindex option to command line
indexer.</li>
<li>The default result list paragraph format has been slightly
tweaked (removed the relevance percentage and small ordering
and formatting changes).</li>
<li>Mime type wildcard expansion is now performed against the
index, not the configuration. This fixes many problems when
searching for, e.g., media files indexed only by name.</li>
<li>The choice for case/diacritics sensitivity is now fully
processed during wildcard expansion (for case-sensitive
indexes).</li>
<li>The Snippets popup (list of pages and excerpts typically
produced for PDF documents) can now use an external
CSS stylesheet. This is useful because the Qt Webkit
objects do not fully inherit the Qt configuration so that,
for example, a style sheet is needed for using
a different background color. The style sheet is chosen
from the <tt>Preferences->GUI configuration->Result
list</tt> panel.</li>
<li>Improved handling of filters during indexing resulting in
less subprocesses.</li>
<li>Added function to import tags from external application
(e.g. Tmsu).</li>
<li>Changed format for rclaptg field. Was colon-separated, <li>Changed format for rclaptg field. Was colon-separated,
now uses normal value/attributes syntax with an empty value now uses normal value/attributes syntax with an empty value
like: like:
<pre> <pre>
localfields = ; attr1 = val1 ; attr2 = val2 localfields = ; attr1 = val1 ; attr2 = val2
</pre> </pre>
</li> </li>
<li>There are new GUI configuration options to run in "search
as you type" mode, and to disable the Qt auto-completion
inside the simple search string, which was often more confusing
and ennoying than useful.</li>
<li>Extended file attributes are now indexed by default. As a <li>Extended file attributes are now indexed by default. As a
side effect, recoll now uses st_ctime, not st_mtime to detect side effect, recoll now uses st_ctime, not st_mtime to detect
file changes. This means that installing 1.19 will reindex file changes. This means that installing 1.19 will reindex
many files (all those that were modified since created).</li> many files (all those that were modified since created).
Recoll now processes the <tt>charset</tt>
<li>The software can now be built so that indexing is runs with and <tt>mime_type</tt> standardized extended attributes.</li>
multiple threads. This can be a major performance boost for
people with multiprocessor machines and big indexes. It is not
enabled by default for now, you will need to build from
source. I wrote some
<a href="http://www.recoll.org/idxthreads/threadingRecoll.html">notes
about the transformation and the performance improvements</a>.</li>
<li>The Python module has been expanded to include the <li>The Python module has been expanded to include the
interface for extracting data. This means that you could now interface for extracting data. This means that you could now
@ -121,25 +216,12 @@
Database API Specification v2.0</a> for the parts that make Database API Specification v2.0</a> for the parts that make
sense for a non-relational DB.</li> sense for a non-relational DB.</li>
<li>You can now access your Recoll indexes through a Web
browser interface. The server side is based on
the <a href="http://bottlepy.org/docs/dev/">Bottle Python
Web frameork</a> and the Recoll Python module, and can run
self-contained (no necessity to run apache or another web
server), so it's quite simple to set up. See:
the expanded Python module. See
the <a href="https://github.com/koniu/recoll-webui/">Recoll
WebUI</a> on GitHub. </li>
<li>Recoll now uses a dynamic library for the code shared by <li>Recoll now uses a dynamic library for the code shared by
the query interface, the indexer and the Python the query interface, the indexer and the Python
module. This should have no visible impact but was rendered module. This should have no visible impact but was rendered
necessary by the Python module evolutions.</li> necessary by the Python module evolutions.</li>
<li>Fixed bugs: <li>And quite a few <a href="BUGS.html#b_1_18_2">Fixed bugs</a></li>
<ul>
</ul>
</li>
</ul> </ul>