From 21f7c16c6b1b694405dbc1760d3d6cb3caac38f6 Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Tue, 13 Jun 2006 16:01:51 +0000 Subject: [PATCH] Mention SRU rather than SRW (where appropriate). --- doc/client.xml | 10 +++++----- doc/frontend.xml | 32 +++++++++++++++----------------- doc/introduction.xml | 26 +++++++++++++------------- doc/soap.xml | 16 ++++++++-------- doc/tools.xml | 18 +++++++++--------- doc/yaz-client-commands.xml | 6 +++--- doc/yaz-client-man.xml | 10 +++++----- doc/yaz-man.xml | 4 ++-- doc/zoom.xml | 38 +++++++++++++++++++------------------- 9 files changed, 79 insertions(+), 81 deletions(-) diff --git a/doc/client.xml b/doc/client.xml index 06f7507..d874fe1 100644 --- a/doc/client.xml +++ b/doc/client.xml @@ -1,8 +1,8 @@ - + The YAZ client Introduction - yaz-client is a line-mode Z39.50/SRW client. It supports a fair amount + yaz-client is a line-mode Z39.50/SRU client. It supports a fair amount of the functionality of the Z39.50v3 standard. Its primary purpose is to exercise the package, and verify that the protocol works OK. @@ -31,8 +31,8 @@ in a UNIX shell / WIN32 console. The zurl, - specifies a Z39.50/SRW host and, if specified, the client first tries to - establish connection with the Z39.50/SRW target. + specifies a Z39.50/SRU host and, if specified, the client first tries to + establish connection with the Z39.50/SRU target. Options are prefixed by - followed by a @@ -130,7 +130,7 @@ - The same server is also a SOAP SRW service. Connect to it via HTTP + The same server is also a SRU service. Connect to it via HTTP as follows: yaz-client http://bagel.indexdata.dk:210/marc diff --git a/doc/frontend.xml b/doc/frontend.xml index 985f4bd..2350af3 100644 --- a/doc/frontend.xml +++ b/doc/frontend.xml @@ -1,4 +1,4 @@ - + Generic server Introduction @@ -13,7 +13,7 @@ If you have a database system that you would like to make available by - means of Z39.50, SRW o SRU, &yaz; basically offers your two options. You + means of Z39.50 or SRU, &yaz; basically offers your two options. You can use the APIs provided by the &asn;, &odr;, and &comstack; modules to create and decode PDUs, and exchange them with a client. @@ -100,7 +100,7 @@ - Return Explain for SRW/SRU (optional). + Return Explain for SRU (optional). @@ -336,8 +336,8 @@ bend_initresult (*bend_init)(bend_initrequest *r); - This handler is also called when operating in SRW/SRU mode - when - a connection has been made (even though SRW/SRU does not offer + This handler is also called when operating in SRU mode - when + a connection has been made (even though SRU does not offer this service). @@ -503,8 +503,8 @@ typedef struct { The bend_search handler is also called when - the frontend server receives a SRW/SRU SearchRetrieveRequest. - For SRW/SRU, a CQL query is usually provided by the client. + the frontend server receives a SRU SearchRetrieveRequest. + For SRU, a CQL query is usually provided by the client. The CQL query is available as part of Z_Query structure (note that CQL is now part of Z39.50 via an external). To support CQL in existing implementations that only do Type-1, @@ -515,8 +515,8 @@ typedef struct { To maintain backwards compatibility, the frontend server of yaz always assume that error codes are BIB-1 diagnostics. - For SRW/SRU operation, a Bib-1 diagnostic code is mapped to - SRW/SRU diagnostic. + For SRU operation, a Bib-1 diagnostic code is mapped to + SRU diagnostic. @@ -548,7 +548,7 @@ typedef struct bend_fetch_rr { The frontend server calls the bend_fetch handler when it needs database records to fulfill a Z39.50 Search Request, a - Z39.50 Present Request or a SRW SearchRetrieveRequest. + Z39.50 Present Request or a SRU SearchRetrieveRequest. The setname is simply the name of the result set that holds the reference to the desired record. The number is the offset into the set (with 1 @@ -566,11 +566,11 @@ typedef struct bend_fetch_rr { - If a SRW/SRU SearchRetrieveRequest is received by the frontend server, + If a SRU SearchRetrieveRequest is received by the frontend server, the referenceId is NULL and the request_format (transfer syntax) is XML (OID name VAL_TEXT_XML). - The schema for SRW/SRU is stored in both the + The schema for SRU is stored in both the Z_RecordComposition structure and schema (simple string). @@ -727,8 +727,7 @@ typedef struct bend_scan_rr { This backend server handles both Z39.50 scan - and SRW/SRU scan. In order for a - handler to distinguish between SRW/SRU (CQL) scan + and SRU scan. In order for a handler to distinguish between SRU (CQL) scan Z39.50 Scan , it must check for a non-NULL value of scanClause. @@ -797,11 +796,10 @@ typedef struct bend_scan_rr { - The server will accept Z39.50 requests and offer SRW/SRU service - on port 210. + The server will accept Z39.50 requests and offer SRU service on port 210. - Setting up Apache as SRW/SRU Frontend + Setting up Apache as SRU Frontend If you use Apache as your public web server and want to offer HTTP port 80 diff --git a/doc/introduction.xml b/doc/introduction.xml index fedf22a..32b4810 100644 --- a/doc/introduction.xml +++ b/doc/introduction.xml @@ -1,9 +1,9 @@ - + Introduction &yaz; is a C/C++ library for information retrieval applications - using the Z39.50/SRW/SRU protocols for information retrieval. + using the Z39.50/SRU protocols for information retrieval. @@ -16,7 +16,7 @@ Supports - SRW/SRU + SRU GET/POST/SOAP version 1.1 (over HTTP and HTTPS). @@ -39,7 +39,7 @@ Offers ZOOM C API implementing both - Z39.50 and SRW. + Z39.50 and SRU. The &yaz; library offers a set of useful utilities @@ -82,16 +82,16 @@ describes the ZOOM API of &yaz;. - This is definitely worth a read if you wish to develop a Z39.50/SRW - client. - + This is definitely worth a read if you wish to develop a Z39.50/SRU + client. + describes the generic frontend server - and explains how to develop server Z39.50/SRW applications for &yaz;. - Obviously worth reading if you're to develop a server. + and explains how to develop server Z39.50/SRU applications for &yaz;. + Obviously worth reading if you're to develop a server. @@ -114,8 +114,8 @@ - describes how SRW and SOAP is used - in &yaz;. Only if you're developing SOAP/SRW applications + describes how SRU and SOAP is used + in &yaz;. Only if you're developing SRU applications this section is a must. @@ -124,7 +124,7 @@ contains sections for the various tools offered by &yaz;. Scan through the material quickly - and see what's relevant to you! SRW/SRU implementors + and see what's relevant to you! SRU implementors might find the CQL section particularly useful. @@ -204,7 +204,7 @@ The second layer provides a C represenation of the protocol units (packages) for Z39.50 ASN.1, ILL ASN.1, - SRW SOAP. + SRU. diff --git a/doc/soap.xml b/doc/soap.xml index a2de285..ce26f63 100644 --- a/doc/soap.xml +++ b/doc/soap.xml @@ -1,16 +1,16 @@ - -SOAP and SRW + +SOAP and SRU Introduction &yaz; uses a very simple implementation of SOAP that only, - currenly, supports what is sufficient to offer SRW functionality. + currenly, supports what is sufficient to offer SRU SOAP functionality. The implementation uses the tree API of libxml2 to encode and decode SOAP packages. - Like the Z39.50 ASN.1 module, the &yaz; SRW implementation uses + Like the Z39.50 ASN.1 module, the &yaz; SRU implementation uses simple C structs to represent SOAP packages as well as HTTP packages. @@ -104,7 +104,7 @@ int z_soap_codec(ODR o, Z_SOAP **pp, The handlers is a list of SOAP codec - handlers - one handler for each service namespace. For SRW, the + handlers - one handler for each service namespace. For SRU SOAP, the namespace would be http://www.loc.gov/zing/srw/v1.0/. @@ -155,11 +155,11 @@ int handler(ODR o, void * ptr, void **handler_data, Finally, ns the service namespace. - SRW + SRU - SRW is just one implementation of a SOAP handler as described + SRU SOAP is just one implementation of a SOAP handler as described in the previous section. - The encoder/decoder handler for SRW is defined as + The encoder/decoder handler for SRU is defined as follows: #include <yaz/srw.h> diff --git a/doc/tools.xml b/doc/tools.xml index 1d79005..d47683f 100644 --- a/doc/tools.xml +++ b/doc/tools.xml @@ -1,4 +1,4 @@ - + Supporting Tools @@ -940,11 +940,11 @@ struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset, const char *str, CQL - Common Query Language - was defined for the - SRW protocol. + SRU protocol. In many ways CQL has a similar syntax to CCL. The objective of CQL is different. Where CCL aims to be an end-user language, CQL is the protocol - query language for SRW. + query language for SRU. @@ -969,7 +969,7 @@ struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset, const char *str, The parser converts a valid CQL query to PQF, thus providing a - way to use CQL for both SRW/SRU servers and Z39.50 targets at the + way to use CQL for both SRU servers and Z39.50 targets at the same time. @@ -978,7 +978,7 @@ struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset, const char *str, The parser converts CQL to XCQL. XCQL is an XML representation of CQL. - XCQL is part of the SRW specification. However, since SRU + XCQL is part of the SRU specification. However, since SRU supports CQL only, we don't expect XCQL to be widely used. Furthermore, CQL has the advantage over XCQL that it is easy to read. @@ -1141,7 +1141,7 @@ struct cql_node { Conversion to PQF (and Z39.50 RPN) is tricky by the fact that the resulting RPN depends on the Z39.50 target capabilities (combinations of supported attributes). - In addition, the CQL and SRW operates on index prefixes + In addition, the CQL and SRU operates on index prefixes (URI or strings), whereas the RPN uses Object Identifiers for attribute sets. @@ -1176,9 +1176,9 @@ int cql_transform_buf(cql_transform_t ct, If conversion failed, cql_transform_buf - returns a non-zero SRW error code; otherwise zero is returned + returns a non-zero SRU error code; otherwise zero is returned (conversion successful). The meanings of the numeric error - codes are listed in the SRW specifications at + codes are listed in the SRU specifications at @@ -1195,7 +1195,7 @@ int cql_transform_error(cql_transform_t ct, char **addinfop); context set that was not recognised. - The SRW error-codes may be translated into brief human-readable + The SRU error-codes may be translated into brief human-readable error messages using const char *cql_strerror(int code); diff --git a/doc/yaz-client-commands.xml b/doc/yaz-client-commands.xml index 0849be8..0d08739 100644 --- a/doc/yaz-client-commands.xml +++ b/doc/yaz-client-commands.xml @@ -1,5 +1,5 @@ @@ -473,7 +473,7 @@ Specifies schema for retrieval. Schema may be specified as an OID for Z39.50. - For SRW, schema is a simple string URI. + For SRU, schema is a simple string URI. @@ -486,7 +486,7 @@ Specifies character set (encoding) for Z39.50 - negotiation / SRW encoding and/or character set for output (terminal). + negotiation / SRU encoding and/or character set for output (terminal). negotiationcharset is the name diff --git a/doc/yaz-client-man.xml b/doc/yaz-client-man.xml index 6186110..9122f6e 100644 --- a/doc/yaz-client-man.xml +++ b/doc/yaz-client-man.xml @@ -8,7 +8,7 @@ %common; ]> - + @@ -18,7 +18,7 @@ yaz-client - Z39.50/SRW client for implementors + Z39.50/SRU client for implementors @@ -41,13 +41,13 @@ DESCRIPTION - yaz-client is a Z39.50/SRW client (origin) with a + yaz-client is a Z39.50/SRU client (origin) with a simple command line interface that allows you to test behavior and - performance of Z39.50 targets and SRW servers. + performance of Z39.50 targets and SRU servers. If the addr is specified, the client creates - a connection to the Z39.50/SRW target at the address given. + a connection to the Z39.50/SRU target at the address given. When yaz-client is invoked it attemps to read the diff --git a/doc/yaz-man.xml b/doc/yaz-man.xml index aa438ac..d919f56 100644 --- a/doc/yaz-man.xml +++ b/doc/yaz-man.xml @@ -8,7 +8,7 @@ %common; ]> - + yaz @@ -30,7 +30,7 @@ YAZ is a C/C++ programmer's toolkit supporting the development of Z39.50v3 clients and servers. The YAZ toolkit offers - several different levels of access to the ISO23950/Z39.50, SRW/SRU + several different levels of access to the ISO23950/Z39.50, SRU and ILL protocols. The level that you need to use depends on your requirements, and the role (server of client) that you want to implement. diff --git a/doc/zoom.xml b/doc/zoom.xml index fa22ad0..29f9514 100644 --- a/doc/zoom.xml +++ b/doc/zoom.xml @@ -20,7 +20,7 @@ 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 @@ -32,8 +32,8 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) - 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. @@ -108,7 +108,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) 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 @@ -316,14 +316,14 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) 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. @@ -576,22 +576,22 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) - 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, @@ -602,18 +602,18 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) 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). @@ -729,7 +729,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) 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 @@ -777,9 +777,9 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) 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. -- 1.7.10.4