source: yaz/trunk/fuentes/doc/introduction.html @ 255

Last change on this file since 255 was 255, checked in by mabarracus, 4 years ago

added trusty code to xenial

File size: 8.2 KB
1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 1. Introduction</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="index.html" title="YAZ User's Guide and Reference"><link rel="up" href="index.html" title="YAZ User's Guide and Reference"><link rel="prev" href="index.html" title="YAZ User's Guide and Reference"><link rel="next" href="introduction.api.html" title="2. The API"></head><body><link rel="stylesheet" type="text/css" href="common/style1.css"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 1. Introduction</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="introduction.api.html">Next</a></td></tr></table><hr></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="introduction"></a>Chapter 1. Introduction</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="introduction.html#introduction.reading">1. Reading this Manual</a></span></dt><dt><span class="sect1"><a href="introduction.api.html">2. The API</a></span></dt></dl></div><p>
2   YAZ is a C/C++ library for information retrieval applications
3   using the Z39.50/SRU/Solr protocols for information retrieval.
4  </p><p>
5   Properties of YAZ:
6   </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
7      Complete
8      <a class="ulink" href="" target="_top">Z39.50</a> version 3 support.
9      Amendments and Z39.50-2002 revision is supported.
10    </p></li><li class="listitem"><p>
11      Supports
12      <a class="ulink" href="" target="_top">SRU GET/POST/SOAP</a>
13      version 1.1, 1.2 and 2.0 (over HTTP and HTTPS).
14    </p></li><li class="listitem"><p>
15      Includes BER encoders/decoders for the
16      <a class="ulink" href="" target="_top">ISO ILL</a>
17      protocol.
18    </p></li><li class="listitem"><p>
19      Supports
20      <a class="ulink" href="" target="_top">Solr</a> Web Service version 1.4.x
21      (client side only)
22     </p></li><li class="listitem"><p>
23      Supports the following transports: BER over TCP/IP
24      (<a class="ulink" href="" target="_top">RFC1729</a>),
25      BER over unix local socket, and
26      <a class="ulink" href="" target="_top">HTTP 1.1</a>.
27    </p></li><li class="listitem"><p>
28      Secure Socket Layer support using
29      <a class="ulink" href="" target="_top">GnuTLS</a>.
30      If enabled, YAZ uses HTTPS transport (for SOAP) or
31      "Secure BER" (for Z39.50).
32     </p></li><li class="listitem"><p>
33      Offers
34      <a class="ulink" href="" target="_top">ZOOM</a> C API implementing
35      Z39.50, SRU and Solr Web Service.
36    </p></li><li class="listitem"><p>
37      The YAZ library offers a set of useful utilities
38      related to the protocols, such as MARC (ISO2709) parser,
39      CCL (ISO8777) parser,
40      <a class="ulink" href="" target="_top">CQL</a>
41      parser, memory management routines, character set conversion.
42     </p></li><li class="listitem"><p>
43      Portable code. YAZ compiles out-of-the box on most Unixes and
44      on Windows using Microsoft Visual C++.
45     </p></li><li class="listitem"><p>
46      Fast operation. The C based BER encoders/decoders as well
47      as the server component of YAZ is very fast.
48    </p></li><li class="listitem"><p>
49      Liberal license that allows for commercial use of YAZ.
50     </p></li></ul></div><p>
51  </p><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="introduction.reading"></a>1. Reading this Manual</h2></div></div></div><p>
52    Most implementors only need to read a fraction of the
53    material in thie manual, so a quick walkthrough of the chapters
54    is in order.
55   </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
56      <a class="xref" href="installation.html" title="Chapter 2. Compilation and Installation">Chapter 2, <i>Compilation and Installation</i></a> contains installation
57      instructions for YAZ. You don't need reading this
58      if you expect to download YAZ binaries.
59      However, the chapter contains information about how
60      to make <span class="emphasis"><em>your</em></span> application link
61      with YAZ.
62     </p></li><li class="listitem"><p>
63      <a class="xref" href="zoom.html" title="Chapter 3. ZOOM">Chapter 3, <i>ZOOM</i></a> describes the ZOOM API of YAZ.
64      This is definitely worth a read if you wish to develop a Z39.50/SRU
65      client.
66     </p></li><li class="listitem"><p>
67      <a class="xref" href="server.html" title="Chapter 4. Generic server">Chapter 4, <i>Generic server</i></a> describes the generic frontend server
68      and explains how to develop server Z39.50/SRU applications for YAZ.
69      Obviously worth reading if you're to develop a server.
70    </p></li><li class="listitem"><p>
71      <a class="xref" href="yaz-client.html" title="yaz-client"><span class="refentrytitle">yaz-client</span>(1)</a> describes how to use the YAZ Z39.50
72      client. If you're developer and wish to test your server
73      or a server from another party, you might find this chapter
74      useful.
75    </p></li><li class="listitem"><p>
76      <a class="xref" href="asn.html" title="Chapter 5. The Z39.50 ASN.1 Module">Chapter 5, <i>The Z39.50 ASN.1 Module</i></a> documents the most commonly used Z39.50
77      C data structures offered by the YAZ API. Client
78      developers using ZOOM and non-Z39.50 implementors may skip this.
79     </p></li><li class="listitem"><p>
80      <a class="xref" href="soap.html" title="Chapter 6. SOAP and SRU">Chapter 6, <i>SOAP and SRU</i></a> describes how SRU and SOAP is used
81      in YAZ. Only if you're developing SRU applications
82      this section is a must.
83     </p></li><li class="listitem"><p>
84      <a class="xref" href="tools.html" title="Chapter 7. Supporting Tools">Chapter 7, <i>Supporting Tools</i></a> contains sections for the various
85      tools offered by YAZ. Scan through the material quickly
86      and see what's relevant to you! SRU implementors
87      might find the <a class="link" href="tools.html#cql" title="1.3. CQL">CQL</a> section
88      particularly useful.
89     </p></li><li class="listitem"><p>
90      <a class="xref" href="odr.html" title="Chapter 8. The ODR Module">Chapter 8, <i>The ODR Module</i></a> goes through the details of the
91      ODR module which is the work horse that encodes and decodes
92      BER packages. Implementors using ZOOM only, do <span class="emphasis"><em>not</em></span>
93      need reading this.
94      Most other Z39.50 implementors only need to read the first two
95      sections (<a class="xref" href="odr.html#odr.introduction" title="1. Introduction">Section 1, &#8220;Introduction&#8221;</a> and
96      <a class="xref" href="odr.use.html" title="2. Using ODR">Section 2, &#8220;Using ODR&#8221;</a>).
97     </p></li><li class="listitem"><p>
98      <a class="xref" href="comstack.html" title="Chapter 9. The COMSTACK Module">Chapter 9, <i>The COMSTACK Module</i></a> describes the network layer module
99      COMSTACK. Implementors using ZOOM or the generic frontend server
100      may skip this. Others, presumably, handling client/server
101     communication on their own should read this.
102     </p></li></ul></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="introduction.api.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">YAZ User's Guide and Reference </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> 2. The API</td></tr></table></div></body></html>
Note: See TracBrowser for help on using the repository browser.