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 2009-01-06 17:30:32 +00:00
parent 8c627af212
commit 51c48b0197
36 changed files with 407 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
website/howtos/index.html Normal file
View File

@ -0,0 +1,47 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Recoll howtos</title>
<meta name="generator" content="HTML Tidy, see www.w3.org">
<meta name="Author" content="Jean-Francois Dockes">
<meta name="Description" content=
"recoll is a simple full-text search system for unix and linux
based on the powerful and mature xapian engine">
<meta name="Keywords" content=
"full text search, desktop search, unix, linux">
<meta http-equiv="Content-language" content="en">
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
<meta name="robots" content="All,Index,Follow">
<link type="text/css" rel="stylesheet" href="../styles/style.css">
</head>
<body>
<div class="rightlinks">
<ul>
<li><a href="../../index.html">Home</a></li>
<li><a href="../../doc.html">Documentation</a></li>
<li><a href="../../download.html">Downloads</a></li>
</ul>
</div>
<div class="content">
<h1>Recoll howtos</h1>
<p>The following short documents contain information
mostly extracted from the main user manual (possibly out of
separate sections), arranged differently in order to explain
how to achieve a given goal.</p>
<ul>
<li><a href="prevent_indexing_a_directory/index.html"> Preventing indexing in a given directory</a></li>
<li><a href="use_multiple_indexes/index.html"> Creating and using multiple indexes</a></li>
</ul>
</div>
</body>
</html>

68
website/howtos/prevent_indexing_a_directory/index.html Normal file
View File

@ -0,0 +1,68 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Recoll howtos</title>
<meta name="generator" content="HTML Tidy, see www.w3.org">
<meta name="Author" content="Jean-Francois Dockes">
<meta name="Description" content=
"recoll is a simple full-text search system for unix and linux
based on the powerful and mature xapian engine">
<meta name="Keywords" content=
"full text search, desktop search, unix, linux">
<meta http-equiv="Content-language" content="en">
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
<meta name="robots" content="All,Index,Follow">
<link type="text/css" rel="stylesheet" href="../../styles/style.css">
</head>
<body>
<div class="rightlinks">
<ul>
<li><a href="../../index.html">Home</a></li>
<li><a href="../../doc.html">Documentation</a></li>
<li><a href="../index.html">Howtos</a></li>
</ul>
</div>
<div class="content">
<h1>Preventing indexing in a directory</h1>
<h2>Why would you want to do this ?</h2>
<p>By default, recollindex (or the indexing thread inside the
recoll QT user interface) will process your home directories and
most its subdirectories, at the exception of some well known
places (thumbnails, beagle and web browser caches, etc.)</p>
<p>You may want to prevent indexing in some directories where
you don't expect interesting search results. This will avoid
polluting the search result lists, speed up indexing times and
make the index smaller.</p>
<h2>How to do it</h2>
<p>There are two ways to block indexing at certain points:
either by listing specific paths, or by directory name pattern
matches.</p>
<ul>
<li><em>Blocking specific paths</em>: this is controlled by
the <tt>skippedPaths</tt> variable in the main configuration
file. You can adjust the value either by editing the file or
by using the indexing configuration dialog:
<span class="guimenu">Preferences->Indexing&nbsp;configuration->Global&nbsp;parameters->Skipped&nbsp;paths</span></li>
<li><em>Using pattern matches</em>: these are listed in the
<tt>skippedNames</tt> variable in the main configuration file. You
can adjust the value either by editing the file or by using
the GUI:
<span class="guimenu">Preferences->Indexing&nbsp;configuration->Local&nbsp;parameters->Skipped&nbsp;names</span></li>
</ul>
</div>
</body>
</html>

109
website/howtos/use_multiple_indexes/index.html Normal file
View File

