tris/recoll
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc

Browse Source
This commit is contained in:
Jean-Francois Dockes 2020-03-01 16:08:15 +01:00
parent fe86fa9e1f
commit c110b94738
2 changed files with 63 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
src/doc/user/usermanual.html
View File

@ -2131,19 +2131,32 @@ metadatacmds = ; <em class=
extensive facilities for storing metadata along with the
document, and these facilities are actually used in the
real world.</p>
<p>In consequence, the <code class=
"filename">rclpdf.py</code> PDF input handler has more
complex capabilities than most others, and it is also more
configurable. Specifically, <code class=
"filename">rclpdf.py</code> can automatically use
<span class="application">tesseract</span> to perform OCR
if the document text is empty, it can be configured to
extract specific metadata tags from an XMP packet, and to
extract PDF attachments.</p>
<p>The PDF handler can execute an external program to run
OCR if no text is found in the document. This is now
described in a <a class="link" href="#RCL.INDEXING.OCR"
title="2.9.&nbsp;Recoll and OCR">separate section</a>.</p>
<p>In consequence, the <span class=
"command"><strong>rclpdf.py</strong></span> PDF input
handler has more complex capabilities than most others, and
it is also more configurable. Specifically, <span class=
"command"><strong>rclpdf.py</strong></span> has the
following features:</p>
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc;">
<li class="listitem">
<p>It can be configured to extract specific metadata
tags from an XMP packet.</p>
</li>
<li class="listitem">
<p>It can extract PDF attachments.</p>
</li>
<li class="listitem">
<p>It can automatically perform OCR if the document
text is empty. This is done by executing an external
program and is now described in a <a class="link"
href="#RCL.INDEXING.OCR" title=
"2.9.&nbsp;Recoll and OCR">separate section</a>,
because the OCR framework can also be used with
non-PDF image files.</p>
</li>
</ul>
</div>
<div class="sect2">
<div class="titlepage">
<div>
@ -2270,8 +2283,14 @@ metadatacmds = ; <em class=
</li>
</ul>
</div>
<p>Configuration. See the <a class="link" href=
"#RCL.INSTALL.CONFIG.RECOLLCONF.OCR" title=
<p>To enable this feature, you need to install one of the
supported OCR applications (<span class=
"application">tesseract</span> or <span class=
"application">ABBYY</span>), enable OCR in the PDF handler,
and tell <span class="application">Recoll</span> where the
appropriate command resides. The last parts are done by
setting configuration variables. See the <a class="link"
href="#RCL.INSTALL.CONFIG.RECOLLCONF.OCR" title=
"Parameters for OCR processing">relevant section</a>. All
parameters can be localized in subdirectories through the
usual main configuration mechanism (path sections).</p>

34
src/doc/user/usermanual.xml
View File

@ -1406,17 +1406,23 @@ metadatacmds = ; <replaceable>tags</replaceable> = tmsu tags %f
facilities for storing metadata along with the document, and these
facilities are actually used in the real world.</para>
<para>In consequence, the <filename>rclpdf.py</filename> PDF input
<para>In consequence, the <command>rclpdf.py</command> PDF input
handler has more complex capabilities than most others, and it is
also more configurable. Specifically, <filename>rclpdf.py</filename>
can automatically use <application>tesseract</application> to perform
OCR if the document text is empty, it can be configured to extract
specific metadata tags from an XMP packet, and to extract PDF
attachments.</para>
<para>The PDF handler can execute an external program to run OCR if
no text is found in the document. This is now described in a
<link linkend="RCL.INDEXING.OCR">separate section</link>.</para>
also more configurable. Specifically, <command>rclpdf.py</command>
has the following features:
<itemizedlist>
<listitem><para>It can be configured to extract
specific metadata tags from an XMP packet.</para></listitem>
<listitem><para>It can extract PDF
attachments.</para></listitem>
<listitem><para>It can automatically perform
OCR if the document text is empty. This is done by
executing an external program and is now described in a
<link linkend="RCL.INDEXING.OCR">separate
section</link>, because the OCR framework can also be used
with non-PDF image files.</para></listitem>
</itemizedlist>
</para>
<sect2 id="RCL.INDEXING.PDF.XMP">
<title>XMP fields extraction</title>
@ -1489,6 +1495,7 @@ metadatacmds = ; <replaceable>tags</replaceable> = tmsu tags %f
</sect1>
<sect1 id="RCL.INDEXING.OCR">
<title>Recoll and OCR</title>
@ -1521,7 +1528,12 @@ metadatacmds = ; <replaceable>tags</replaceable> = tmsu tags %f
</itemizedlist>
</para>
<para>Configuration. See the
<para>To enable this feature, you need to install one of
the supported OCR applications
(<application>tesseract</application>
or <application>ABBYY</application>), enable OCR in the PDF
handler, and tell &RCL; where the appropriate command resides. The
last parts are done by setting configuration variables. See the
<link linkend="RCL.INSTALL.CONFIG.RECOLLCONF.OCR">
relevant section</link>. All parameters can be localized in
subdirectories through the usual main configuration mechanism (path