From: mike <mike>
Date: Tue, 15 Nov 2005 17:23:45 +0000 (+0000)
Subject: ROlling.
X-Git-Tag: cpan_1_22~363
X-Git-Url: http://lists.indexdata.com/cgi-bin?a=commitdiff_plain;h=4c4359d9cf8b2b16ccb5254a24fc1ab1eb5cab3e;p=ZOOM-Perl-moved-to-github.git

ROlling.
---

diff --git a/lib/ZOOM.pod b/lib/ZOOM.pod
index 28c3f81..83a55e3 100644
--- a/lib/ZOOM.pod
+++ b/lib/ZOOM.pod
@@ -1,4 +1,4 @@
-# $Id: ZOOM.pod,v 1.1 2005-11-09 11:32:12 mike Exp $
+# $Id: ZOOM.pod,v 1.2 2005-11-15 17:23:45 mike Exp $
 
 use strict;
 use warnings;
@@ -13,7 +13,7 @@ ZOOM - Perl extension implementing the ZOOM API for Information Retrieval
  eval {
      $conn = new ZOOM::Connection($host, $port)
      $conn->option(preferredRecordSyntax => "usmarc");
-     $rs = $conn->search_pqf($query);
+     $rs = $conn->search_pqf('@attr 1=4 dinosaur');
      $n = $rs->size();
      print $rs->record(0)->render();
  };
@@ -27,7 +27,8 @@ This module provides a nice, Perlish implementation of the ZOOM
 Abstract API described at http://zoom.z3950.org/api/
 
 the ZOOM module is implemented as a set of thin classes on top of the
-non-OO functions provided by the Net::Z3950::ZOOM module, which in
+non-OO functions provided by this distribution's C<Net::Z3950::ZOOM>
+module, which in 
 turn is a thin layer on top of the ZOOM-C code supplied as part of
 Index Data's YAZ Toolkit.  Because ZOOM-C is also the underlying code
 that implements ZOOM bindings in C++, Visual Basic, Scheme, Ruby, .NET
@@ -36,7 +37,26 @@ with those other implementations.  (Of course, the point of a public
 API such as ZOOM is that all implementations should be compatible
 anyway; but knowing that the same code is running is reassuring.)
 
-I<###> There is rather more to say here :-)
+The ZOOM module provides two enumerations (C<ZOOM::Error> and
+C<ZOOM::Event>), a single utility function C<diag_str()> in the C<ZOOM>
+package itself, and eight classes:
+C<ZOOM::Exception>,
+C<ZOOM::Options>,
+C<ZOOM::Connection>,
+C<ZOOM::Query>,
+C<ZOOM::ResultSet>,
+C<ZOOM::Record>,
+C<ZOOM::ScanSet>
+and
+C<ZOOM::Package>.
+Of these, the Query class is abstract, and has two concrete
+subclasses:
+C<ZOOM::Query::CQL>
+and
+C<ZOOM::Query::PQF>.
+Many useful ZOOM applications can be built using only the Connection,
+ResultSet and Record classes, as in the example code-snippet above.
+
 
 =head1 SEE ALSO