@ -0,0 +1,109 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Recoll howtos</title>
<meta name="generator" content="HTML Tidy, see www.w3.org">
<meta name="Author" content="Jean-Francois Dockes">
<meta name="Description" content=
"recoll is a simple full-text search system for unix and linux
based on the powerful and mature xapian engine">
<meta name="Keywords" content=
"full text search, desktop search, unix, linux">
<meta http-equiv="Content-language" content="en">
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
<meta name="robots" content="All,Index,Follow">
<link type="text/css" rel="stylesheet" href="../../styles/style.css">
</head>
<body>
<div class="rightlinks">
<ul>
<li><a href="../../index.html">Home</a></li>
<li><a href="../../doc.html">Documentation</a></li>
<li><a href="../index.html">Howtos</a></li>
</ul>
</div>
<div class="content">
<h1>Creating and using multiple indexes</h1>
<h2>Why would you want to do this ?</h2>
<ul>
<li>Easy adjustment of search areas: you can filter
results by using the directory filter in the advanced search
panel, but, if you have separate well defined places where
you store different kind of data, it is easier to maintain
separate index and use the <em>External indexes</em> dialog
to switch them on or off, and it will also yield much better
search performance.</li>
<li>Shared indexes: it may be useful to maintain one or
several indexes for shared data, and separate personal
indexes for each user.</li>
</ul>
<h2>How to do it</h2>
<p>As an example we'll suppose that you
have <span class="application">Recoll</span> installed and indexing your
home directory, and that you would like to have a separate index
for <tt class="filename">/usr/shared/doc</tt>.</p>
<p>You need to create a separate configuration for the new index,
then add it to the external indexes list in the user
interface, and activate it as needed. </p>
<ol>
<li>Create a directory for the new index:
<pre>cd
mkdir .recoll-sharedoc
</pre>
</li>
<li>Create a minimal configuration file:
<pre>cd .recoll-sharedoc
echo "topdirs = /usr/share/doc" > recoll.conf
</pre>
</li>
<li>Perform initial indexing:
<pre>recollindex -c ~/.recoll-sharedoc</pre>
</li>
<li>Optionally set up cron to perform nightly indexing, use
<pre>crontab -e</pre>
and insert a line like the following:
<pre>45 20 * * * recollindex -c ~/.recoll-sharedoc</pre>
This would start the indexing at
20:45. <tt class="command">crontab&nbsp;-e</tt> will use the
<tt class="command">vi</tt> editor by default, you can
change this by using the <tt class="command">EDITOR</tt>
environment variable. Exemple:
<pre>EDITOR=kate crontab -e</pre>
Your favorite desktop may also have a dedicated tool to add
<tt class="filename">crontab</tt> entries.
</li>
<li>Start <tt class="command">recoll</tt> and choose
the <span
class="guimenu">Preferences->External&nbsp;index&nbsp;dialog</span>
menu entry, then click the <span class="guilabel">Browse</span> button
(near the bottom), and select the new index Xapian database
directory:
<pre><tt class="filename">~/.recoll-sharedoc/xapiandb</tt></pre>
Then click <span class="guilabel">Add&nbsp;index</span>.
</li>
<li>You can then activate or deactivate the new index by
clicking the box in front of the directory name in the list.
</li>
</ol>
<p>When adding an index shared by multiple users, it may
be helpful to use
the <tt class="variable">RECOLL_EXTRA_DBS</tt> environment
variable instead of editing individual configurations, see the
manual for more details.</p>
</div>
</body>
</html>

8
website/pics/piclist.txt Normal file
View File

@ -0,0 +1,8 @@
recoll0.png
recoll1.png
recoll2.png
recoll3.png
recoll4.png
recoll5.png
recoll_chinese.png
recoll-HTML_search_results.png

BIN
website/pics/recoll-HTML_search_results-thumb.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 178 KiB

40
website/pics/recoll-HTML_search_results.html Normal file
View File

