X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Fintroduction.xml;h=fc9a628b20ccdbea415cc4d025cc9a985fc3cf47;hp=836a43cbc7b9d271848d6fe544e73a97fa19e889;hb=e7cef788e6e6ae270dc9a274b5da51e953ca5479;hpb=f9828584ad6d0f66eb85b2e6d8bca5a29d569dcb diff --git a/doc/introduction.xml b/doc/introduction.xml index 836a43c..fc9a628 100644 --- a/doc/introduction.xml +++ b/doc/introduction.xml @@ -1,9 +1,8 @@ - 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. @@ -11,43 +10,46 @@ 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/SRU - version 1.1 (over HTTP and HTTPS). + SRU GET/POST/SOAP + version 1.2 (over HTTP and HTTPS). Includes BER encoders/decoders for the - ISO ILL + ISO ILL protocol. + Supports + SOLR Web Service version 1.4.x (client side only) + + 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. + 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. + 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 + CQL parser, memory management routines, character set conversion. @@ -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. @@ -158,11 +160,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 protocols. The level that you need to use depends on your requirements, and the role (server or client) that you want to implement. @@ -172,8 +174,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 @@ -207,7 +208,7 @@ The second layer provides a C represenation of the protocol units (packages) for Z39.50 ASN.1, ILL ASN.1, - SRW SOAP. + SRU.