X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Fintroduction.xml;h=dd93b10c54046af9d02a7b014896c10b95f131f6;hp=2201591834328e4beb68c65093ae1af860da4f43;hb=4466c3fb3ec5053427237ca4523ed4ed9f7e9425;hpb=2bf08e725ba16cfa16df8d03468891c57c1670b8 diff --git a/doc/introduction.xml b/doc/introduction.xml index 2201591..dd93b10 100644 --- a/doc/introduction.xml +++ b/doc/introduction.xml @@ -1,53 +1,56 @@ - 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.1, 1.2 and 2.0 (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 +75,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 +87,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 +119,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 +129,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. @@ -156,24 +159,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 @@ -205,9 +207,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. @@ -250,7 +252,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 @@ -261,7 +263,7 @@ (note the lower-case "z" in the function name) - + If you are using the premade definitions of the &asn; module, and you @@ -270,7 +272,7 @@ . - + When you have created a BER-encoded buffer, you can use the &comstack; subsystem to transmit (or receive) data over the network. The &comstack;