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

*** empty log message ***

Browse Source
This commit is contained in:
dockes 2006-02-01 07:12:14 +00:00
parent 1b681f0956
commit ed3de70f2f
5 changed files with 452 additions and 316 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/INSTALL
View File

@ -27,10 +27,11 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
At the very least, you will need to download and install the xapian core
package (Recoll currently uses version 0.9.2), and the qt runtime and
development packages (Recoll currently uses version 3.3.3).
development packages (Recoll development currently uses version 3.3.5, but
any 3.3 version is probably ok).
You will most probably be able to find a binary package for qt for your
system. You may have to compile Xapian, but this is not difficult (if you
system. You may have to compile Xapian but this is not difficult (if you
are using FreeBSD, there is a port).
You may also need libiconv. Recoll currently uses version 1.9 (this should

92
src/README
View File

@ -142,6 +142,9 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
The resulting database can be big (roughly the size of the original
document set), but it is not a document archive. Recoll can only display
documents that still exist at the place from which they were indexed.
(Actually, there is a way to reconstruct a document from the information
in the database, but the result is not nice, as all formatting,
punctuation and capitalisation are lost).
Recoll stores all internal data in Unicode UTF-8 format, and it can index
files with different character sets, encodings, and languages into the
@ -185,6 +188,15 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
interface to real time file modification monitors. The typical usage is to
have a nightly indexation run programmed into your cron file.
+------------------------------------------------------------------------+
| Side note: there is nothing in Recoll and Xapian that would prevent |
| interfacing with a real time file modification monitor, but this would |
| tend to consume significant system resources for dubious gain, because |
| you rarely need a full text search to find documents you just |
| modified. recollindex -i can be used to add individual files to the |
| index if you want to play with this, see the manual page. |
+------------------------------------------------------------------------+
Recoll knows about quite a few different document types. The parameters
for document types recognition and processing are set in configuration
files Most file types, like HTML or word processing files, only hold one
@ -258,13 +270,17 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
3.1. Simple search
Start the recoll program, then enter search term(s) in the text field at
the top left of the window. Clicking the Search button or hitting the
Enter key will start a search. By default, this will look for documents
with any of the terms (the ones with more terms will get better scores).
You can check the All terms checkbox to ensure that only documents with
all the terms will be returned. Use the Tools / Advanced search dialog for
more complex searches.
1. Start the recoll program.
2. Enter search term(s) in the text field at the top of the window.
3. Click the Search button or hit the Enter key to start the search.
By default, this will look for documents with any of the search terms (the
ones with more terms will get better scores). You can check the All terms
checkbox to ensure that only documents with all the terms will be
returned. Use the Tools / Advanced search dialog for more complex
searches.
After starting a search, a list of results will instantly be displayed in
the main list window. Clicking on an entry will open an internal preview
@ -276,14 +292,18 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
the system estimates that the document matches the query). You can specify
a different ordering by using the Tools / Sort parameters dialog.
You can click on the first paragraph (Query results or No results found)
in the result list to get an exact display of the query actually
performed, after stem expansion and other processing.
----------------------------------------------------------------------
3.2. Complex/advanced search
The advanced search dialog has fields that will allow a more refined
search, looking for documents with all given words, a given exact phrase,
or none of the given words (all fields may be combined by an implicit AND
clause).
or none of the given words (all relevant fields will be combined by an
implicit AND clause).
It will let you search for documents of specific mime types (ie: only
text/plain, or text/html or application/pdf etc...)
@ -294,6 +314,8 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
Click on the Start Search button in the advanced search dialog to start
the search. The button in the main window always performs a simple search.
Click on the result list header paragraph to see the query expansion.
----------------------------------------------------------------------
3.3. Document history
@ -347,15 +369,46 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
It is possible to customise some aspects of the search interface by using
Query configuration entry in the Preferences menu.
There are two tabs in the dialog, to modify the appearance of the user
interface (result list appearance), or the parameters used for searching
(language used for stem expansion).
There are two tabs in the dialog, dealing with the interface itself, and
with the parameters used for searching and returning results.
The stemming language can be chosen among those that were specified in the
configuration file, or later added with recollindex -s (See the
recollindex manual). Stemming languages which are dynamically added will
be deleted at the next indexation pass unless they are also added in the
configuration file.
User interface parameters:
* Number of results in a result page
* Result list font: There is quite a lot of information shown in the
result list, and you may want to customise the font and/or font size.
The rest of the fonts used by Recoll are determined by your generic QT
config (try the qtconfig command.
* Html help browser: this will let you chose your the preferred browser
which will be started from the Help menu to read the user manual. You
can enter a simple name if the command is in your PATH, or browse for
a full pathname.
* Show document type icons in result list: icons in the result list can
be turned off. They take quite a lot of space and convey relatively
little useful information.
Search parameters:
* Stemming language: stemming obviously depends on the document's
language. This listbox will let you chose among the stemming databases
which were built during indexing (this is set in the main
configuration file), or later added with recollindex -s (See the
recollindex manual). Stemming languages which are dynamically added
will be deleted at the next indexation pass unless they are also added
in the configuration file.
* Dynamically build abstracts: this decides if Recoll tries to build
document abstracts when displaying the result list. Abstracts are
constructed by taking context from the document information, around
the search terms. This can slow down result list display significantly
for big documents, and you may want to turn it off.
* Replace abstracts from documents: this decides if we should synthetize
and display an abstract in place of an explicit abstract found within
the document itself.
----------------------------------------------------------------------
@ -367,10 +420,11 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
At the very least, you will need to download and install the xapian core
package (Recoll currently uses version 0.9.2), and the qt runtime and
development packages (Recoll currently uses version 3.3.3).
development packages (Recoll development currently uses version 3.3.5, but
any 3.3 version is probably ok).
You will most probably be able to find a binary package for qt for your
system. You may have to compile Xapian, but this is not difficult (if you
system. You may have to compile Xapian but this is not difficult (if you
are using FreeBSD, there is a port).
You may also need libiconv. Recoll currently uses version 1.9 (this should

126
src/doc/user/usermanual.sgml
View File

@ -24,7 +24,7 @@
Dockes</holder>
</copyright>
<releaseinfo>$Id: usermanual.sgml,v 1.4 2006-01-19 12:01:42 dockes Exp $</releaseinfo>
<releaseinfo>$Id: usermanual.sgml,v 1.5 2006-02-01 07:05:06 dockes Exp $</releaseinfo>
<abstract>
<para>This document introduces full text search notions
@ -116,9 +116,12 @@
indexation. </para>
<para>The resulting database can be big (roughly the size of the
original document set), but it is not a document archive. &RCL;
can only display documents that still exist at the place from which
they were indexed.</para>
original document set), but it is not a document
archive. &RCL; can only display documents that still exist at
the place from which they were indexed. (Actually, there is a
way to reconstruct a document from the information in the
database, but the result is not nice, as all formatting,
punctuation and capitalisation are lost).</para>
<para>&RCL; stores all internal data in <application>Unicode
UTF-8</application> format, and it can index files with
@ -178,6 +181,17 @@
<link linkend="rcl.indexing.automat">programmed</link> into your
<command>cron</command> file.</para>
<sidebar><para>Side note: there is nothing in &RCL; and &XAP;
that would prevent interfacing with a real time file
modification monitor, but this would tend to consume significant
system resources for dubious gain, because you rarely need a
full text search to find documents you just
modified. <command>recollindex -i</command> can be used to add
individual files to the index if you want to play with this, see
the manual page.</para>
</sidebar>
<para>&RCL; knows about quite a few different document
types. The parameters for document types recognition and
processing are set in
@ -278,12 +292,19 @@
<sect1 id="rcl.search.simple">
<title>Simple search</title>
<para>Start the <command>recoll</command> program, then
enter search term(s) in the text field at the top left of the
window. Clicking the <guilabel>Search</guilabel> button or
hitting the <keycap>Enter</keycap> key will start a search. By
default, this will look for documents with any of the terms
(the ones with more terms will get better scores). You can
<procedure>
<step><para>Start the <command>recoll</command> program.</para>
</step>
<step><para>Enter search term(s) in the text field at the top of the
window.</para>
</step>
<step><para>Click the <guilabel>Search</guilabel> button or
hit the <keycap>Enter</keycap> key to start the search.</para>
</step>
</procedure>
<para>By default, this will look for documents with any of the
search terms (the ones with more terms will get better scores). You can
check the <guilabel>All terms</guilabel> checkbox to ensure
that only documents with all the terms will be returned. Use
the <guilabel>Tools</guilabel> / <guilabel>Advanced
@ -303,6 +324,11 @@
using the <link linkend="rcl.search.sort"><guilabel>Tools</guilabel>
/ <guilabel>Sort parameters</guilabel></link> dialog.</para>
<para>You can click on the first paragraph (<literal>Query
results</literal> or <literal>No results found</literal>) in the
result list to get an exact display of the query actually
performed, after stem expansion and other processing.</para>
</sect1>
<sect1 id="rcl.search.complex">
@ -310,8 +336,8 @@
<para>The advanced search dialog has fields that will allow a more
refined search, looking for documents with all given words, a
given exact phrase, or none of the given words (all fields may
be combined by an implicit AND clause).</para>
given exact phrase, or none of the given words (all relevant fields
will be combined by an implicit AND clause).</para>
<para>It will let you search for documents of specific mime
types (ie: only <literal>text/plain</literal>, or
@ -325,6 +351,9 @@
the advanced search dialog to start the search. The button in
the main window always performs a simple search.</para>
<para>Click on the result list header paragraph to see the query
expansion.</para>
</sect1>
<sect1 id="rcl.search.history">
@ -403,17 +432,66 @@
interface by using <guimenu>Query configuration</guimenu> entry
in the <guimenu>Preferences</guimenu> menu.</para>
<para>There are two tabs in the dialog, to modify the appearance
of the user interface (result list appearance), or the
parameters used for searching (language used for stem
expansion).</para>
<para>There are two tabs in the dialog, dealing with the
interface itself, and with the parameters used for searching and
returning results.</para>
<para>The stemming language can be chosen among those that were
specified in the configuration file, or later added with
<para>User interface parameters:</para>
<itemizedlist>
<listitem><para><guilabel>Number of results in a result
page</guilabel></para>
</listitem>
<listitem><para><guilabel>Result list font</guilabel>: There
is quite a lot of information shown in the result list, and
you may want to customise the font and/or font size. The rest
of the fonts used by &RCL; are determined by your generic QT
config (try the <command>qtconfig</command> command.</para>
</listitem>
<listitem><para><guilabel>Html help browser</guilabel>: this
will let you chose your the preferred browser which will be
started from the <guimenu>Help</guimenu> menu to read the user
manual. You can enter a simple name if the command is in your
PATH, or browse for a full pathname.</para>
</listitem>
<listitem><para><guilabel>Show document type icons in result
list</guilabel>: icons in the result list can be turned
off. They take quite a lot of space and convey relatively
little useful information.</para>
</listitem>
</itemizedlist>
<para>Search parameters:</para>
<itemizedlist>
<listitem><para><guilabel>Stemming language</guilabel>:
stemming obviously depends on the document's language. This
listbox will let you chose among the stemming databases which
were built during indexing (this is set in the <link
linkend="rcl.install.config.recollconf">main configuration
file</link>), or later added with
<command>recollindex -s</command> (See the recollindex
manual). Stemming languages which are dynamically added will be
deleted at the next indexation pass unless they are also added in
the configuration file.</para>
</listitem>
<listitem><para><guilabel>Dynamically build
abstracts</guilabel>: this decides if &RCL; tries to build
document abstracts when displaying the result list. Abstracts
are constructed by taking context from the document
information, around the search terms. This can slow down
result list display significantly for big documents, and you
may want to turn it off.</para>
</listitem>
<listitem><para><guilabel>Replace abstracts from
documents</guilabel>: this decides if we should synthetize and
display an abstract in place of an explicit abstract found
within the document itself.</para>
</listitem>
</itemizedlist>
</sect1>
@ -430,16 +508,16 @@
<title>Prerequisites</title>
<para>At the very least, you will need to download and install the
<ulink url="http://www.xapian.org">xapian core
package</ulink> (&RCL; currently uses version 0.9.2), and the <ulink
<ulink url="http://www.xapian.org">xapian core package</ulink>
(&RCL; currently uses version 0.9.2), and the <ulink
url="http://www.trolltech.com/products/qt/index.html">qt
runtime and development packages</ulink> (&RCL; currently uses
version 3.3.3).</para>
runtime and development packages</ulink> (&RCL; development
currently uses version 3.3.5, but any 3.3 version is
probably ok).</para>
<para>You will most probably be able to find a binary package for
<application>qt</application> for your system. You may have to
compile <application>Xapian</application>,
but this is not difficult (if you are using
compile &XAP; but this is not difficult (if you are using
<application>FreeBSD</application>, there is a port).</para>
<para>You may also need

2
src/excludefile
View File

@ -9,6 +9,7 @@
.obj
.ui
CVS
Makefile
TAGS
alldeps
autom4*
@ -20,6 +21,7 @@ lib/librcl.a
makesrcdist.sh
mk/localdefs
qtgui/Makefile
qtgui/recoll.pro
qtgui/preview/Makefile
qtgui/preview/preview.pro
qtgui/preview/pvmain.cpp

5
src/makesrcdist.sh
View File

@ -1,5 +1,5 @@
#!/bin/sh
# @(#$Id: makesrcdist.sh,v 1.8 2006-01-21 15:36:05 dockes Exp $ (C) 2005 J.F.Dockes
# @(#$Id: makesrcdist.sh,v 1.9 2006-02-01 07:12:14 dockes Exp $ (C) 2005 J.F.Dockes
# A shell-script to make a recoll source distribution
#set -x
@ -66,8 +66,9 @@ sed -e '/\.\/index\.html/d' -e '/\.\/book\.html/d' \
diff $topdir/doc/user/u1.html $topdir/doc/user/usermanual.html
mv -f $topdir/doc/user/u1.html $topdir/doc/user/usermanual.html
# We tag .. as there is the 'packaging/' directory in there
CVSTAG="RECOLL-$versionforcvs"
[ $dotag = "yes" ] && cvs tag -F $CVSTAG .
[ $dotag = "yes" ] && (cd ..;cvs tag -F $CVSTAG .)
out=recoll-$version.tar.gz
(cd $targetdir ; \