diff --git a/src/doc/user/usermanual.html b/src/doc/user/usermanual.html index 7e5bd4c2..7b6de588 100644 --- a/src/doc/user/usermanual.html +++ b/src/doc/user/usermanual.html @@ -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 rcldb/rcldoc.h C++ file for a - description of the predefined attributes.

+ "filename">rcldb/rcldoc.cpp C++ file for a + full description of the predefined attributes. Here + follows a short list.

+
+ +

At query time, only the fields that are defined as stored either by default or in the get(key), [] operator

-

Retrieve the named doc attribute. You can - also use getattr(doc, - key) or doc.key.

+

Retrieve the named document attribute. You + can also use getattr(doc, key) or + doc.key.

doc.key = value
-

Set the the named doc attribute. You can - also use setattr(doc, - key, value).

+

Set the the named document attribute. You + can also use setattr(doc, key, + value).

getbinurl()
diff --git a/src/doc/user/usermanual.xml b/src/doc/user/usermanual.xml index e82442ec..a10bcbaa 100644 --- a/src/doc/user/usermanual.xml +++ b/src/doc/user/usermanual.xml @@ -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 rcldb/rcldoc.h C++ file - for a description of the predefined attributes. + refer to the rcldb/rcldoc.cpp C++ file + for a full description of the predefined attributes. Here + follows a short list. + + url the document URL but + see also getbinurl() + + ipath the document + ipath for embedded + documents. + + fbytes, dbytes the document + file and text sizes. + fmtime, dmtime the document + file and document times. + + xdocid the document + Xapian document ID. This is useful if you want to access + the document through a direct Xapian + operation. + + mtype the document + MIME type. + + Fields stored by default: + author, filename, + keywords, + recipient + + + + At query time, only the fields that are defined as stored either by default or in the fields configuration file will be @@ -5388,18 +5418,18 @@ recollindex -c "$confdir" get(key), [] operator - Retrieve the named doc - attribute. You can also use - getattr(doc, key) or - doc.key. + Retrieve the named document + attribute. You can also use getattr(doc, + key) or + doc.key. doc.key = value - Set the the named doc - attribute. You can also use - setattr(doc, key, value). + Set the the named document attribute. You + can also use setattr(doc, key, + value).