| 1 | <html>
|
|---|
| 2 | <head>
|
|---|
| 3 | <title>Using the Z39.50 Client in Greenstone</title>
|
|---|
| 4 | </head>
|
|---|
| 5 |
|
|---|
| 6 | <body>
|
|---|
| 7 | <a name=top>
|
|---|
| 8 | <h1>Using the Z39.50 Client in Greenstone</h1>
|
|---|
| 9 | </a>
|
|---|
| 10 | <b>Table of Contents</b><br>
|
|---|
| 11 | <a href="#whatis">About: What is Z39.50?</a><br>
|
|---|
| 12 | <a href="#config">Configuring Greenstone - Adding Servers</a><br>
|
|---|
| 13 | <a href="#todo">Currently known problems, and TODO list</a><br>
|
|---|
| 14 | <a href="#contact">Contacting Us</a><br>
|
|---|
| 15 |
|
|---|
| 16 |
|
|---|
| 17 |
|
|---|
| 18 | <a name=whatis>
|
|---|
| 19 | <h2>What is Z39.50?</h2>
|
|---|
| 20 | </a>
|
|---|
| 21 | Z39.50 is an international client/server protocol for searching bibliographic
|
|---|
| 22 | data. It can use the Internet Protocol (TCP/IP), which makes the databases
|
|---|
| 23 | on a server available from almost anywhere around the globe. It is widely
|
|---|
| 24 | used, for example, in on-line library catalogues. It allows a user to search
|
|---|
| 25 | one or more databases and retrieve the results of the query.
|
|---|
| 26 |
|
|---|
| 27 | <p>
|
|---|
| 28 | Our implementation uses the YAZ z39.50 toolkit, written by
|
|---|
| 29 | <a href="http://www.indexdata.dk">Index Data</a>.
|
|---|
| 30 |
|
|---|
| 31 |
|
|---|
| 32 |
|
|---|
| 33 | <a name=config>
|
|---|
| 34 | <h2>Adding Servers</h2>
|
|---|
| 35 | </a>
|
|---|
| 36 | The file z3950.cfg in the etc/recpt directory contains entries for
|
|---|
| 37 | each server. By default, Greenstone comes with one Z39.50 server
|
|---|
| 38 | already configured, that of the United States' <b>Library of Congress</b>.
|
|---|
| 39 | <p>
|
|---|
| 40 | Each entry consists of:
|
|---|
| 41 | <ul>
|
|---|
| 42 | <li>A unique "short name" for internal use by Greenstone.</li>
|
|---|
| 43 | <li>The internet name or address of the server, and optionally the
|
|---|
| 44 | port that the server is running on if not the default port 210.</li>
|
|---|
| 45 | <li>The name of the database to search on that server.</li>
|
|---|
| 46 | <li>A string that provides a meaningful name for the "collection".</li>
|
|---|
| 47 | <li>An optional "About" string, providing some information about the database
|
|---|
| 48 | and/or server.</li>
|
|---|
| 49 | <li>Optional icon fields, which are displayed instead of the text on the
|
|---|
| 50 | front page.</li>
|
|---|
| 51 | </ul>
|
|---|
| 52 | The entries need only be separated by whitespace, but for the purposes of
|
|---|
| 53 | clarity the sample entry uses newlines and tabs.
|
|---|
| 54 | <p>
|
|---|
| 55 | The sample Library of Congress entry looks like this:
|
|---|
| 56 | <pre>
|
|---|
| 57 | LOC
|
|---|
| 58 | z3950.loc.gov:7090 Voyager
|
|---|
| 59 | "Library of Congress z39.50 server"
|
|---|
| 60 | About en "This is the z39.50 interface to the US LoC catalogue
|
|---|
| 61 | system. It contains approximately 12 million bibliographic records.
|
|---|
| 62 | For server capabilities, look at
|
|---|
| 63 | <a href=\"http://lcweb.loc.gov/z3950/lcserver.html\">their web pages</a>."
|
|---|
| 64 | </pre>
|
|---|
| 65 | See the file for another (commented out) example. There is a list at the
|
|---|
| 66 | Library Of Congress website containing some
|
|---|
| 67 | <a href="http://lcweb.loc.gov/z3950/agency/resources/testport.html">servers
|
|---|
| 68 | publicly available for testing</a>.
|
|---|
| 69 |
|
|---|
| 70 |
|
|---|
| 71 | <a name=todo>
|
|---|
| 72 | <h2>Known Problems/Issues and Todo list</h2>
|
|---|
| 73 | </a>
|
|---|
| 74 | Note - a more up-to-date list (and possibly even fixes...) may be available
|
|---|
| 75 | on the main website at <a href="http://www.nzdl.org/">www.nzdl.org</a>.
|
|---|
| 76 | <ul>
|
|---|
| 77 | <li>The query syntax is currently undergoing review.</li>
|
|---|
| 78 | <li>Because of the open nature of the standard, our client may not work with
|
|---|
| 79 | some servers. Please notify the author (contact details below) of any
|
|---|
| 80 | such problems.</li>
|
|---|
| 81 | <li>Because of the large number of Marc fields, only the most frequently
|
|---|
| 82 | used fields have been given explicit names in the results. </li>
|
|---|
| 83 | <li><b>The z39.50 client will not work when fast-cgi is used!</b>. Currently,
|
|---|
| 84 | the use of the fast-cgi package (off by default) will disable the
|
|---|
| 85 | use of the z39.50 client code for Greenstone.</li>
|
|---|
| 86 | <li>There are spurious <B> tags in the title of the window when
|
|---|
| 87 | viewing an individual record.</li>
|
|---|
| 88 | <li>Greenstone will claim there are no collections if there are no
|
|---|
| 89 | sub-directories in the "collect" directory, even if there are configured
|
|---|
| 90 | z39.50 servers, although it will work if there are unbuilt collections.</li>
|
|---|
| 91 | </ul>
|
|---|
| 92 |
|
|---|
| 93 | <b>History</b><br>
|
|---|
| 94 | Aug 2000 - Various bug fixes and minor modifications.<br>
|
|---|
| 95 | Fri Aug 4 2000 - The z39.50 code is now "stable" in the main source code (in CVS).<br>
|
|---|
| 96 | Tue 1 Aug 2000 - selecting a field from the drop-down box now actually works.
|
|---|
| 97 | This results in both quicker replies and more accurate results.<br>
|
|---|
| 98 | Mon 24 Jul 2000 - queries are now "AND"ed - for example, the query "computer
|
|---|
| 99 | science" will now only return records that contain both words.<br>
|
|---|
| 100 | May-June 2000 - Code written.<br>
|
|---|
| 101 |
|
|---|
| 102 | <a name=contact>
|
|---|
| 103 | <h2>Contact Details</h2>
|
|---|
| 104 | </a>
|
|---|
| 105 | For general comments about Greenstone, or suggestions for improvements, send
|
|---|
| 106 | email to
|
|---|
| 107 | <a href="mailto:[email protected]?subject=z39.50 client in Greenstone">[email protected]</a><br>
|
|---|
| 108 | <br>
|
|---|
| 109 | For bug reports or questions about the z39.50 code itself, send email to
|
|---|
| 110 | the author, John McPherson -
|
|---|
| 111 | <a href="mailto:[email protected]?subject=z39.50 client in Greenstone"
|
|---|
| 112 | >[email protected]</a>. (I am currently at the University of Waikato
|
|---|
| 113 | until June 2001)
|
|---|
| 114 |
|
|---|
| 115 | <p>
|
|---|
| 116 | <a href="#top">Back to top</a>
|
|---|
| 117 | <p>
|
|---|
| 118 | <address>Last modified: August 7, 2000 by John McPherson</address>
|
|---|
| 119 | </body>
|
|---|
| 120 | </html> |
|---|
