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 2019-04-12 08:51:03 +02:00
parent 3927b4f73f
commit ad89225b24
2 changed files with 92 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -6971,8 +6971,51 @@ recollindex -c "$confdir"
as Unicode or strings. Outputs are Unicode objects.
All dates are specified as Unix timestamps, printed
as strings. Please refer to the <code class=
"filename">rcldb/rcldoc.h</code> C++ file for a
description of the predefined attributes.</p>
"filename">rcldb/rcldoc.cpp</code> C++ file for a
full description of the predefined attributes. Here
follows a short list.</p>
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
<li class="listitem">
<p><code class="literal">url</code> the
document URL but see also <code class=
"literal">getbinurl()</code></p>
</li>
<li class="listitem">
<p><code class="literal">ipath</code> the
document <code class="literal">ipath</code>
for embedded documents.</p>
</li>
<li class="listitem">
<p><code class="literal">fbytes,
dbytes</code> the document file and text
sizes.</p>
</li>
<li class="listitem">
<p><code class="literal">fmtime,
dmtime</code> the document file and document
times.</p>
</li>
<li class="listitem">
<p><code class="literal">xdocid</code> the
document Xapian document ID. This is useful
if you want to access the document through a
direct Xapian operation.</p>
</li>
<li class="listitem">
<p><code class="literal">mtype</code> the
document MIME type.</p>
</li>
<li class="listitem">
<p>Fields stored by default: <code class=
"literal">author</code>, <code class=
"literal">filename</code>, <code class=
"literal">keywords</code>, <code class=
"literal">recipient</code></p>
</li>
</ul>
</div>
<p>At query time, only the fields that are defined
as <code class="literal">stored</code> either by
default or in the <code class=
@ -6987,17 +7030,18 @@ recollindex -c "$confdir"
<dt><span class="term">get(key), []
operator</span></dt>
<dd>
<p>Retrieve the named doc attribute. You can
also use <code class="literal">getattr(doc,
key)</code> or <code class=
"literal">doc.key</code>.</p>
<p>Retrieve the named document attribute. You
can also use <code class=
"literal">getattr(doc, key)</code> or
<code class="literal">doc.key</code>.</p>
</dd>
<dt><span class="term">doc.key =
value</span></dt>
<dd>
<p>Set the the named doc attribute. You can
also use <code class="literal">setattr(doc,
key, value)</code>.</p>
<p>Set the the named document attribute. You
can also use <code class=
"literal">setattr(doc, key,
value)</code>.</p>
</dd>
<dt><span class="term">getbinurl()</span></dt>
<dd>

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

@ -5372,9 +5372,39 @@ recollindex -c "$confdir"
configuration. Inputs can be specified as Unicode or
strings. Outputs are Unicode objects. All dates are
specified as Unix timestamps, printed as strings. Please
refer to the <filename>rcldb/rcldoc.h</filename> C++ file
for a description of the predefined attributes.</para>
refer to the <filename>rcldb/rcldoc.cpp</filename> C++ file
for a full description of the predefined attributes. Here
follows a short list.</para>
<para><itemizedlist>
<listitem><para><literal>url</literal> the document URL but
see also <literal>getbinurl()</literal></para></listitem>
<listitem><para><literal>ipath</literal> the document
<literal>ipath</literal> for embedded
documents.</para></listitem>
<listitem><para><literal>fbytes, dbytes</literal> the document
file and text sizes.</para></listitem>
<listitem><para><literal>fmtime, dmtime</literal> the document
file and document times.</para></listitem>
<listitem><para><literal>xdocid</literal> the document
Xapian document ID. This is useful if you want to access
the document through a direct Xapian
operation.</para></listitem>
<listitem><para><literal>mtype</literal> the document
MIME type.</para></listitem>
<listitem><para>Fields stored by default:
<literal>author</literal>, <literal>filename</literal>,
<literal>keywords</literal>,
<literal>recipient</literal></para></listitem>
</itemizedlist>
</para>
<para>At query time, only the fields that are defined
as <literal>stored</literal> either by default or in
the <filename>fields</filename> configuration file will be
@ -5388,18 +5418,18 @@ recollindex -c "$confdir"
<varlistentry>
<term>get(key), [] operator</term>
<listitem><para>Retrieve the named doc
attribute. You can also use
<literal>getattr(doc, key)</literal> or
<literal>doc.key</literal>.</para></listitem>
<listitem><para>Retrieve the named document
attribute. You can also use <literal>getattr(doc,
key)</literal> or
<literal>doc.key</literal>.</para></listitem>
</varlistentry>
<varlistentry>
<term>doc.key = value</term>
<listitem><para>Set the the named doc
attribute. You can also use
<literal>setattr(doc, key, value)</literal>.</para></listitem>
<listitem><para>Set the the named document attribute. You
can also use <literal>setattr(doc, key,
value)</literal>.</para></listitem>
</varlistentry>
<varlistentry>