X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fzoom.xml;h=041949af39b35b20b4b66414a97a4785e65ae217;hb=399eedc05492646adc53a92193652aeae44deb1d;hp=ac9eadb45350089317b2270e8f3f60a3035f2b04;hpb=19411dcc2419807b0b81e7ad05f63880eba58d22;p=yaz-moved-to-github.git

diff --git a/doc/zoom.xml b/doc/zoom.xml
index ac9eadb..041949a 100644
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -726,7 +726,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
     The <parameter>type</parameter> is a string of the format:
    </para>
    <para>
-    <replaceable>form</replaceable>[; charset=<replaceable>from</replaceable>[,<replaceable>to</replaceable>]]
+    <replaceable>form</replaceable>[;charset=<replaceable>from</replaceable>[,<replaceable>to</replaceable>]][;format=<replaceable>v</replaceable>]
    </para>
    <para>
     where <replaceable>form</replaceable> specifies the format of the
@@ -739,6 +739,12 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
     If <replaceable>to</replaceable> is omitted UTF-8 is assumed.
    </para>
    <para>
+    The format argument controls whether record data should be XML
+    pretty-printed (post process operation).
+    It is enabled only if format value <replaceable>v</replaceable> is 
+    <literal>1</literal> and the record content is XML well-formed.
+   </para>
+   <para>
     In addition, for certain types, the length
     <literal>len</literal> passed will be set to the size in bytes of
     the returned information. 
@@ -792,14 +798,18 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
 	 MARCXML
 	 </ulink> 
 	(converted from ISO2709 to MARCXML by YAZ).
-	GRS-1 and OPAC records are not supported for this form.
+	OPAC records are also converted to XML and the 
+	bibliographic record is converted to MARCXML (when possible).
+	GRS-1 records are not supported for this form.
         Upon completion, the XML buffer is returned
 	(type <literal>const char *</literal>) and length is stored in
         <literal>*len</literal>.
        </para></listitem>
      </varlistentry>
      <varlistentry><term><literal>opac</literal></term>
-      <listitem><para>OPAC for record is returned in XML.
+      <listitem><para>OPAC information for record is returned in XML
+	if an OPAC record is present at the position given. If no
+	OPAC record is present, a NULL pointer is returned.
        </para></listitem>
      </varlistentry>
     </variablelist>
@@ -865,11 +875,11 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
 
     size_t ZOOM_scanset_size(ZOOM_scanset scan);
 
-    const char * ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
-                                   int *occ, size_t *len);
+    const char *ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
+                                  size_t *occ, size_t *len);
 
-    const char * ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
-                                           int *occ, size_t *len);
+    const char *ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
+                                          size_t *occ, size_t *len);
 
     void ZOOM_scanset_destroy(ZOOM_scanset scan);