X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Fzoom.xml;h=29f95147462815dcf1320b4b8b4ab0b64b80412e;hp=4c697ae4f8c85b0582c18a3eb97f3ca4c776f45e;hb=21f7c16c6b1b694405dbc1760d3d6cb3caac38f6;hpb=afbca314053ad3d8aaf5e83d27d54b48bf10bfa9 diff --git a/doc/zoom.xml b/doc/zoom.xml index 4c697ae..29f9514 100644 --- a/doc/zoom.xml +++ b/doc/zoom.xml @@ -17,8 +17,10 @@ ZOOM_options_setl(opt, name, value, len) ZOOM_options_get_bool(opt, name, defa) ZOOM_options_get_int(opt, name, defa) ZOOM_options_set_int(opt, name, value) +ZOOM_connection_scan1 (ZOOM_connection c, ZOOM_query startterm) +ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) --> - + ZOOM &zoom; is an acronym for 'Z39.50 Object-Orientation Model' and is @@ -30,8 +32,8 @@ ZOOM_options_set_int(opt, name, value) - A recent addition to &yaz; is SRW support. You can now make - SRW ZOOM connections by specifying scheme http:// + A recent addition to &yaz; is SRU support. You can now make + SRU ZOOM connections by specifying scheme http:// for the hostname for a connection. @@ -47,7 +49,7 @@ ZOOM_options_set_int(opt, name, value) There are other language bindings available for &yaz;, and still more are in active development. See the - ZOOM web-site for + ZOOM web-site for more information. @@ -106,7 +108,7 @@ ZOOM_options_set_int(opt, name, value) You can prefix the host with a scheme followed by colon. The default scheme is tcp (Z39.50 protocol). - The scheme http selects SRW over HTTP. + The scheme http selects SRU over HTTP. You can prefix the scheme-qualified host-string with one or more @@ -256,7 +258,7 @@ ZOOM_options_set_int(opt, name, value) If either option lang or charset is set, then - + Character Set and Language Negotiation is in effect. @@ -314,14 +316,14 @@ ZOOM_options_set_int(opt, name, value) API cannot tell the outcome (yet). - SRW Protocol behavior + SRU Protocol behavior - The SRW protocol doesn't feature an Inititialize Request, so + The SRU protocol doesn't feature an Inititialize Request, so the connection phase merely establishes a TCP/IP connection with the SOAP service. Most of the ZOOM connection options do not - affect SRW and they are ignored. However, future versions + affect SRU and they are ignored. However, future versions of &yaz; might honor implementationName and put that as part of User-Agent header for HTTP requests. @@ -574,22 +576,22 @@ ZOOM_options_set_int(opt, name, value) - SRW Protocol behavior + SRU Protocol behavior Current version of &yaz; does not take advantage of a result set id - returned by the SRW server. Future versions might do, however. + returned by the SRU server. Future versions might do, however. Since, the ZOOM driver does not save result set IDs any - present (retrieval) is transformed to a SRW SearchRetrieveRequest + present (retrieval) is transformed to a SRU SearchRetrieveRequest with same query but, possibly, different offsets. - Option schema specifies SRW schema + Option schema specifies SRU schema for retrieval. However, options elementSetName and preferredRecordSyntax are ignored. Options start and count - are supported by SRW. + are supported by SRU. The remaining options piggyback, smallSetUpperBound, @@ -600,18 +602,18 @@ ZOOM_options_set_int(opt, name, value) unsupported. - SRW supports CQL queries, not PQF. + SRU supports CQL queries, not PQF. If PQF is used, however, the PQF query is transferred anyway using non-standard element pQuery in - SRW SearchRetrieveRequest. + SRU SearchRetrieveRequest. - Unfortunately, SRW does not define a database setting. Hence, + Unfortunately, SRU does not define a database setting. Hence, databaseName is unsupported and ignored. However, the path part in host parameter for functions ZOOM_connecton_new and ZOOM_connection_connect acts as a - database (at least for the &yaz; SRW server). + database (at least for the &yaz; SRU server). @@ -727,9 +729,9 @@ ZOOM_options_set_int(opt, name, value) xml The record is returned in XML if possible. - SRW/SRU and Z39.50 records with transfer syntax XML are + SRU and Z39.50 records with transfer syntax XML are returned verbatim. MARC records are returned in - + MARCXML (converted from ISO2709 to MARCXML by YAZ). @@ -747,13 +749,9 @@ ZOOM_options_set_int(opt, name, value) Most - - MARC21 - + MARC21 records uses the - - MARC-8 - + MARC-8 character set encoding. An application that wishes to display in Latin-1 would use @@ -779,9 +777,9 @@ ZOOM_options_set_int(opt, name, value) now. - SRW Protocol behavior + SRU Protocol behavior - The ZOOM driver for SRW treats records returned by a SRW server + The ZOOM driver for SRU treats records returned by a SRU server as if they where Z39.50 records with transfer syntax XML and no element set name or database name.