|
a/src/doc/user/usermanual.sgml |
|
b/src/doc/user/usermanual.sgml |
|
... |
|
... |
| 8 |
|
8 |
|
| 9 |
<!ENTITY RCL "<application>Recoll</application>">
|
9 |
<!ENTITY RCL "<application>Recoll</application>">
|
| 10 |
<!ENTITY RCLAPPS "<ulink url='http://www.recoll.org/features.html'>Recoll helper applications page</ulink>">
|
10 |
<!ENTITY RCLAPPS "<ulink url='http://www.recoll.org/features.html'>Recoll helper applications page</ulink>">
|
| 11 |
<!ENTITY RCLVERSION "1.18">
|
11 |
<!ENTITY RCLVERSION "1.18">
|
| 12 |
<!ENTITY XAP "<application>Xapian</application>">
|
12 |
<!ENTITY XAP "<application>Xapian</application>">
|
|
|
13 |
<!ENTITY WIKI "http://bitbucket.org/medoc/recoll/wiki/">
|
| 13 |
]>
|
14 |
]>
|
| 14 |
|
15 |
|
| 15 |
<book lang="en">
|
16 |
<book lang="en">
|
| 16 |
|
17 |
|
| 17 |
<bookinfo>
|
18 |
<bookinfo>
|
|
... |
|
... |
| 216 |
command line interface</link>, a
|
217 |
command line interface</link>, a
|
| 217 |
<link linkend="rcl.program.api.python">
|
218 |
<link linkend="rcl.program.api.python">
|
| 218 |
<application>Python</application>
|
219 |
<application>Python</application>
|
| 219 |
programming interface</link>, a <link linkend="rcl.search.kio">
|
220 |
programming interface</link>, a <link linkend="rcl.search.kio">
|
| 220 |
<application>KDE</application> KIO slave module</link>, and
|
221 |
<application>KDE</application> KIO slave module</link>, and
|
| 221 |
a <ulink url="http://bitbucket.org/medoc/recoll/wiki/UnityLens">Ubuntu Unity Lens</ulink> module.
|
222 |
a <ulink url="&WIKI;UnityLens">Ubuntu Unity Lens</ulink> module.
|
| 222 |
</para>
|
223 |
</para>
|
| 223 |
|
224 |
|
| 224 |
</sect1>
|
225 |
</sect1>
|
| 225 |
</chapter>
|
226 |
</chapter>
|
| 226 |
|
227 |
|
|
... |
|
... |
| 720 |
create the queue directory:
|
721 |
create the queue directory:
|
| 721 |
<filename>~/.beagle/ToIndex/</filename>.</para></important>
|
722 |
<filename>~/.beagle/ToIndex/</filename>.</para></important>
|
| 722 |
|
723 |
|
| 723 |
<para>Current Firefox versions need a slightly adapted extension
|
724 |
<para>Current Firefox versions need a slightly adapted extension
|
| 724 |
module. This can be found, along with up-to-date instructions, on the
|
725 |
module. This can be found, along with up-to-date instructions, on the
|
| 725 |
<ulink url="https://bitbucket.org/medoc/recoll/wiki/IndexBeagleWeb">
|
726 |
<ulink url="&WIKI;IndexBeagleWeb">Recoll wiki</ulink>.</para>
|
| 726 |
Recoll wiki</ulink>.</para>
|
|
|
| 727 |
|
727 |
|
| 728 |
|
728 |
|
| 729 |
<para>A copy of the indexed WEB pages is retained by Recoll in a
|
729 |
<para>A copy of the indexed WEB pages is retained by Recoll in a
|
| 730 |
local cache (from which previews can be fetched). The cache size can
|
730 |
local cache (from which previews can be fetched). The cache size can
|
| 731 |
be adjusted from the <guilabel>Index configuration</guilabel> /
|
731 |
be adjusted from the <guilabel>Index configuration</guilabel> /
|
|
... |
|
... |
| 1186 |
<para>The result list is divided into pages (the size of which
|
1186 |
<para>The result list is divided into pages (the size of which
|
| 1187 |
you can change in the preferences). Use the arrow buttons in the
|
1187 |
you can change in the preferences). Use the arrow buttons in the
|
| 1188 |
toolbar or the links at the bottom of the page to browse the
|
1188 |
toolbar or the links at the bottom of the page to browse the
|
| 1189 |
results.</para>
|
1189 |
results.</para>
|
| 1190 |
|
1190 |
|
|
|
1191 |
<sect3 id="rcl.search.gui.reslist.suggs">
|
|
|
1192 |
<title>No results: the spelling suggestions</title>
|
|
|
1193 |
|
|
|
1194 |
<para>When a search yields no result, and if the
|
|
|
1195 |
<application>aspell</application> dictionary is configured, &RCL;
|
|
|
1196 |
will try to check for misspellings among the query terms, and
|
|
|
1197 |
will propose lists of replacements. Clicking on one of the
|
|
|
1198 |
suggestions will replace the word and restart the search. You can
|
|
|
1199 |
hold any of the modifier keys (Ctrl, Shift, etc.) while clicking
|
|
|
1200 |
if you would rather stay on the suggestion screen because several
|
|
|
1201 |
terms need replacement.</para>
|
|
|
1202 |
|
|
|
1203 |
</sect3>
|
|
|
1204 |
|
| 1191 |
|
1205 |
|
| 1192 |
<sect3 id="rcl.search.gui.resultlist.menu">
|
1206 |
<sect3 id="rcl.search.gui.resultlist.menu">
|
| 1193 |
<title>The result list right-click menu</title>
|
1207 |
<title>The result list right-click menu</title>
|
| 1194 |
|
1208 |
|
| 1195 |
<para>Apart from the preview and edit links, you can display a
|
1209 |
<para>Apart from the preview and edit links, you can display a
|
|
... |
|
... |
| 1253 |
the native viewer on the appropriate page. If the viewer supports
|
1267 |
the native viewer on the appropriate page. If the viewer supports
|
| 1254 |
it, its search function will also be primed with one of the
|
1268 |
it, its search function will also be primed with one of the
|
| 1255 |
search terms.</para>
|
1269 |
search terms.</para>
|
| 1256 |
|
1270 |
|
| 1257 |
</sect3>
|
1271 |
</sect3>
|
|
|
1272 |
|
| 1258 |
</sect2>
|
1273 |
</sect2>
|
| 1259 |
|
1274 |
|
| 1260 |
<sect2 id="rcl.search.gui.restable">
|
1275 |
<sect2 id="rcl.search.gui.restable">
|
| 1261 |
<title>The result table</title>
|
1276 |
<title>The result table</title>
|
| 1262 |
|
1277 |
|
|
... |
|
... |
| 1286 |
the row to freeze the display. The bottom area is equivalent to a
|
1301 |
the row to freeze the display. The bottom area is equivalent to a
|
| 1287 |
result list paragraph, with links for starting a preview or a
|
1302 |
result list paragraph, with links for starting a preview or a
|
| 1288 |
native application, and an equivalent right-click menu. Typing
|
1303 |
native application, and an equivalent right-click menu. Typing
|
| 1289 |
<keycap>Esc</keycap> (the Escape key) will unfreeze the
|
1304 |
<keycap>Esc</keycap> (the Escape key) will unfreeze the
|
| 1290 |
display.</para>
|
1305 |
display.</para>
|
|
|
1306 |
|
|
|
1307 |
</sect2>
|
|
|
1308 |
|
|
|
1309 |
<sect2 id="rcl.search.gui.thumbnails">
|
|
|
1310 |
<title>Displaying thumbnails</title>
|
|
|
1311 |
|
|
|
1312 |
<para>The default format for the result list entries and the
|
|
|
1313 |
detail area of the result table display an icon for each result
|
|
|
1314 |
document. The icon is either a generic one determined from the
|
|
|
1315 |
MIME type, or a thumbnail of the document appearance. Thumbnails
|
|
|
1316 |
are only displayed if found in the standard
|
|
|
1317 |
<application>freedesktop</application> location, where they would
|
|
|
1318 |
typically have been created by a file manager.</para>
|
|
|
1319 |
|
|
|
1320 |
<para>Recoll has no capability to create thumbnails. A relatively
|
|
|
1321 |
simple trick is to use the <guilabel>Open parent
|
|
|
1322 |
document/folder</guilabel> entry in the result list popup
|
|
|
1323 |
menu. This should open a file manager window on the containing
|
|
|
1324 |
directory, which should in turn create the thumbnails (depending on
|
|
|
1325 |
your settings). Restarting the search should then display the
|
|
|
1326 |
thumbnails.</para>
|
|
|
1327 |
|
|
|
1328 |
<para>There are also <ulink url="&WIKI;ResultThumbnails.wiki">some
|
|
|
1329 |
pointers about thumbnail generation</ulink> on the &RCL; wiki.
|
|
|
1330 |
</para>
|
| 1291 |
|
1331 |
|
| 1292 |
</sect2>
|
1332 |
</sect2>
|
| 1293 |
|
1333 |
|
| 1294 |
<sect2 id="rcl.search.gui.preview">
|
1334 |
<sect2 id="rcl.search.gui.preview">
|
| 1295 |
<title>The preview window</title>
|
1335 |
<title>The preview window</title>
|
|
... |
|
... |
| 2951 |
described in a <link linkend="rcl.search.kio">previous
|
2991 |
described in a <link linkend="rcl.search.kio">previous
|
| 2952 |
section</link>.</para>
|
2992 |
section</link>.</para>
|
| 2953 |
</listitem>
|
2993 |
</listitem>
|
| 2954 |
<listitem>
|
2994 |
<listitem>
|
| 2955 |
<para>If you use a recent version of Ubuntu Linux, you may
|
2995 |
<para>If you use a recent version of Ubuntu Linux, you may
|
| 2956 |
find the <ulink
|
2996 |
find the <ulink url="&WIKI;UnityLens">Ubuntu Unity
|
| 2957 |
url="http://bitbucket.org/medoc/recoll/wiki/UnityLens">Ubuntu Unity
|
|
|
| 2958 |
Lens</ulink> module useful.</para>
|
2997 |
Lens</ulink> module useful.</para>
|
| 2959 |
</listitem>
|
2998 |
</listitem>
|
| 2960 |
<listitem>
|
2999 |
<listitem>
|
| 2961 |
<para>There is also an independantly developed
|
3000 |
<para>There is also an independantly developed
|
| 2962 |
<ulink
|
3001 |
<ulink
|
|
... |
|
... |
| 2973 |
<para>It is surprisingly convenient to be able to show or hide the
|
3012 |
<para>It is surprisingly convenient to be able to show or hide the
|
| 2974 |
&RCL; GUI with a single keystroke. Recoll comes with a small
|
3013 |
&RCL; GUI with a single keystroke. Recoll comes with a small
|
| 2975 |
Python script, based on the <application>libwnck</application> window
|
3014 |
Python script, based on the <application>libwnck</application> window
|
| 2976 |
manager interface library, which will allow you to do just
|
3015 |
manager interface library, which will allow you to do just
|
| 2977 |
this. The detailed instructions are on
|
3016 |
this. The detailed instructions are on
|
| 2978 |
<ulink url="http://bitbucket.org/medoc/recoll/wiki/HotRecoll">
|
3017 |
<ulink url="&WIKI;HotRecoll">this wiki page</ulink>.</para>
|
| 2979 |
this wiki page</ulink>.</para>
|
|
|
| 2980 |
|
3018 |
|
| 2981 |
</sect2>
|
3019 |
</sect2>
|
| 2982 |
|
3020 |
|
| 2983 |
<sect2 id="rcl.kicker-applet">
|
3021 |
<sect2 id="rcl.kicker-applet">
|
| 2984 |
<title>The KDE Kicker Recoll applet</title>
|
3022 |
<title>The KDE Kicker Recoll applet</title>
|
|
... |
|
... |
| 3305 |
<para>You can find more information in the
|
3343 |
<para>You can find more information in the
|
| 3306 |
<link linkend="rcl.install.config.fields">section about the
|
3344 |
<link linkend="rcl.install.config.fields">section about the
|
| 3307 |
<filename>fields</filename> file</link>, or in comments inside the
|
3345 |
<filename>fields</filename> file</link>, or in comments inside the
|
| 3308 |
file.</para>
|
3346 |
file.</para>
|
| 3309 |
|
3347 |
|
| 3310 |
<para>You can also have a look at the <ulink
|
3348 |
<para>You can also have a look at the
|
| 3311 |
url="https://bitbucket.org/medoc/recoll/wiki/HandleCustomField">example
|
3349 |
<ulink url="&WIKI;HandleCustomField">example on the Wiki</ulink>,
|
| 3312 |
on the Wiki</ulink>, detailing
|
|
|
| 3313 |
how one could add a <emphasis>page count</emphasis> field to pdf
|
3350 |
detailing how one could add a <emphasis>page count</emphasis> field
|
| 3314 |
documents for displaying inside result lists.</para>
|
3351 |
to pdf documents for displaying inside result lists.</para>
|
| 3315 |
|
3352 |
|
| 3316 |
</sect1>
|
3353 |
</sect1>
|
| 3317 |
|
3354 |
|
| 3318 |
|
3355 |
|
| 3319 |
<sect1 id="rcl.program.api">
|
3356 |
<sect1 id="rcl.program.api">
|