|
a/src/doc/user/usermanual.sgml |
|
b/src/doc/user/usermanual.sgml |
| 1 |
<!DOCTYPE BOOK PUBLIC "-//FreeBSD//DTD DocBook V4.1-Based Extension//EN" [
|
1 |
<!DOCTYPE BOOK PUBLIC "-//FreeBSD//DTD DocBook V4.1-Based Extension//EN" [
|
| 2 |
<!ENTITY RCL "<application>Recoll</application>">
|
2 |
<!ENTITY RCL "<application>Recoll</application>">
|
|
|
3 |
<!ENTITY RCLVERSION "1.12">
|
| 3 |
<!ENTITY XAP "<application>Xapian</application>">
|
4 |
<!ENTITY XAP "<application>Xapian</application>">
|
| 4 |
|
5 |
|
| 5 |
]>
|
6 |
]>
|
| 6 |
|
7 |
|
| 7 |
<book lang="en">
|
8 |
<book lang="en">
|
|
... |
|
... |
| 27 |
<releaseinfo>$Id: usermanual.sgml,v 1.71 2008-12-15 09:33:49 dockes Exp $</releaseinfo>
|
28 |
<releaseinfo>$Id: usermanual.sgml,v 1.71 2008-12-15 09:33:49 dockes Exp $</releaseinfo>
|
| 28 |
|
29 |
|
| 29 |
<abstract>
|
30 |
<abstract>
|
| 30 |
<para>This document introduces full text search notions
|
31 |
<para>This document introduces full text search notions
|
| 31 |
and describes the installation and use of the &RCL;
|
32 |
and describes the installation and use of the &RCL;
|
| 32 |
application. It currently describes &RCL; 1.10.</para>
|
33 |
application. It currently describes &RCL; &RCLVERSION;.</para>
|
| 33 |
</abstract>
|
34 |
</abstract>
|
| 34 |
|
35 |
|
| 35 |
|
36 |
|
| 36 |
</bookinfo>
|
37 |
</bookinfo>
|
| 37 |
|
38 |
|
|
... |
|
... |
| 419 |
packages section</link></para>
|
420 |
packages section</link></para>
|
| 420 |
|
421 |
|
| 421 |
<sect2 id="rcl.indexing.config.gui">
|
422 |
<sect2 id="rcl.indexing.config.gui">
|
| 422 |
<title>The indexing configuration GUI</title>
|
423 |
<title>The indexing configuration GUI</title>
|
| 423 |
|
424 |
|
| 424 |
<para>As of &RCL; 1.10, most parameters
|
425 |
<para>Most parameters for a given indexing configuration can
|
| 425 |
for a given indexing configuration can be set from a
|
|
|
| 426 |
<command>recoll</command> GUI running on this configuration
|
426 |
be set from a <command>recoll</command> GUI running on this
|
| 427 |
(either as default, or by setting <literal>RECOLL_CONFDIR</literal>
|
427 |
configuration (either as default, or by setting
|
| 428 |
or the <literal>-c</literal> option.)</para>
|
428 |
<literal>RECOLL_CONFDIR</literal> or the <literal>-c</literal>
|
|
|
429 |
option.)</para>
|
| 429 |
|
430 |
|
| 430 |
<para>The interface is started from the
|
431 |
<para>The interface is started from the
|
| 431 |
<guilabel>Preferences</guilabel> menu. It has two main
|
432 |
<guilabel>Preferences</guilabel> menu. It has two main
|
| 432 |
panels. The first panel allows setting global variables, like
|
433 |
panels. The first panel allows setting global variables, like
|
| 433 |
the list of top directories or the list of skipped paths. The
|
434 |
the list of top directories or the list of skipped paths. The
|
|
... |
|
... |
| 603 |
exemple, &RCL; can handle things like e-mail addresses, or
|
604 |
exemple, &RCL; can handle things like e-mail addresses, or
|
| 604 |
arbitrary cut and paste from another text window, punctation
|
605 |
arbitrary cut and paste from another text window, punctation
|
| 605 |
and all.</para>
|
606 |
and all.</para>
|
| 606 |
|
607 |
|
| 607 |
<para>The main case where you should enter text differently from
|
608 |
<para>The main case where you should enter text differently from
|
| 608 |
how it is printed is for east-oriental languages written with
|
609 |
how it is printed is for east-asian languages (Chinese,
|
| 609 |
Chinese characters. Words composed of single or multiple
|
610 |
Japanese, Korean). Words composed of single or multiple
|
| 610 |
characters should be entered separated by white space in this
|
611 |
characters should be entered separated by white space in this
|
| 611 |
case (they would typically be printed without white
|
612 |
case (they would typically be printed without white
|
| 612 |
space).</para>
|
613 |
space).</para>
|
| 613 |
|
614 |
|
| 614 |
<sect1 id="rcl.search.simple">
|
615 |
<sect1 id="rcl.search.simple">
|
|
... |
|
... |
| 638 |
|
639 |
|
| 639 |
<para><guilabel>File name</guilabel> will specifically look for file
|
640 |
<para><guilabel>File name</guilabel> will specifically look for file
|
| 640 |
names. The entry will be split at white space characters,
|
641 |
names. The entry will be split at white space characters,
|
| 641 |
and each pattern will be separately expanded. If you want
|
642 |
and each pattern will be separately expanded. If you want
|
| 642 |
to search for a pattern including white space, you need
|
643 |
to search for a pattern including white space, you need
|
| 643 |
to use double quotes.</para>
|
644 |
to use double quotes. The point of having a separate file name
|
|
|
645 |
search is that wild card expansion can be performed more
|
|
|
646 |
efficiently on a relatively small subset of the index.</para>
|
| 644 |
|
647 |
|
| 645 |
<para>The fourth entry (<guilabel>Query Language</guilabel>) is
|
648 |
<para>The fourth entry (<guilabel>Query Language</guilabel>) is
|
| 646 |
described in <link linkend="rcl.search.lang">its own
|
649 |
described in <link linkend="rcl.search.lang">its own
|
| 647 |
section</link>.</para>
|
650 |
section</link>.</para>
|
| 648 |
|
651 |
|
|
... |
|
... |
| 659 |
<para>Character case has no influence on search, except that you
|
662 |
<para>Character case has no influence on search, except that you
|
| 660 |
can disable stem expansion for any term by capitalizing it. Ie:
|
663 |
can disable stem expansion for any term by capitalizing it. Ie:
|
| 661 |
a search for <literal>floor</literal> will also normally look for
|
664 |
a search for <literal>floor</literal> will also normally look for
|
| 662 |
<literal>flooring</literal>, <literal>floored</literal>, etc., but
|
665 |
<literal>flooring</literal>, <literal>floored</literal>, etc., but
|
| 663 |
a search for <literal>Floor</literal> will only look for
|
666 |
a search for <literal>Floor</literal> will only look for
|
| 664 |
<literal>floor</literal>, in any character case (stemming can
|
667 |
<literal>floor</literal>, in any character case. Sstemming can
|
| 665 |
also be disabled globally in the preferences). </para>
|
668 |
also be disabled globally in the preferences. </para>
|
| 666 |
|
669 |
|
| 667 |
<para>&RCL; remembers the last few searches that you
|
670 |
<para>&RCL; remembers the last few searches that you
|
| 668 |
performed. You can use the simple search text entry widget (a
|
671 |
performed. You can use the simple search text entry widget (a
|
| 669 |
combobox) to recall them (click on the thing at the right of the
|
672 |
combobox) to recall them (click on the thing at the right of the
|
| 670 |
text field). Please note, however, that only the search texts
|
673 |
text field). Please note, however, that only the search texts
|
|
... |
|
... |
| 685 |
newlines and all. &RCL; will process it and produce a meaningful
|
688 |
newlines and all. &RCL; will process it and produce a meaningful
|
| 686 |
search. This is what most differentiates this mode from the
|
689 |
search. This is what most differentiates this mode from the
|
| 687 |
<guilabel>Query Language</guilabel> mode, where you have to care
|
690 |
<guilabel>Query Language</guilabel> mode, where you have to care
|
| 688 |
about the syntax.</para>
|
691 |
about the syntax.</para>
|
| 689 |
|
692 |
|
| 690 |
<para>You can use the <guilabel>Tools</guilabel> / <guilabel>Advanced
|
693 |
<para>You can use the <link linkend="rcl.search.complex">
|
|
|
694 |
<guilabel>Tools</guilabel> / <guilabel>Advanced search</guilabel>
|
| 691 |
search</guilabel> dialog for more complex searches.</para>
|
695 |
</link> dialog for more complex searches.</para>
|
| 692 |
</sect1>
|
696 |
</sect1>
|
| 693 |
|
697 |
|
| 694 |
<sect1 id="rcl.search.reslist">
|
698 |
<sect1 id="rcl.search.reslist">
|
| 695 |
<title>The result list</title>
|
699 |
<title>The result list</title>
|
| 696 |
|
700 |
|
|
... |
|
... |
| 714 |
preview window by typing
|
718 |
preview window by typing
|
| 715 |
<keycap>Shift</keycap>+<keycap>ArrowUp/Down</keycap> in the
|
719 |
<keycap>Shift</keycap>+<keycap>ArrowUp/Down</keycap> in the
|
| 716 |
window).</para>
|
720 |
window).</para>
|
| 717 |
|
721 |
|
| 718 |
<para>Clicking the <literal>Edit</literal> link will attempt to
|
722 |
<para>Clicking the <literal>Edit</literal> link will attempt to
|
| 719 |
start an external viewer. The viewers can be configured through the
|
723 |
start an external editor. The editors can be configured through
|
| 720 |
user preferences dialog, or by editing the
|
724 |
the user preferences dialog, or by editing the
|
| 721 |
<filename>mimeview</filename> configuration file.</para>
|
725 |
<filename>mimeview</filename> configuration file.</para>
|
| 722 |
|
726 |
|
| 723 |
<para>The <literal>Preview</literal> and <literal>Edit</literal>
|
727 |
<para>The <literal>Preview</literal> and <literal>Edit</literal>
|
| 724 |
edit links may not be present for all entries, meaning that
|
728 |
edit links may not be present for all entries, meaning that
|
| 725 |
&RCL; has no configured way to preview a given file type (which
|
729 |
&RCL; has no configured way to preview a given file type (which
|
| 726 |
was indexed by name only), or no configured external viewer for
|
730 |
was indexed by name only), or no configured external editor for
|
| 727 |
the file type. This can sometimes be adjusted simply by tweaking
|
731 |
the file type. This can sometimes be adjusted simply by tweaking
|
| 728 |
the <link linkend="rclinstall.config.mimemap">
|
732 |
the <link linkend="rclinstall.config.mimemap">
|
| 729 |
<filename>mimemap</filename></link> and
|
733 |
<filename>mimemap</filename></link> and
|
| 730 |
<link linkend="rclinstall.config.mimeview">
|
734 |
<link linkend="rclinstall.config.mimeview">
|
| 731 |
<filename>mimeview</filename></link> configuration files (the latter
|
735 |
<filename>mimeview</filename></link> configuration files (the latter
|
| 732 |
can be modified with the user preferences dialog).</para>
|
736 |
can be modified with the user preferences dialog).</para>
|
| 733 |
|
737 |
|
|
|
738 |
<para>The format of the result list entries is entirely
|
|
|
739 |
configurable by using the preference dialog to
|
|
|
740 |
<link linkend="rcl.search.custom.resultpara">edit an HTML
|
|
|
741 |
fragment</link>.
|
|
|
742 |
|
| 734 |
<para>You can click on the <literal>Query details</literal> link
|
743 |
<para>You can click on the <literal>Query details</literal> link
|
| 735 |
at the top of the results page to see the query actually
|
744 |
at the top of the results page to see the query actually
|
| 736 |
performed, after stem expansion and other processing.</para>
|
745 |
performed, after stem expansion and other processing.</para>
|
| 737 |
|
746 |
|
| 738 |
<para>Double-clicking on any word inside the result list or a
|
747 |
<para>Double-clicking on any word inside the result list or a
|
|
... |
|
... |
| 754 |
<itemizedlist>
|
763 |
<itemizedlist>
|
| 755 |
<listitem><para><guilabel>Preview</guilabel></para></listitem>
|
764 |
<listitem><para><guilabel>Preview</guilabel></para></listitem>
|
| 756 |
<listitem><para><guilabel>Edit</guilabel></para></listitem>
|
765 |
<listitem><para><guilabel>Edit</guilabel></para></listitem>
|
| 757 |
<listitem><para><guilabel>Copy File Name</guilabel></para></listitem>
|
766 |
<listitem><para><guilabel>Copy File Name</guilabel></para></listitem>
|
| 758 |
<listitem><para><guilabel>Copy Url</guilabel></para></listitem>
|
767 |
<listitem><para><guilabel>Copy Url</guilabel></para></listitem>
|
| 759 |
<listitem><para><guilabel>Find similar</guilabel></para></listitem>
|
768 |
<listitem><para><guilabel>Save to File</guilabel></para></listitem>
|
| 760 |
<listitem><para><guilabel>Find similar</guilabel></para></listitem>
|
769 |
<listitem><para><guilabel>Find similar</guilabel></para></listitem>
|
| 761 |
<listitem><para><guilabel>Parent document</guilabel></para></listitem>
|
770 |
<listitem><para><guilabel>Parent document</guilabel></para></listitem>
|
| 762 |
</itemizedlist>
|
771 |
</itemizedlist>
|
| 763 |
|
772 |
|
| 764 |
<para>The <guilabel>Preview</guilabel> and
|
773 |
<para>The <guilabel>Preview</guilabel> and
|
|
... |
|
... |
| 766 |
corresponding links.</para>
|
775 |
corresponding links.</para>
|
| 767 |
|
776 |
|
| 768 |
<para>The <guilabel>Copy File Name</guilabel> and
|
777 |
<para>The <guilabel>Copy File Name</guilabel> and
|
| 769 |
<guilabel>Copy Url</guilabel> copy the relevant data to the
|
778 |
<guilabel>Copy Url</guilabel> copy the relevant data to the
|
| 770 |
clipboard, for later pasting.</para>
|
779 |
clipboard, for later pasting.</para>
|
|
|
780 |
|
|
|
781 |
<para><guilabel>Save to File</guilabel> allows saving the
|
|
|
782 |
contents of a result document to a chosen file. This entry
|
|
|
783 |
will only appear if the document does not correspond to an
|
|
|
784 |
existing file, but is a subdocument inside such a file (ie: an
|
|
|
785 |
email attachment). It is especially useful to extract attachments
|
|
|
786 |
with no associated editor.</para>
|
| 771 |
|
787 |
|
| 772 |
<para>The <guilabel>Find similar</guilabel> entry will select
|
788 |
<para>The <guilabel>Find similar</guilabel> entry will select
|
| 773 |
a number of relevant term from the current document and enter
|
789 |
a number of relevant term from the current document and enter
|
| 774 |
them into the simple search field. You can then start a simple
|
790 |
them into the simple search field. You can then start a simple
|
| 775 |
search, with a good chance of finding documents related to the
|
791 |
search, with a good chance of finding documents related to the
|
|
... |
|
... |
| 830 |
|
846 |
|
| 831 |
<para>If you have a search string entered and you use ^Up/^Down
|
847 |
<para>If you have a search string entered and you use ^Up/^Down
|
| 832 |
to browse the results, the search is initiated for each successive
|
848 |
to browse the results, the search is initiated for each successive
|
| 833 |
document. If the string is found, the cursor will be positioned
|
849 |
document. If the string is found, the cursor will be positioned
|
| 834 |
at the first occurrence of the search string.</para>
|
850 |
at the first occurrence of the search string.</para>
|
|
|
851 |
|
|
|
852 |
<para>A right-click menu in the text area allows switching
|
|
|
853 |
between displaying the main text or the contents of fields
|
|
|
854 |
associated to the document (ie: author, abtract, etc.). This is
|
|
|
855 |
especially useful in cases where the term match did not occur in
|
|
|
856 |
the main text but in one of the fields.</para>
|
| 835 |
|
857 |
|
| 836 |
</sect1>
|
858 |
</sect1>
|
| 837 |
|
859 |
|
| 838 |
<sect1 id="rcl.search.lang">
|
860 |
<sect1 id="rcl.search.lang">
|
| 839 |
<title>The query language</title>
|
861 |
<title>The query language</title>
|
|
... |
|
... |
| 1485 |
you may want to customize the font and/or font size. The rest
|
1507 |
you may want to customize the font and/or font size. The rest
|
| 1486 |
of the fonts used by &RCL; are determined by your generic QT
|
1508 |
of the fonts used by &RCL; are determined by your generic QT
|
| 1487 |
config (try the <command>qtconfig</command> command).</para>
|
1509 |
config (try the <command>qtconfig</command> command).</para>
|
| 1488 |
</listitem>
|
1510 |
</listitem>
|
| 1489 |
|
1511 |
|
| 1490 |
<listitem><para><guilabel>Result paragraph format
|
1512 |
<listitem><anchor id="rcl.search.custom.resultpara"> <para>
|
|
|
1513 |
<guilabel>Result paragraph format string</guilabel>:
|
| 1491 |
string</guilabel>: allows you to change the presentation of
|
1514 |
allows you to change the presentation of
|
| 1492 |
each result list entry. This is a qt-html string where the
|
1515 |
each result list entry. This is a qt-html string where the
|
| 1493 |
following printf-like <literal>%</literal> substitutions will
|
1516 |
following printf-like <literal>%</literal> substitutions will
|
| 1494 |
be performed:
|
1517 |
be performed:
|
| 1495 |
<itemizedlist>
|
1518 |
<itemizedlist>
|
| 1496 |
<listitem>
|
1519 |
<listitem>
|