From 6a72b9b6d8f8b540bc6f400e2e9791122fec8cf9 Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Wed, 14 Jun 2006 10:12:23 +0000 Subject: [PATCH] Material fixes as pointed out by Ashley Sanders. Mention SRU rather than SRW/SRU in most places. --- README | 8 ++++---- doc/installation.xml | 4 ++-- doc/introduction.xml | 6 +++--- doc/reference.xml | 30 +++++++++++------------------- doc/using.xml | 16 ++++++++-------- doc/yaz-proxy-ref.xml | 4 ++-- doc/yazproxy.xml | 6 +++--- 7 files changed, 33 insertions(+), 41 deletions(-) diff --git a/README b/README index 8217b6a..9920d5d 100644 --- a/README +++ b/README @@ -1,11 +1,11 @@ -YAZ proxy - A Z39.50/SRW/SRU proxy. +YAZ proxy - A Z39.50/SRU proxy. -$Id: README,v 1.5 2004-04-11 17:31:51 adam Exp $ +$Id: README,v 1.6 2006-06-14 10:12:23 adam Exp $ Introduction ------------ -YAZ proxy is a powerful general purpose Z39.50/SRW/SRU proxy. +YAZ proxy is a powerful general purpose Z39.50/SRU proxy. The proxy application and development library is covered by the GPL - see LICENSE for details. @@ -49,7 +49,7 @@ PROXY. The OID is 1.2.840.10003.10.1000.81.1. categoryValue [2] IMPLICIT INTEGER} The InfoCategory is present with categoryTypeId set to the PROXY OID -and categoryValue set to 0. The information in OtherInformation uses +and categoryValue set to 1. The information in OtherInformation uses characterInfo to represent the target using the form target[:port][/db]. For clients that don't set the PROXY OtherInformation, a default diff --git a/doc/installation.xml b/doc/installation.xml index e9ad18c..e45f355 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,5 +1,5 @@ - + Installation You need a C++ compiler to compile and use YAZ proxy. @@ -24,7 +24,7 @@ libXSLT are installed. YAZ must be configured with libxml2 support. If not, - SRW/SRU + SRU is not supported. The YAZ Proxy uses libXSLT for record conversions via XSLT. diff --git a/doc/introduction.xml b/doc/introduction.xml index 4faf2b2..b67101b 100644 --- a/doc/introduction.xml +++ b/doc/introduction.xml @@ -1,4 +1,4 @@ - + Introduction The YAZ Proxy is @@ -9,10 +9,10 @@ - SRW/SRU + SRU GET/POST/SOAP server function, to allow any Z39.50 - server to also support the SRW/SRU protocols. + server to also support the SRU protocols. diff --git a/doc/reference.xml b/doc/reference.xml index 4c36259..5fa7146 100644 --- a/doc/reference.xml +++ b/doc/reference.xml @@ -58,14 +58,13 @@ - If the proxy receives an SRW/SRU request, the following rules are used. + If the proxy receives an SRU request, the following rules are used. If default target has Explain information with a database that matches the path of the - HTTP request of SRW/SRU that backend server is used for - SRW/SRU operation. - + HTTP request of SRU that backend server is used for SRU operation. + @@ -74,13 +73,6 @@ - - - We know it is stupid to only check for explain in default target. - It means that it is only possible to offer one SRW/SRU server. - We expect to improve that in the next version of the YAZ proxy. - -
Keep-alive Facility @@ -458,12 +450,12 @@ If attribute identifier is given that is the - SRW/SRU record schema identifier for the resulting output record (after + SRU record schema identifier for the resulting output record (after MARCXML and/or XSLT conversion). If sub element title is given (as child element - of syntax, then that is the official SRW/SRU + of syntax, then that is the official SRU name of the resulting record schema. @@ -504,7 +496,7 @@ explain The explain element includes Explain information - for SRW/SRU about the server in the target section. This + for SRU about the server in the target section. This information must have a serverInfo element with a database that this target must be available as (URL path). For example, @@ -519,7 +511,7 @@ ]]> - In the above case, the SRW/SRU service is available as + In the above case, the SRU service is available as http://myhost.org:8000/mydatabase. @@ -531,7 +523,7 @@ The content of the cql2rpn element specifies the path from the working directory to a CQL-to-RPN conversion file for the server in the target section. This element - is required for SRW/SRU searches to operate against Z39.50 + is required for SRU searches to operate against Z39.50 servers that don't support CQL. Most Z39.50 servers only support Type-1/RPN so this is usually required. @@ -614,7 +606,7 @@ If this is specified the proxy will act as a Z39.50 server - supporting character set negotiation. And in SRW/SRU mode + supporting character set negotiation. And in SRU mode it will convert from UTF-8 (UNICODE) to this native character set (if possible). @@ -824,7 +816,7 @@ The categoryTypeId is either OID 1.2.840.10003.10.1000.81.1, 1.2.840.10003.10.1000.81.2 for proxy target and proxy cookie respectively. The - integer element category is set to 0. + categoryValue is set to 1. The value proxy and cookie is stored in element characterInfo of the information choice. @@ -840,7 +832,7 @@ - The YAZ Proxy is useful for debugging SRW/SRU/Z39.50 software, logging + The YAZ Proxy is useful for debugging SRU/Z39.50 software, logging APDUs, redirecting Z39.50 packages through firewalls, etc. Furthermore, it offers facilities that often boost performance for connection-less Z39.50 clients such @@ -155,10 +155,10 @@ - Offering SRW/SRU/Z39.50 service + Offering SRU/Z39.50 service - In order to offer SRW/SRU service we must be specify sufficient - information to allow the proxy to convert from SRW/SRU to Z39.50. + In order to offer SRU service we must be specify sufficient + information to allow the proxy to convert from SRU to Z39.50. This involves translating CQL queries to Type-1 (also called RPN/PQF), since most Z39.50 servers do not support CQL. The conversion @@ -170,7 +170,7 @@ recommended). - An explain record for the SRW/SRU service must also be created. + An explain record for the SRU service must also be created. The following is a relatively simple configuration file for @@ -180,13 +180,13 @@ given by url. - The server may return USMARC/MARC21 (Z39.50/SRW/SRU) and - MARCXML (SRW/SRU only) as specified by the + The server may return USMARC/MARC21 (Z39.50/SRU) and + MARCXML (SRU only) as specified by the syntax elements. - + indexdata.dk diff --git a/doc/yaz-proxy-ref.xml b/doc/yaz-proxy-ref.xml index da0c713..fc831f3 100644 --- a/doc/yaz-proxy-ref.xml +++ b/doc/yaz-proxy-ref.xml @@ -4,7 +4,7 @@ yazproxy - The YAZ toolkit's transparent Z39.50/SRW/SRU proxy + The YAZ toolkit's transparent Z39.50/SRU proxy @@ -29,7 +29,7 @@ DESCRIPTION yazproxy is a proxy that accepts connections - from Z39.50/SRW/SRU clients and contacts a Z39.50 backend. + from Z39.50/SRU clients and contacts a Z39.50 backend. The listening port must be specified on the command-line. inetd operation is not supported. The host:port diff --git a/doc/yazproxy.xml b/doc/yazproxy.xml index 16df8ca..3892cad 100644 --- a/doc/yazproxy.xml +++ b/doc/yazproxy.xml @@ -9,7 +9,7 @@ %common; ]> - + YAZ proxy User's Guide and Reference @@ -24,13 +24,13 @@ YAZ proxy - is a powerful general purpose Z39.50/SRW/SRU proxy. + is a powerful general purpose Z39.50/SRU proxy. This manual covers version &version;. - CVS ID: $Id: yazproxy.xml,v 1.1 2006-06-02 08:53:23 adam Exp $ + CVS ID: $Id: yazproxy.xml,v 1.2 2006-06-14 10:12:26 adam Exp $ -- 1.7.10.4