lib/ZOOM.pod

   1 # $Id: ZOOM.pod,v 1.1 2005-11-09 11:32:12 mike Exp $
   2
   3 use strict;
   4 use warnings;
   5
   6 =head1 NAME
   7
   8 ZOOM - Perl extension implementing the ZOOM API for Information Retrieval
   9
  10 =head1 SYNOPSIS
  11
  12  use ZOOM;
  13  eval {
  14      $conn = new ZOOM::Connection($host, $port)
  15      $conn->option(preferredRecordSyntax => "usmarc");
  16      $rs = $conn->search_pqf($query);
  17      $n = $rs->size();
  18      print $rs->record(0)->render();
  19  };
  20  if ($@) {
  21      print "Error ", $@->code(), ": ", $@->message(), "\n";
  22  }
  23
  24 =head1 DESCRIPTION
  25
  26 This module provides a nice, Perlish implementation of the ZOOM
  27 Abstract API described at http://zoom.z3950.org/api/
  28
  29 the ZOOM module is implemented as a set of thin classes on top of the
  30 non-OO functions provided by the Net::Z3950::ZOOM module, which in
  31 turn is a thin layer on top of the ZOOM-C code supplied as part of
  32 Index Data's YAZ Toolkit.  Because ZOOM-C is also the underlying code
  33 that implements ZOOM bindings in C++, Visual Basic, Scheme, Ruby, .NET
  34 (including C#) and other languages, this Perl module works compatibly
  35 with those other implementations.  (Of course, the point of a public
  36 API such as ZOOM is that all implementations should be compatible
  37 anyway; but knowing that the same code is running is reassuring.)
  38
  39 I<###> There is rather more to say here :-)
  40
  41 =head1 SEE ALSO
  42
  43 The C<Net::Z3950::ZOOM> module, included in the same distribution as this one.
  44
  45 The C<Net::Z3950> module, which this one supersedes.
  46
  47 =head1 AUTHOR
  48
  49 Mike Taylor, E<lt>mike@indexdata.comE<gt>
  50
  51 =head1 COPYRIGHT AND LICENCE
  52
  53 Copyright (C) 2005 by Index Data.
  54
  55 This library is free software; you can redistribute it and/or modify
  56 it under the same terms as Perl itself, either Perl version 5.8.4 or,
  57 at your option, any later version of Perl 5 you may have available.
  58
  59 =cut
  60
  61 1;