From: Adam Dickmeiss Date: Sun, 11 Apr 2004 11:16:39 +0000 (+0000) Subject: Fix a few links X-Git-Tag: YAZPP.0.8~17 X-Git-Url: http://sru.miketaylor.org.uk/cgi-bin?a=commitdiff_plain;h=b44f9237a703f1f88f0d2768e3e358110751bb5f;p=yazpp-moved-to-github.git Fix a few links --- diff --git a/doc/introduction.xml b/doc/introduction.xml index 73f2747..18841d3 100644 --- a/doc/introduction.xml +++ b/doc/introduction.xml @@ -1,11 +1,11 @@ - + Introduction YAZ++ is a C++ layer for YAZ and implements the ANSI Z39.50 protocol for information retrieval (client and server side). While YAZ itself can be used from both C and C++ it is limited by the - common denomiator: C. + common denominator C. The YAZ++ packages also features a ZOOM interface for C++ ( @@ -15,24 +15,19 @@ Later versions (0.7+) of YAZ++ also supports SRW/SRU. - YAZ++ and ZOOM C++ uses the same license as YAZ - see LICENSE file - for details. - - - This package also contains a proxy as well as a proxy library. - The proxy can be used to debug existing Z39.50 implementations, - optimize Z39.50 operation (by caching and other mechanisms), and - offer a SRW/SRU service. - The proxy and the proxy library is covered by the GPL. - See LICENSE.proxy for details. + This package also contains a proxy application and proxy developer + library. + The proxy application can be used to debug existing Z39.50 + implementations, optimize Z39.50 operation (by caching and other + mechanisms), and offer a SRW/SRU service.
Licensing - The Proxy and its companion library is covered by the + The proxy application and the proxy library is covered by the GPL. - The remaning parts: the ZOOM-C++ binding and the YAZ++ library is covered + The remaning parts: the ZOOM-C++ library and the YAZ++ library is covered by the YAZ license.
diff --git a/doc/proxy.xml b/doc/proxy.xml index 5562454..3f0c27c 100644 --- a/doc/proxy.xml +++ b/doc/proxy.xml @@ -1,13 +1,19 @@ The YAZ Proxy - The YAZ proxy is a transparent Z39.50-to-Z39.50 gateway. That is, - it is a Z39.50 server which has as its back-end a Z39.50 client - that forwards requests on to another server (known as the - backend target.) + The YAZ proxy is a transparent SRW/SRU/Z39.50-to-Z39.50 gateway. + That is, it is a SRW/SRU/Z39.50 server which has as its back-end a + Z39.50 client that forwards requests on to another server (known as + the backend target.) - The YAZ Proxy is useful for debugging Z39.50 software, logging + -- All config directives -- + -- SRW/SRU .. + -- Example config + -- Mention XSLT conversion + + + The YAZ Proxy is useful for debugging SRW/SRU/Z39.50 software, logging APDUs, redirecting Z39.50 packages through firewalls, etc. Furthermore, it offers facilities that often boost performance for connectionless Z39.50 clients such @@ -126,11 +132,11 @@
Specifying the Backend Target - When the proxy accepts a Z39.50 client session, it - determines the backend target by the following rules: + When the proxy receives a Z39.50 Initialize Request from a Z39.50 + client, it determines the backend target by the following rules: - If the InitializeRequest PDU from the + If the InitializeRequest PDU from the client includes an otherInfo element with OID @@ -139,19 +145,19 @@ usual YAZ address format (typically tcp:hostname:port) as described in - the Addresses section of the YAZ manual. - Otherwise, the Proxy uses the default target, if one was + Otherwise, the Proxy uses the default target, if one was specified on the command-line with the -t option. A default target can also be specified in the XML Config file. - Otherwise, the proxy closes the connection with + Otherwise, the proxy closes the connection with the client. @@ -247,9 +253,10 @@ client. Finally, the proxy may convert records. - In the current version the only supported conversion is - MARC21/USMARC in MARC-8 charset to MARCXML in UTF-8. Future version of - the proxy may do other record/charset conversions. + The proxy can convert from MARC to MARCXML and thereby offer an + XML version of any MARC record as long as it is ISO2709 encoded. + If the proxy is compiled with libXSLT support it can also + perform XSLT on XML.
@@ -264,11 +271,11 @@
Proxy Configuration File - The Proxy as an option may read a configuration file using option + The Proxy may read a configuration file using option -c followed by the filename of a config file. - The config file is in XML format. The YAZ proxy must be compiled + The config file is XML based. The YAZ proxy must be compiled with libxml2 and libXSLT support in order for the config file facility to be enabled. diff --git a/doc/zoom.xml b/doc/zoom.xml index 7ae1c3b..e61a14e 100644 --- a/doc/zoom.xml +++ b/doc/zoom.xml @@ -1,5 +1,5 @@ - + ZOOM-C++ @@ -56,7 +56,7 @@ implementation of the C binding. For information on the supported options and other such details, see the ZOOM-C documentation, which can be found on-line at - + All of the classes defined by ZOOM-C++ are in the @@ -157,7 +157,7 @@ - The Connections section of the ZOOM-C documentation @@ -187,7 +187,7 @@ This class enables a query to be created by compiling YAZ's cryptic but powerful - Prefix Query Notation (PQN). @@ -204,7 +204,7 @@ This class enables a query to be created using the simpler but less expressive - Common Command Language (CCL). The qualifiers recognised by the CCL parser are specified in an external configuration file in the format described by the YAZ @@ -257,7 +257,7 @@ - The Queries section of the ZOOM-C documentation @@ -339,7 +339,7 @@ - The Result Sets section of the ZOOM-C documentation @@ -423,7 +423,7 @@ Memory Management - The record obejcts returned from + The record objects returned from resultSet::getRecord() are ``owned'' by the result set object: that means that the application is not responsible for deleteing them - each @@ -469,7 +469,7 @@ - The Records section of the ZOOM-C documentation @@ -667,7 +667,7 @@ exception class and its subclasses. The closest thing is the ZOOM_connection_error function described in - The Connections section of the documentation.