@ -0,0 +1,40 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Photo</title>
</head>
<body>
<p><a href="recoll_chinese.html">Prev</a> <a href=".">Up</a>
<a href="recoll0.html">Next</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<a href="recoll-HTML_search_results.png">Raw Image</a></p>
<p>A customized result list, thanks to Michael Croes. The html code follows,
it should be pasted into the
<i>Preferences->Query&nbsp;Configuration->Result&nbsp;paragraph&nbsp;format&nbsp;string</i> entry.
<pre>
&lt;table border="1" bgcolor="lightyellow">
&lt;tr>
&lt;td rowspan="4" width="40px" align="center"
valign="center">
&lt;img src="%I" width="32" height="32">
&lt;p>&lt;b>%R&lt;/b>&lt;/p>
&lt;p>&lt;a href="P%N">Aperçu&lt;/a>&lt;/p>
&lt;/td>
&lt;th colspan="3" bgcolor="lightgrey">%T&lt;/th>
&lt;/tr>
&lt;tr>
&lt;td align="center">%M&lt;/td>
&lt;td align="center">%D&lt;/td>
&lt;td align="center">%S&lt;/td>
&lt;/tr>
&lt;tr>
&lt;td colspan="3">&lt;a href="E%N">%U&lt;/a>&lt;/td>
&lt;/tr>
&lt;tr>
&lt;td colspan="3">%A&lt;/td>
&lt;/tr>
&lt;/table>
</pre></p>
<p><img height="90%" src=recoll-HTML_search_results.png></p>
</body>
</html>

BIN
website/pics/recoll-HTML_search_results.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 62 KiB

28
website/pics/recoll-HTML_search_results.txt Normal file
View File

@ -0,0 +1,28 @@
A customized result list, thanks to Michael Croes. The html code follows,
it should be pasted into the
<i>Preferences->Query&nbsp;Configuration->Result&nbsp;paragraph&nbsp;format&nbsp;string</i> entry.
<pre>
&lt;table border="1" bgcolor="lightyellow">
&lt;tr>
&lt;td rowspan="4" width="40px" align="center"
valign="center">
&lt;img src="%I" width="32" height="32">
&lt;p>&lt;b>%R&lt;/b>&lt;/p>
&lt;p>&lt;a href="P%N">Aperçu&lt;/a>&lt;/p>
&lt;/td>
&lt;th colspan="3" bgcolor="lightgrey">%T&lt;/th>
&lt;/tr>
&lt;tr>
&lt;td align="center">%M&lt;/td>
&lt;td align="center">%D&lt;/td>
&lt;td align="center">%S&lt;/td>
&lt;/tr>
&lt;tr>
&lt;td colspan="3">&lt;a href="E%N">%U&lt;/a>&lt;/td>
&lt;/tr>
&lt;tr>
&lt;td colspan="3">%A&lt;/td>
&lt;/tr>
&lt;/table>
</pre>

BIN
website/pics/recoll0-thumb.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 124 KiB

13
website/pics/recoll0.html Normal file
View File

@ -0,0 +1,13 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Photo</title>
</head>
<body>
<p><a href=".">Prev</a> <a href=".">Up</a>
<a href="recoll1.html">Next</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<a href="recoll0.png">Raw Image</a></p>
<p>A result list with the mime type icons feature turned on.</p>
<p><img height="90%" src=recoll0.png></p>
</body>
</html>

BIN
website/pics/recoll0.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 128 KiB

1
website/pics/recoll0.txt Normal file
View File

@ -0,0 +1 @@
A result list with the mime type icons feature turned on.

BIN
website/pics/recoll1-thumb.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 154 KiB

13
website/pics/recoll1.html Normal file
View File

@ -0,0 +1,13 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Photo</title>
</head>
<body>
<p><a href="recoll0.html">Prev</a> <a href=".">Up</a>
<a href="recoll2.html">Next</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<a href="recoll1.png">Raw Image</a></p>
<p>A result list with a preview window open.</p>
<p><img height="90%" src=recoll1.png></p>
</body>
</html>

