|
a/src/doc/user/usermanual.sgml |
|
b/src/doc/user/usermanual.sgml |
|
... |
|
... |
| 22 |
<year>2005</year>
|
22 |
<year>2005</year>
|
| 23 |
<holder role="mailto:jean-francois.dockes@wanadoo.fr">Jean-Francois
|
23 |
<holder role="mailto:jean-francois.dockes@wanadoo.fr">Jean-Francois
|
| 24 |
Dockes</holder>
|
24 |
Dockes</holder>
|
| 25 |
</copyright>
|
25 |
</copyright>
|
| 26 |
|
26 |
|
| 27 |
<releaseinfo>$Id: usermanual.sgml,v 1.70 2008-12-02 13:16:29 dockes Exp $</releaseinfo>
|
27 |
<releaseinfo>$Id: usermanual.sgml,v 1.71 2008-12-15 09:33:49 dockes Exp $</releaseinfo>
|
| 28 |
|
28 |
|
| 29 |
<abstract>
|
29 |
<abstract>
|
| 30 |
<para>This document introduces full text search notions
|
30 |
<para>This document introduces full text search notions
|
| 31 |
and describes the installation and use of the &RCL;
|
31 |
and describes the installation and use of the &RCL;
|
| 32 |
application. It currently describes &RCL; 1.9.</para>
|
32 |
application. It currently describes &RCL; 1.9.</para>
|
|
... |
|
... |
| 1121 |
|
1121 |
|
| 1122 |
</sect1>
|
1122 |
</sect1>
|
| 1123 |
|
1123 |
|
| 1124 |
<sect1 id="rcl.search.wildcards">
|
1124 |
<sect1 id="rcl.search.wildcards">
|
| 1125 |
<title>More about wildcards</title>
|
1125 |
<title>More about wildcards</title>
|
|
|
1126 |
|
| 1126 |
<para>All words entered in &RCL; search fields will be processed
|
1127 |
<para>All words entered in &RCL; search fields will be processed
|
| 1127 |
for wildcard expansion before the request is finally
|
1128 |
for wildcard expansion before the request is finally
|
| 1128 |
executed.</para>
|
1129 |
executed.</para>
|
| 1129 |
|
1130 |
|
| 1130 |
<para>The wildcard characters are:</para>
|
1131 |
<para>The wildcard characters are:</para>
|
|
... |
|
... |
| 1268 |
</sect1>
|
1269 |
</sect1>
|
| 1269 |
|
1270 |
|
| 1270 |
<sect1 id="rcl.search.tips">
|
1271 |
<sect1 id="rcl.search.tips">
|
| 1271 |
<title>Search tips, shortcuts</title>
|
1272 |
<title>Search tips, shortcuts</title>
|
| 1272 |
|
1273 |
|
|
|
1274 |
<sect2 id="rcl.search.tips.terms">
|
|
|
1275 |
<title>Terms and search expansion</title>
|
|
|
1276 |
|
| 1273 |
<formalpara><title>Term completion</title>
|
1277 |
<formalpara><title>Term completion</title>
|
| 1274 |
<para>Typing <keycap>Esc</keycap> <keycap>Space</keycap> in
|
1278 |
<para>Typing <keycap>Esc</keycap> <keycap>Space</keycap> in
|
| 1275 |
the simple search entry field while entering a word will
|
1279 |
the simple search entry field while entering a word will
|
| 1276 |
either complete the current word if its beginning matches a
|
1280 |
either complete the current word if its beginning matches a
|
| 1277 |
unique term in the index, or open a window to propose a list
|
1281 |
unique term in the index, or open a window to propose a list
|
|
... |
|
... |
| 1280 |
|
1284 |
|
| 1281 |
<formalpara><title>Picking up new terms from result or preview
|
1285 |
<formalpara><title>Picking up new terms from result or preview
|
| 1282 |
text</title>
|
1286 |
text</title>
|
| 1283 |
<para>Double-clicking on a word in the result list or in a
|
1287 |
<para>Double-clicking on a word in the result list or in a
|
| 1284 |
preview window will copy it to the simple search entry field.</para>
|
1288 |
preview window will copy it to the simple search entry field.</para>
|
|
|
1289 |
</formalpara>
|
|
|
1290 |
|
|
|
1291 |
<formalpara><title>Wildcards</title>
|
|
|
1292 |
<para>Wildcards can be used inside search terms in all forms
|
|
|
1293 |
of searches. <link linkend="rcl.search.wildcards">
|
|
|
1294 |
More about wildcards</link>.
|
|
|
1295 |
</para>
|
| 1285 |
</formalpara>
|
1296 |
</formalpara>
|
| 1286 |
|
1297 |
|
| 1287 |
<formalpara><title>Disabling stem expansion</title>
|
1298 |
<formalpara><title>Disabling stem expansion</title>
|
| 1288 |
<para>Entering a capitalized word in any search field will prevent
|
1299 |
<para>Entering a capitalized word in any search field will prevent
|
| 1289 |
stem expansion (no search for
|
1300 |
stem expansion (no search for
|
|
... |
|
... |
| 1293 |
character case should make a difference for a &RCL;
|
1304 |
character case should make a difference for a &RCL;
|
| 1294 |
search. You can also disable stem expansion or change the
|
1305 |
search. You can also disable stem expansion or change the
|
| 1295 |
stemming language in the preferences.</para>
|
1306 |
stemming language in the preferences.</para>
|
| 1296 |
</formalpara>
|
1307 |
</formalpara>
|
| 1297 |
|
1308 |
|
|
|
1309 |
<formalpara><title>Finding related documents</title>
|
|
|
1310 |
<para>Selecting the <guilabel>Find similar documents</guilabel> entry
|
|
|
1311 |
in the result list paragraph right-click menu will select a
|
|
|
1312 |
set of "interesting" terms from the current result, and insert
|
|
|
1313 |
them into the simple search entry field. You can then possibly
|
|
|
1314 |
edit the list and start a search to find documents which may
|
|
|
1315 |
be apparented to the current result.</para>
|
|
|
1316 |
</formalpara>
|
|
|
1317 |
|
| 1298 |
<formalpara><title>Phrases</title>
|
1318 |
<formalpara><title>File names</title>
|
|
|
1319 |
<para>File names are added as terms during indexing, and you can
|
|
|
1320 |
specify them as ordinary terms in normal search fields (&RCL; used
|
|
|
1321 |
to index all directories in the file path as terms. This has been
|
|
|
1322 |
abandoned as it did not seem really useful). Alternatively, you
|
|
|
1323 |
can use the specific file name search which will
|
|
|
1324 |
<emphasis>only</emphasis> look for file names, and may be
|
|
|
1325 |
faster than the generic search especially when using wildcards.</para>
|
|
|
1326 |
</formalpara>
|
|
|
1327 |
|
|
|
1328 |
</sect2>
|
|
|
1329 |
|
|
|
1330 |
|
|
|
1331 |
<sect2 id="rcl.search.tips.phrases">
|
|
|
1332 |
<title>Working with phrases and proximity</title>
|
|
|
1333 |
|
|
|
1334 |
<formalpara><title>Phrases and Proximity searches</title>
|
| 1299 |
<para>A phrase can be looked for by enclosing it in double
|
1335 |
<para>A phrase can be looked for by enclosing it in double
|
| 1300 |
quotes. Example: <literal>"user manual"</literal> will look
|
1336 |
quotes. Example: <literal>"user manual"</literal> will look
|
| 1301 |
only for occurrences of <literal>user</literal> immediately
|
1337 |
only for occurrences of <literal>user</literal> immediately
|
| 1302 |
followed by <literal>manual</literal>. You can use the
|
1338 |
followed by <literal>manual</literal>. You can use the
|
| 1303 |
<guilabel>This exact phrase</guilabel> field of the advanced
|
1339 |
<guilabel>This exact phrase</guilabel> field of the advanced
|
| 1304 |
search dialog to the same effect. Phrases can be entered along
|
1340 |
search dialog to the same effect. Phrases can be entered along
|
| 1305 |
simple terms in all simple or advanced search entry fields
|
1341 |
simple terms in all simple or advanced search entry fields
|
| 1306 |
(except <guilabel>This exact phrase</guilabel>).</para>
|
1342 |
(except <guilabel>This exact phrase</guilabel>).</para>
|
| 1307 |
</formalpara>
|
1343 |
</formalpara>
|
| 1308 |
|
1344 |
|
| 1309 |
<formalpara><title>Browsing the result list inside a preview
|
|
|
| 1310 |
window (1.5)</title>
|
|
|
| 1311 |
<para>Entering <keycap>Shift-Down</keycap> or <keycap>Shift-Up</keycap>
|
|
|
| 1312 |
(<keycap>Shift</keycap> + an arrow key) in a preview window will
|
|
|
| 1313 |
display the next or the previous document from the result
|
|
|
| 1314 |
list. Any secondary search currently active will be executed on
|
|
|
| 1315 |
the new document.</para>
|
|
|
| 1316 |
</formalpara>
|
|
|
| 1317 |
|
|
|
| 1318 |
<formalpara><title>Forced opening of a preview window (1.6)</title>
|
|
|
| 1319 |
<para>You can use <keycap>Shift</keycap>+Click on a result list
|
|
|
| 1320 |
<literal>Preview</literal> link to force the creation of a
|
|
|
| 1321 |
preview window instead of a new tab in the existing one.</para>
|
|
|
| 1322 |
</formalpara>
|
|
|
| 1323 |
|
|
|
| 1324 |
<formalpara><title>AutoPhrases (1.5)</title>
|
1345 |
<formalpara><title>AutoPhrases</title>
|
| 1325 |
<para>This option can be set in the preferences dialog. If it is
|
1346 |
<para>This option can be set in the preferences dialog. If it is
|
| 1326 |
set, a phrase will be automatically built and added to simple
|
1347 |
set, a phrase will be automatically built and added to simple
|
| 1327 |
searches when looking for <literal>Any terms</literal>. This
|
1348 |
searches when looking for <literal>Any terms</literal>. This
|
| 1328 |
will not change radically the results, but will give a relevance
|
1349 |
will not change radically the results, but will give a relevance
|
| 1329 |
boost to the results where the search terms appear as a
|
1350 |
boost to the results where the search terms appear as a
|
|
... |
|
... |
| 1331 |
will still find all documents where either
|
1352 |
will still find all documents where either
|
| 1332 |
<literal>virtual</literal> or <literal>reality</literal> or
|
1353 |
<literal>virtual</literal> or <literal>reality</literal> or
|
| 1333 |
both appear, but those which contain <literal>virtual
|
1354 |
both appear, but those which contain <literal>virtual
|
| 1334 |
reality</literal> should appear sooner in the list.</para>
|
1355 |
reality</literal> should appear sooner in the list.</para>
|
| 1335 |
|
1356 |
|
| 1336 |
<formalpara><title>Finding related documents</title>
|
1357 |
</sect2>
|
| 1337 |
<para>Selecting the <guilabel>Find similar documents</guilabel> entry
|
|
|
| 1338 |
in the result list paragraph right-click menu will select a
|
|
|
| 1339 |
set of "interesting" terms from the current result, and insert
|
|
|
| 1340 |
them into the simple search entry field. You can then possibly
|
|
|
| 1341 |
edit the list and start a search to find documents which may
|
|
|
| 1342 |
be apparented to the current result.</para>
|
|
|
| 1343 |
</formalpara>
|
|
|
| 1344 |
|
1358 |
|
|
|
1359 |
<sect2 id="rcl.search.tips.misc">
|
|
|
1360 |
<title>Others</title>
|
|
|
1361 |
|
|
|
1362 |
|
| 1345 |
<formalpara><title>File names</title>
|
1363 |
<formalpara><title>Using fields</title>
|
| 1346 |
<para>File names are added as terms during indexing, and you can
|
1364 |
<para>You can use the <link linkend="rcl.search.lang">query
|
| 1347 |
specify them as ordinary terms in normal search fields (&RCL; used
|
1365 |
language </link> and field specifications
|
| 1348 |
to index all directories in the file path as terms. This has been
|
1366 |
to only search certain parts of documents. This can be
|
| 1349 |
abandoned as it did not seem really useful). Alternatively, you
|
1367 |
especially helpful with email, for example only searching
|
| 1350 |
can use the specific file name search which will
|
1368 |
emails from a specific originator:
|
| 1351 |
<emphasis>only</emphasis> look for file names and can use wildcard
|
1369 |
<literal>search tips from:helpfulgui</literal>
|
| 1352 |
expansion.</para>
|
1370 |
</para>
|
| 1353 |
</formalpara>
|
1371 |
</formalpara>
|
| 1354 |
|
1372 |
|
| 1355 |
<formalpara><title>Query explanation</title>
|
1373 |
<formalpara><title>Query explanation</title>
|
| 1356 |
<para>You can get an exact description of what the query
|
1374 |
<para>You can get an exact description of what the query
|
| 1357 |
looked for, including stem expansion, and Boolean operators
|
1375 |
looked for, including stem expansion, and Boolean operators
|
| 1358 |
used, by clicking on the result list header.</para>
|
1376 |
used, by clicking on the result list header.</para>
|
|
|
1377 |
</formalpara>
|
|
|
1378 |
|
|
|
1379 |
<formalpara><title>Browsing the result list inside a preview
|
|
|
1380 |
window</title>
|
|
|
1381 |
<para>Entering <keycap>Shift-Down</keycap> or <keycap>Shift-Up</keycap>
|
|
|
1382 |
(<keycap>Shift</keycap> + an arrow key) in a preview window will
|
|
|
1383 |
display the next or the previous document from the result
|
|
|
1384 |
list. Any secondary search currently active will be executed on
|
|
|
1385 |
the new document.</para>
|
|
|
1386 |
</formalpara>
|
|
|
1387 |
|
|
|
1388 |
<formalpara><title>Forced opening of a preview window</title>
|
|
|
1389 |
<para>You can use <keycap>Shift</keycap>+Click on a result list
|
|
|
1390 |
<literal>Preview</literal> link to force the creation of a
|
|
|
1391 |
preview window instead of a new tab in the existing one.</para>
|
| 1359 |
</formalpara>
|
1392 |
</formalpara>
|
| 1360 |
|
1393 |
|
| 1361 |
<formalpara><title>Closing previews</title>
|
1394 |
<formalpara><title>Closing previews</title>
|
| 1362 |
<para>Entering <keycap>^W</keycap> in a tab will
|
1395 |
<para>Entering <keycap>^W</keycap> in a tab will
|
| 1363 |
close it (and, for the last tab, close the preview
|
1396 |
close it (and, for the last tab, close the preview
|
|
... |
|
... |
| 1367 |
|
1400 |
|
| 1368 |
<formalpara><title>Quitting</title>
|
1401 |
<formalpara><title>Quitting</title>
|
| 1369 |
<para>Entering <keycap>^Q</keycap> almost anywhere will
|
1402 |
<para>Entering <keycap>^Q</keycap> almost anywhere will
|
| 1370 |
close the application.</para>
|
1403 |
close the application.</para>
|
| 1371 |
</formalpara>
|
1404 |
</formalpara>
|
| 1372 |
|
1405 |
</sect2>
|
| 1373 |
</sect1>
|
1406 |
</sect1>
|
| 1374 |
|
1407 |
|
| 1375 |
<sect1 id="rcl.search.custom">
|
1408 |
<sect1 id="rcl.search.custom">
|
| 1376 |
<title>Customizing the search interface</title>
|
1409 |
<title>Customizing the search interface</title>
|
| 1377 |
|
1410 |
|