From 876d1f923efd4054054e745c56794e1fc356d7bd Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Sun, 30 Apr 2006 12:53:14 +0000 Subject: [PATCH] Added more URLs to YAZ ZOOM doc --- doc/installation.xml | 52 +++++++++++++++++++++++++-------------- doc/zoom.xml | 67 +++++++++++++++++++++++--------------------------- 2 files changed, 64 insertions(+), 55 deletions(-) diff --git a/doc/installation.xml b/doc/installation.xml index dbd3d46..63eba40 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,5 +1,5 @@ - + Installation You need a C++ compiler to compile and use YAZ++. @@ -17,7 +17,7 @@ For some platforms there are binary packages for YAZ.
- Building on Unix + Installation on Unix (from source) On UNIX, the software is compiled as follows: $ ./configure @@ -34,7 +34,7 @@ --prefix directory Specifies installation prefix. By default - /usr/local is used. + /usr/local is used. @@ -70,46 +70,46 @@ This is what you have after successful compilation: - src/libyazpp.la + src/libyazpp.la The YAZ++ library. This library gets installed in your libraries directory - (prefix/lib). + (prefix/lib). - src/libzoompp.la + src/libzoompp.la The ZOOM-C++ library. This library gets installed in your libraries directory - (prefix/lib). + (prefix/lib). - include/yazpp/*.h + include/yazpp/*.h Various C++ header files, which you'll need for YAZ++ development. All these are installed in your header files area - (prefix/include/yazpp). + (prefix/include/yazpp). - yazpp-config + yazpp-config A Bourne shell-script utility that returns the values of the CFLAGS and LIBS environment variables needed in order to compile your applications with the YAZ++ library. This script gets installed in your binaries directory - (prefix/bin). + (prefix/bin). - zoom/zclient + zoom/zclient ZOOM C++ demonstration client that uses the ZOOM C++ classes. This client does not get installed in the system directories. @@ -117,7 +117,7 @@ - src/yaz-my-client + src/yaz-my-client YAZ C++ demonstration client. This client does not get installed in the system directories. @@ -125,7 +125,7 @@ - src/yaz-my-server + src/yaz-my-server YAZ C++ demonstration server. This server does not get installed in the system directories. @@ -135,14 +135,14 @@
- Building on Windows + Installation on Windows YAZ++ is shipped with "makefiles" for the NMAKE tool that comes with Microsoft Visual Studio. - Version 6 and .NET 2003 has been tested. We expect that YAZ++ compiles - with version 5 as well. + Version 2003 (7) and 2005 (8) has been tested. + We expect that YAZ++ compiles with versions 5 and 6 as well. - + Start a command prompt and switch the sub directory WIN where the file makefile is located. Customize the installation by editing the @@ -160,7 +160,7 @@ (code generation is multi-threaded DLL). - YAZ_DIR + YAZ_DIR Specifies the directory of the YAZ source. @@ -198,13 +198,27 @@ bin/yazpp.dll YAZ++ DLL . Includes ZOOM C++ as well. + For the debug version lib/yazppd.dll + is created instead. lib/yazpp.lib Import library for yazpp.dll. + For the debug version lib/yazppd.lib + is created instead. + bin/yaz-my-client.exe + + Z39.50 client demonstrating the YAZ++ API. + + + bin/yaz-my-server.exe + + Z39.50 server demonstrating the YAZ++ API. + + bin/zclient.exe ZOOM C++ demo client. A simple WIN32 console application. diff --git a/doc/zoom.xml b/doc/zoom.xml index d869330..4bd55b3 100644 --- a/doc/zoom.xml +++ b/doc/zoom.xml @@ -1,25 +1,24 @@ - + ZOOM-C++ Introduction - ZOOM + ZOOM is the emerging standard API for information retrieval programming using the Z39.50 protocol. ZOOM's - Abstract API + Abstract API specifies semantics for classes representing key IR concepts such as connections, queries, result sets and records; and there are various - bindings + bindings specifying how those concepts should be represented in various programming languages. The YAZ++ library includes an implementation of the C++ binding + url="&url.zoom.bind.cplusplus;">C++ binding for ZOOM, enabling quick, easy development of client applications. @@ -56,7 +55,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 @@ -153,17 +152,17 @@ Section 3.2 (Connection) of the ZOOM Abstract API - - - - - The Connections section of the ZOOM-C documentation - - - - - + + + + + The Connections section f the ZOOM-C documentation + + + + + @@ -184,14 +183,13 @@ ~prefixQuery (); }; - - This class enables a query to be created by compiling YAZ's - cryptic but powerful - Prefix Query Notation (PQN). - - - + + This class enables a query to be created by compiling YAZ's + cryptic but powerful + Prefix Query Notation (PQN). + + + <literal>ZOOM::CCLQuery</literal> @@ -204,8 +202,7 @@ This class enables a query to be created using the simpler but less expressive - Common Command Language (CCL). + 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 documentation. @@ -257,7 +254,7 @@ - The Queries section of the ZOOM-C documentation @@ -339,7 +336,7 @@ - The Result Sets section of the ZOOM-C documentation @@ -469,7 +466,7 @@ - The Records section of the ZOOM-C documentation @@ -654,10 +651,8 @@ - Bib-1 Diagnostics on the - Z39.50 Maintenance Agency site. + Bib-1 Diagnostics on the + Z39.50 Maintenance Agency site. @@ -667,7 +662,7 @@ exception class and its subclasses. The closest thing is the ZOOM_connection_error function described in - The Connections section of the documentation. -- 1.7.10.4