|
a/src/doc/user/usermanual.xml |
|
b/src/doc/user/usermanual.xml |
|
... |
|
... |
| 963 |
</sect2>
|
963 |
</sect2>
|
| 964 |
|
964 |
|
| 965 |
</sect1>
|
965 |
</sect1>
|
| 966 |
|
966 |
|
| 967 |
<sect1 id="RCL.INDEXING.WEBQUEUE">
|
967 |
<sect1 id="RCL.INDEXING.WEBQUEUE">
|
| 968 |
<title>Indexing WEB pages you wisit</title>
|
968 |
<title>Indexing the WEB pages which you wisit.</title>
|
| 969 |
|
969 |
|
| 970 |
<para>With the help of a <application>Firefox</application>
|
970 |
<para>With the help of a <application>Firefox</application>
|
| 971 |
extension, &RCL; can index the Internet pages that you visit. The
|
971 |
extension, &RCL; can index the Internet pages that you visit. The
|
| 972 |
extension was initially designed for the
|
972 |
extension has a long history: it was initially designed for the
|
| 973 |
<application>Beagle</application> indexer, but it has recently be
|
973 |
<application>Beagle</application> indexer, then adapted to &RCL; and
|
| 974 |
renamed and better adapted to &RCL;.</para>
|
974 |
the <application>Firefox</application> <application>XUL</application>
|
|
|
975 |
API. A new version of the addon has been written to work with the
|
|
|
976 |
<application>WebExtensions</application> API, which is the only one
|
|
|
977 |
supported after <application>Firefox</application> version 57.</para>
|
| 975 |
|
978 |
|
| 976 |
<para>The extension works by copying visited WEB pages to an indexing
|
979 |
<para>The extension works by copying visited WEB pages to an indexing
|
| 977 |
queue directory, which &RCL; then processes, indexing the data,
|
980 |
queue directory, which &RCL; then processes, indexing the data,
|
| 978 |
storing it into a local cache, then removing the file from the
|
981 |
storing it into a local cache, then removing the file from the
|
| 979 |
queue.</para>
|
982 |
queue.</para>
|
| 980 |
|
983 |
|
|
|
984 |
<para>Because the WebExtensions API introduces more constraints to
|
|
|
985 |
what extensions can do, the new version works with one
|
|
|
986 |
more step: the files are first created in the browser default
|
|
|
987 |
downloads location (typically <filename>$HOME/Downloads</filename> ),
|
|
|
988 |
then moved by a script in the old queue location. The script is
|
|
|
989 |
automatically executed by the &RCL; indexer versions 1.23.5 and
|
|
|
990 |
newer. It could conceivably be executed independantly to make the new
|
|
|
991 |
browser extension compatible with an older &RCL; version (the script
|
|
|
992 |
is named <command>recoll-we-move-files.py</command>).</para>
|
|
|
993 |
|
|
|
994 |
<note><para>For the WebExtensions-based version to work, it is
|
|
|
995 |
necessary to set the <literal>webdownloadsdir</literal> value in the
|
|
|
996 |
configuration if it was changed from the default
|
|
|
997 |
<filename>$HOME/Downloads</filename> in the browser
|
|
|
998 |
preferences.</para></note>
|
|
|
999 |
|
| 981 |
<para>This feature can be enabled in the GUI
|
1000 |
<para>The visited WEB pages indexing feature can be enabled in the
|
| 982 |
<guilabel>Index configuration</guilabel>
|
1001 |
GUI <guilabel>Index configuration</guilabel> panel, or by editing the
|
| 983 |
panel, or by editing the configuration file (set
|
1002 |
configuration file (set <varname>processwebqueue</varname> to
|
| 984 |
<varname>processwebqueue</varname> to 1).</para>
|
1003 |
1).</para>
|
| 985 |
|
1004 |
|
| 986 |
<para>A current pointer to the extension can be found, along with
|
1005 |
<para>A current pointer to the extension can be found, along with
|
| 987 |
up-to-date instructions, on the
|
1006 |
up-to-date instructions, on the
|
| 988 |
<ulink url="&FAQS;IndexWebHistory">Recoll wiki</ulink>.</para>
|
1007 |
<ulink url="&FAQS;IndexWebHistory">Recoll wiki</ulink>.</para>
|
| 989 |
|
1008 |
|
| 990 |
<para>A copy of the indexed WEB pages is retained by Recoll in a
|
1009 |
<para>A copy of the indexed WEB pages is retained by Recoll in a
|
| 991 |
local cache (from which previews can be fetched). The cache size can
|
1010 |
local cache (from which previews can be fetched). The cache size can
|
| 992 |
be adjusted from the <guilabel>Index configuration</guilabel> /
|
1011 |
be adjusted from the <guilabel>Index configuration</guilabel> /
|
| 993 |
<guilabel>Web history</guilabel> panel. Once the maximum size
|
1012 |
<guilabel>Web history</guilabel> panel. Once the maximum size
|
|
... |
|
... |
| 1018 |
<listitem><para>If set, this overrides any other
|
1037 |
<listitem><para>If set, this overrides any other
|
| 1019 |
determination of the file MIME type.</para></listitem>
|
1038 |
determination of the file MIME type.</para></listitem>
|
| 1020 |
</varlistentry>
|
1039 |
</varlistentry>
|
| 1021 |
<varlistentry>
|
1040 |
<varlistentry>
|
| 1022 |
<term>charset</term>
|
1041 |
<term>charset</term>
|
| 1023 |
<listitem>If set, this defines the file character set
|
1042 |
<listitem><para>If set, this defines the file character set
|
| 1024 |
(mostly useful for plain text files).</listitem>
|
1043 |
(mostly useful for plain text files).</para></listitem>
|
| 1025 |
</varlistentry>
|
1044 |
</varlistentry>
|
| 1026 |
</variablelist>
|
1045 |
</variablelist>
|
| 1027 |
</para>
|
1046 |
</para>
|
| 1028 |
|
1047 |
|
| 1029 |
<para>By default, other attributes are handled as &RCL; fields.
|
1048 |
<para>By default, other attributes are handled as &RCL; fields.
|