X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Fintroduction.xml;h=bd327b5baf7ac665802a984c0f1bf674894edbfd;hp=3fbd789c7a7bdcca6ab5c7f86cf9cdb61a25b890;hb=191c5db0e914f9774413da50bb1963ecf22b2f5c;hpb=83826a4336911dffd420ce9c147156d7c7fbc894 diff --git a/doc/introduction.xml b/doc/introduction.xml index 3fbd789..bd327b5 100644 --- a/doc/introduction.xml +++ b/doc/introduction.xml @@ -1,53 +1,55 @@ - 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/Solr protocols for information retrieval. Properties of &yaz;: - Complete - Z39.50 - version 3 support. Amendments and Z39.50-2002 revision is - supported. + Complete + Z39.50 version 3 support. + Amendments and Z39.50-2002 revision is supported. - Supports - SRW/SRU - version 1.0 (over HTTP and HTTPS). + Supports + SRU GET/POST/SOAP + version 1.2 (over HTTP and HTTPS). - Includes BER encoders/decoders for the - ISO ILL + Includes BER encoders/decoders for the + ISO ILL protocol. + Supports + Solr Web Service version 1.4.x (client side only) + + Supports the following transports: BER over TCP/IP - (RFC1729), - BER over unix local socket, and - HTTP - 1.1. + (RFC1729), + BER over unix local socket, and + HTTP 1.1. Secure Socket Layer support using - OpenSSL. + GNU TLS or + 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. + Offers + ZOOM C API implementing + Z39.50, SRU and Solr Web Service. The &yaz; library offers a set of useful utilities related to the protocols, such as MARC (ISO2709) parser, - CCL (ISO8777) parser, - CQL + CCL (ISO8777) parser, + CQL parser, memory management routines, character set conversion. @@ -72,7 +74,7 @@ - contains installation + contains installation instructions for &yaz;. You don't need reading this if you expect to download &yaz; binaries. However, the chapter contains information about how @@ -84,22 +86,22 @@ 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. - describes how to use the &yaz; Z39.50 + describes how to use the &yaz; Z39.50 client. If you're developer and wish to test your server or a server from another party, you might find this chapter useful. @@ -116,8 +118,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. @@ -126,8 +128,8 @@ contains sections for the various tools offered by &yaz;. Scan through the material quickly - and see what's relevant to you! SRW/SRU implementors - might find the CQL section + and see what's relevant to you! SRU implementors + might find the CQL section particularly useful. @@ -136,7 +138,7 @@ 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 + BER packages. Implementors using ZOOM only, do not need reading this. Most other Z39.50 implementors only need to read the first two sections ( and @@ -156,24 +158,23 @@ 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 protocols. The level that you need to use depends on your requirements, and the role (server or client) that you want to implement. If you're developing a client application you should consider the ZOOM API. It is, by far, the easiest way to develop clients in C. - Server implementers should consider the + 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 @@ -181,8 +182,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 . @@ -207,9 +206,9 @@ - The second layer provides a C represenation of the + The second layer provides a C represenation of the protocol units (packages) for Z39.50 ASN.1, ILL ASN.1, - SRW SOAP. + SRU. @@ -252,7 +251,7 @@ The &asn; library also provides functions (which are, in turn, defined using &odr; primitives) for encoding and decoding data values. Their general form is - + int z_xxx ODR o @@ -263,16 +262,16 @@ (note the lower-case "z" in the function name) - + 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 + . - + When you have created a BER-encoded buffer, you can use the &comstack; subsystem to transmit (or receive) data over the network. The &comstack;