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.
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.)
+
+
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.
+
+
How to do it
+
There are two ways to block indexing at certain points:
+ either by listing specific paths, or by directory name pattern
+ matches.
+
+
Blocking specific paths: this is controlled by
+ the skippedPaths variable in the main configuration
+ file. You can adjust the value either by editing the file or
+ by using the indexing configuration dialog:
+ Preferences->Indexing configuration->Global parameters->Skipped paths
+
+
Using pattern matches: these are listed in the
+ skippedNames variable in the main configuration file. You
+ can adjust the value either by editing the file or by using
+ the GUI:
+ Preferences->Indexing configuration->Local parameters->Skipped names
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 External indexes dialog
+ to switch them on or off, and it will also yield much better
+ search performance.
+
Shared indexes: it may be useful to maintain one or
+ several indexes for shared data, and separate personal
+ indexes for each user.
+
+
+
How to do it
+
+
As an example we'll suppose that you
+ have Recoll installed and indexing your
+ home directory, and that you would like to have a separate index
+ for /usr/shared/doc.
+
+
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.
+
+
+
Create a directory for the new index:
+
cd
+mkdir .recoll-sharedoc
+
+
+
Create a minimal configuration file:
+
cd .recoll-sharedoc
+echo "topdirs = /usr/share/doc" > recoll.conf
+
+
+
Perform initial indexing:
+
recollindex -c ~/.recoll-sharedoc
+
+
Optionally set up cron to perform nightly indexing, use
+
crontab -e
+ and insert a line like the following:
+
45 20 * * * recollindex -c ~/.recoll-sharedoc
+ This would start the indexing at
+ 20:45. crontab -e will use the
+ vi editor by default, you can
+ change this by using the EDITOR
+ environment variable. Exemple:
+
EDITOR=kate crontab -e
+ Your favorite desktop may also have a dedicated tool to add
+ crontab entries.
+
+
Start recoll and choose
+ the Preferences->External index dialog
+ menu entry, then click the Browse button
+ (near the bottom), and select the new index Xapian database
+ directory:
+
~/.recoll-sharedoc/xapiandb
+ Then click Add index.
+
+
You can then activate or deactivate the new index by
+ clicking the box in front of the directory name in the list.
+
+
+
+
When adding an index shared by multiple users, it may
+ be helpful to use
+ the RECOLL_EXTRA_DBS environment
+ variable instead of editing individual configurations, see the
+ manual for more details.
+
+
+
+
diff --git a/website/pics/piclist.txt b/website/pics/piclist.txt
new file mode 100644
index 00000000..e3b6f8d4
--- /dev/null
+++ b/website/pics/piclist.txt
@@ -0,0 +1,8 @@
+recoll0.png
+recoll1.png
+recoll2.png
+recoll3.png
+recoll4.png
+recoll5.png
+recoll_chinese.png
+recoll-HTML_search_results.png
diff --git a/website/pics/recoll-HTML_search_results-thumb.png b/website/pics/recoll-HTML_search_results-thumb.png
new file mode 100644
index 00000000..51fe26f9
Binary files /dev/null and b/website/pics/recoll-HTML_search_results-thumb.png differ
diff --git a/website/pics/recoll-HTML_search_results.html b/website/pics/recoll-HTML_search_results.html
new file mode 100644
index 00000000..f4eaf74a
--- /dev/null
+++ b/website/pics/recoll-HTML_search_results.html
@@ -0,0 +1,40 @@
+
+
+
+ Photo
+
+
+
A customized result list, thanks to Michael Croes. The html code follows,
+it should be pasted into the
+Preferences->Query Configuration->Result paragraph format string entry.
+
+
+
+
diff --git a/website/pics/recoll-HTML_search_results.png b/website/pics/recoll-HTML_search_results.png
new file mode 100644
index 00000000..918a596b
Binary files /dev/null and b/website/pics/recoll-HTML_search_results.png differ
diff --git a/website/pics/recoll-HTML_search_results.txt b/website/pics/recoll-HTML_search_results.txt
new file mode 100644
index 00000000..04cc7845
--- /dev/null
+++ b/website/pics/recoll-HTML_search_results.txt
@@ -0,0 +1,28 @@
+A customized result list, thanks to Michael Croes. The html code follows,
+it should be pasted into the
+Preferences->Query Configuration->Result paragraph format string entry.
+
+
Recoll searching Chinese text. Chinese text search is based on n-grams and
+relatively rough, but still useful (I am told).
+
+
+
diff --git a/website/pics/recoll_chinese.png b/website/pics/recoll_chinese.png
new file mode 100644
index 00000000..2dbe6235
Binary files /dev/null and b/website/pics/recoll_chinese.png differ
diff --git a/website/pics/recoll_chinese.txt b/website/pics/recoll_chinese.txt
new file mode 100644
index 00000000..da25aac6
--- /dev/null
+++ b/website/pics/recoll_chinese.txt
@@ -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).