BIN
website/pics/recoll1.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 181 KiB

4
website/pics/recoll1.txt Normal file
View File

@ -0,0 +1,4 @@
A result list with a preview window open.

BIN
website/pics/recoll2-thumb.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 45 KiB

13
website/pics/recoll2.html Normal file
View File

@ -0,0 +1,13 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Photo</title>
</head>
<body>
<p><a href="recoll1.html">Prev</a> <a href=".">Up</a>
<a href="recoll3.html">Next</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<a href="recoll2.png">Raw Image</a></p>
<p>The advanced search dialog.</p>
<p><img height="90%" src=recoll2.png></p>
</body>
</html>

BIN
website/pics/recoll2.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 46 KiB

1
website/pics/recoll2.txt Normal file
View File

@ -0,0 +1 @@
The advanced search dialog.

BIN
website/pics/recoll3-thumb.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 55 KiB

14
website/pics/recoll3.html Normal file
View File

@ -0,0 +1,14 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Photo</title>
</head>
<body>
<p><a href="recoll2.html">Prev</a> <a href=".">Up</a>
<a href="recoll4.html">Next</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<a href="recoll3.png">Raw Image</a></p>
<p>A result list from which the native application (firefox)
was started by clicking the Edit link.</p>
<p><img height="90%" src=recoll3.png></p>
</body>
</html>

BIN
website/pics/recoll3.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 166 KiB

2
website/pics/recoll3.txt Normal file
View File

@ -0,0 +1,2 @@
A result list from which the native application (firefox)
was started by clicking the Edit link.

BIN
website/pics/recoll4-thumb.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 65 KiB

14
website/pics/recoll4.html Normal file
View File

@ -0,0 +1,14 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Photo</title>
</head>
<body>
<p><a href="recoll3.html">Prev</a> <a href=".">Up</a>
<a href="recoll5.html">Next</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<a href="recoll4.png">Raw Image</a></p>
<p>The document history window looks a little like a result list
I'm afraid...</p>
<p><img height="90%" src=recoll4.png></p>
</body>
</html>

BIN
website/pics/recoll4.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 54 KiB

2
website/pics/recoll4.txt Normal file
View File

@ -0,0 +1,2 @@
The document history window looks a little like a result list
I'm afraid...

BIN
website/pics/recoll5-thumb.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 40 KiB

13
website/pics/recoll5.html Normal file
View File

@ -0,0 +1,13 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Photo</title>
</head>
<body>
<p><a href="recoll4.html">Prev</a> <a href=".">Up</a>
<a href="recoll_chinese.html">Next</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<a href="recoll5.png">Raw Image</a></p>
<p>The term explorer tool in phonetic mode.</p>
<p><img height="90%" src=recoll5.png></p>
</body>
</html>

BIN
website/pics/recoll5.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 28 KiB

1
website/pics/recoll5.txt Normal file
View File

@ -0,0 +1 @@
The term explorer tool in phonetic mode.

BIN
website/pics/recoll_chinese-thumb.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 190 KiB

14
website/pics/recoll_chinese.html Normal file
View File

@ -0,0 +1,14 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Photo</title>
</head>
<body>
<p><a href="recoll5.html">Prev</a> <a href=".">Up</a>
<a href="recoll-HTML_search_results.html">Next</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<a href="recoll_chinese.png">Raw Image</a></p>
<p>Recoll searching Chinese text. Chinese text search is based on n-grams and
relatively rough, but still useful (I am told).</p>
<p><img height="90%" src=recoll_chinese.png></p>
</body>
</html>

BIN
website/pics/recoll_chinese.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 721 KiB

2
website/pics/recoll_chinese.txt Normal file
View File

@ -0,0 +1,2 @@
Recoll searching Chinese text. Chinese text search is based on n-grams and
relatively rough, but still useful (I am told).