X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fintroduction.xml;h=fedf22aae38f61d863684083f2dd79bfa5309045;hb=5a0004a1d8cdf8258c8b823d9026939411d2238f;hp=e8150ad2cd320bcf9bbd5b8228417a3278e056b4;hpb=6b3cf0738c53080781fedd852e26b299224af3c3;p=yaz-moved-to-github.git diff --git a/doc/introduction.xml b/doc/introduction.xml index e8150ad..fedf22a 100644 --- a/doc/introduction.xml +++ b/doc/introduction.xml @@ -1,53 +1,51 @@ - + Introduction &yaz; is a C/C++ library for information retrieval applications - using the Z39.50/SRW protocols for information retrieval. + using the Z39.50/SRW/SRU protocols for information retrieval. - + Properties of &yaz;: Complete - Z39.50 - version 3 support. Amendments and Z39.50-2002 revision is - supported. + Z39.50 version 3 support. + Amendments and Z39.50-2002 revision is supported. Supports - SRW - version 1.0 (over HTTP and HTTPS). + SRW/SRU + version 1.1 (over HTTP and HTTPS). Includes BER encoders/decoders for the - ISO ILL + ISO ILL protocol. Supports the following transports: BER over TCP/IP - (RFC1729), + (RFC1729), BER over unix local socket, and - HTTP - 1.1. + HTTP 1.1. Secure Socket Layer support using - OpenSSL. + OpenSSL. If enabled, &yaz; uses HTTPS transport (for SOAP) or "Secure BER" (for Z39.50). Offers - ZOOM - C API implementing both Z39.50 and SRW. + ZOOM C API implementing both + Z39.50 and SRW. The &yaz; library offers a set of useful utilities related to the protocols, such as MARC (ISO2709) parser, CCL (ISO8777) parser, - CQL + CQL parser, memory management routines, character set conversion. @@ -82,16 +80,16 @@ - + describes the ZOOM API of &yaz;. This is definitely worth a read if you wish to develop a Z39.50/SRW client. - + - describes the generic frontend server + 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. @@ -126,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 implementors + and see what's relevant to you! SRW/SRU implementors might find the CQL section particularly useful. @@ -136,10 +134,11 @@ goes through the details of the ODR module which is the work horse that encodes and decodes - BER packages. Implementors using ZOOM only do not need reading this. + BER packages. Implementors using ZOOM only, do not + need reading this. Most other Z39.50 implementors only need to read the first two - sections Introduction, - Using ODR. + sections ( and + ). @@ -157,11 +156,11 @@ The API - The &yaz; + The &yaz; toolkit offers several different levels of access to the - ISO23950/Z39.50, - ILL and - SRW + ISO23950/Z39.50, + ILL and + SRU/SRW protocols. The level that you need to use depends on your requirements, and the role (server or client) that you want to implement. @@ -171,8 +170,7 @@ Server implementers should consider the generic frontend server. None of those high-level APIs support the whole protocol, but - they do include most facilities used in existing Z39.50 - applications. + they do include most facilities used in existing Z39.50 applications. If you're using 'exotic' functionality (meaning anything not included in @@ -180,8 +178,6 @@ you're going to develop an ILL application you'll have to learn the lower level APIs of &yaz;. - - The YAZ toolkit modules is shown in figure . @@ -267,8 +263,8 @@ If you are using the premade definitions of the &asn; module, and you are not adding new protocol of your own, the only parts of &odr; that you - need to worry about are documented in section - Using ODR. + need to worry about are documented in + .