<listitem>
<para>
Supports
- <ulink url="&url.solr;">Solr</ulink> Web Service version 1.4.x
+ <ulink url="&url.solr;">Apache Solr</ulink> Web Service version 1.4.x
(client side only)
</para>
</listitem>
<title>Reading this Manual</title>
<para>
Most implementors only need to read a fraction of the
- material in thie manual, so a quick walkthrough of the chapters
+ material in this manual, so a quick walkthrough of the chapters
is in order.
</para>
<itemizedlist>
<listitem>
<para>
<xref linkend="installation"/> contains installation
- instructions for &yaz;. You don't need reading this
+ instructions for &yaz;. You don't need to read this
if you expect to download &yaz; binaries.
However, the chapter contains information about how
to make <emphasis>your</emphasis> application link
<listitem>
<para>
<xref linkend="zoom"/> describes the ZOOM API of &yaz;.
- This is definitely worth a read if you wish to develop a Z39.50/SRU
+ This is definitely worth reading if you wish to develop a Z39.50/SRU
client.
</para>
</listitem>
<listitem>
<para>
<xref linkend="yaz-client"/> describes how to use the &yaz; Z39.50
- client. If you're developer and wish to test your server
+ client. If you're a developer and wish to test your server
or a server from another party, you might find this chapter
useful.
</para>
<xref linkend="odr"/> goes through the details of the
ODR module which is the work horse that encodes and decodes
BER packages. Implementors using ZOOM only, do <emphasis>not</emphasis>
- need reading this.
+ need to read this.
Most other Z39.50 implementors only need to read the first two
sections (<xref linkend="odr.introduction"/> and
<xref linkend="odr.use"/>).
level APIs of &yaz;.
</para>
<para>
- The YAZ toolkit modules is shown in figure <xref linkend="yaz.layer"/>.
+ The YAZ toolkit modules are shown in figure <xref linkend="yaz.layer"/>.
</para>
<figure id="yaz.layer">
<title>YAZ layers</title>
<note>
<para>
If you are using the premade definitions of the &asn; module, and you
- are not adding new protocol of your own, the only parts of &odr; that you
+ are not adding a new protocol of your own, the only parts of &odr; that you
need to worry about are documented in
<xref linkend="odr.use"/>.
</para>
<ulink url="&url.automake;">Automake</ulink> and
<ulink url="&url.libtool;">Libtool</ulink>
are used to generate Makefiles and configure &yaz; for the system.
- You do <emphasis>not</emphasis> these tools unless you're using the
+ You do <emphasis>not</emphasis> need these tools unless you're using the
Git version of &yaz;.
</para>
<para>
&yaz; includes a tiny ASN.1 compiler. This compiler is
written in <ulink url="&url.tcl;">Tcl</ulink>.
But as for Bison you do not need it unless you're using Git
- version of &yaz; or you're using the compiler to built own codecs
+ version of &yaz; or you're using the compiler to build your own codecs
for private ASN.1.
</para>
<para>
<replaceable>prefix</replaceable>. By default configure will
search for iconv on the system. Use this option if it
doesn't find iconv. Alternatively,
- <literal>--without-iconv</literal>, can be uset to force &yaz;
+ <literal>--without-iconv</literal>, can be used to force &yaz;
not to use iconv.
</para>
</listitem>
<replaceable>prefix</replaceable>.
Use this option if you want XSLT and XML support.
By default, configure will
- search for libxslt on the system. Use this option if it
+ search for libxslt on the system. Use this option if
libxslt is not found automatically. Alternatively,
<literal>--without-xslt</literal>, can be used to force &yaz;
not to use libxslt.
<replaceable>prefix</replaceable>.
Use this option if you want &yaz; to use XML and support SRU/Solr.
By default, configure will
- search for libxml2 on the system. Use this option if it
+ search for libxml2 on the system. Use this option if
libxml2 is not found automatically. Alternatively,
<literal>--without-xml2</literal>, can be used to force &yaz;
not to use libxml2.
This section describes how to compile - and link your own
applications using the &yaz; toolkit.
If you're used to Makefiles this shouldn't be hard. As for
- other libraries you have used before, you have to set a proper include
+ other libraries you have used before, you need to set a proper include
path for your C/C++ compiler and specify the location of
&yaz; libraries. You can do it by hand, but generally we suggest
you use the <filename>yaz-config</filename> that is generated
</sect2>
</sect1>
<sect1 id="installation.win32">
- <title>WIN32</title>
+ <title>Windows</title>
<para>The easiest way to install YAZ on Windows is by downloading
an installer from
<ulink url="&url.yaz.download.win32;">here</ulink>.
</para>
<sect2 id="installation.win32.source">
- <title>Compiling from Source on WIN32</title>
+ <title>Compiling from Source on Windows</title>
<para>
&yaz; is shipped with "makefiles" for the NMAKE tool that comes
with <ulink url="&url.vstudio;">
Microsoft Visual Studio</ulink>. It has been tested with
- Microsoft Visual Studio 2003/2005/2008.
+ Microsoft Visual Studio 2013.
</para>
<para>
Start a command prompt and switch the sub directory
If <literal>HAVE_LIBXML2</literal> is set to 1, YAZ is compiled
with SRU support. In this configuration, set
<literal>LIBXML2_DIR</literal> to the
- <ulink url="&url.libxml2;">libxml2</ulink> source directory
- and
- <literal>ZLIB_DIR</literal> to the zlib directory.
- </para>
- <para>
- Windows versions of libxslt, libxml2, zlib and iconv can be found
- <ulink url="&url.libxml2.download.win32;">
- Igor Zlatković' site</ulink>.
- </para>
- <note>
- <para>
- YAZ is not using zlib but libxml2 is depending on it.
- </para>
- </note>
+ <ulink url="&url.libxml2;">libxml2</ulink> source directory.
+ </para>
+ <para>
+ You can get pre-compiled Libxml2+Libxslt DLLs and headers from
+ <ulink url="&url.libxml2.download.windows;">here</ulink>.
+ Should you with to compile those libraries yourself, refer to
+ to <xref linkend="installation.windows.libxml2"/>
+ </para>
</listitem>
</varlistentry>
<varlistentry>
</para>
<note>
<para>
- libxslt depends libxml2.
+ libxslt depends on libxml2.
</para>
</note>
</listitem>
<term><filename>bin/yaz-icu.exe</filename></term>
<listitem><para>This program exposes the ICU wrapper library if that
is enabled for YAZ. Only if ICU is available this program is
- build.
+ built.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>bin/zoomtst1.exe</filename>,
<filename>bin/zoomtst2.exe</filename>, ..</term>
<listitem><para>
- Several small applications that demonstrates the ZOOM API.
+ Several small applications that demonstrate the ZOOM API.
</para></listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 id="installation-linking-yaz-win32">
- <title>How to make apps using YAZ on WIN32</title>
+ <title>How to make apps using YAZ on Windows</title>
<para>
- This section will go though the process of linking your WIN32
+ This section will go though the process of linking your Windows
applications with &yaz;.
</para>
<para>
Some people are confused by the fact that we use the nmake
tool to build &yaz;. They think they have to do that too - in order
- to make their WIN32 applications work with &yaz;. The good news is that
+ to make their Windows applications work with &yaz;. The good news is that
you don't have to. You can use the integrated environment of
Visual Studio if desired for your own application.
</para>
</variablelist>
</para>
</sect2>
+
+ <sect2 id="installation.windows.libxml2">
+ <title>Compiling Libxml2 and Libxslt on windows</title>
+ <para>
+ Download libxml2 and Libxslt source and unpack it.
+ In the example below we install Libxml2 2.9.2 and Libxslt 1.1.28
+ for 32-bit, so we use the destination directories
+ libxml2.2.9.2.win32 and libxslt-1.1.28.win32 to reflect both
+ version and architecture.
+ <screen>
+ cd win32
+ cscript configure.js prefix=c:\libxml2-2.9.2.win32 iconv=no
+ nmake
+ nmake install
+ </screen>
+ </para>
+ <note>
+ <para>
+ There's an error in <filename>configure.js</filename> for Libxml2 2.9.2.
+ Line 17 should be assigned to <filename>configure.ac</filename>
+ rather than <filename>configure.in</filename>.
+ </para>
+ </note>
+ <para>
+ For Libxslt it is similar. We must ensure that compilation of
+ Libxslt links against the already installed libxml2.
+ <screen>
+ cd win32
+ cscript configure.js prefix=c:\libxslt-1.1.28.win32 iconv=no \
+ lib=c:\libxml2-2.9.2.win32\lib \
+ include=c:\libxml2-2.9.2.win32\include\libxml2
+ nmake
+ nmake install
+ </screen>
+ </para>
+ </sect2>
+
</sect1>
</chapter>
<!--
and more apparent over time. So when the first &zoom; specification
became available,
an implementation for &yaz; was quickly developed. For the first time, it is
- now as easy (or easier!) to develop clients than servers with &yaz;. This
+ now as easy (or easier!) to develop clients as it is to develop
+ servers with &yaz;. This
chapter describes the &zoom; C binding. Before going further, please
reconsider whether C is the right programming language for the job.
There are other language bindings available for &yaz;, and still
The C language misses features found in object oriented languages
such as C++, Java, etc. For example, you'll have to manually,
destroy all objects you create, even though you may think of them as
- temporary. Most objects has a <literal>_create</literal> - and a
+ temporary. Most objects have a <literal>_create</literal> - and a
<literal>_destroy</literal> variant.
All objects are in fact pointers to internal stuff, but you don't see
that because of typedefs. All destroy methods should gracefully ignore a
You can prefix the host with a scheme followed by colon. The
default scheme is <literal>tcp</literal> (Z39.50 protocol).
The scheme <literal>http</literal> selects SRU/get over HTTP by default,
- but can overridded to use SRU/post, SRW and the Solr protocol.
+ but can overridden to use SRU/post, SRW, and the Solr protocol.
</para>
<para>
You can prefix the scheme-qualified host-string with one or more
clientIP</entry><entry>Client IP. If set, is
encoded in the otherInfo area of a Z39.50 PDU with OID
1.2.840.10003.10.1000.81.3. Holds the original IP addreses
- of a client. Is used of ZOOM is used in a gateway of some sort.
+ of a client. Is used if ZOOM is used in a gateway of some sort.
</entry><entry>none</entry></row>
<row><entry>
async</entry><entry>If true (1) the connection operates in
</entry><entry>none</entry></row>
<row><entry>
databaseName</entry><entry>One or more database names
- separated by character plus (<literal>+</literal>), which to
+ separated by character plus (<literal>+</literal>), which is to
be used by subsequent search requests on this Connection.
</entry><entry>Default</entry></row>
<row><entry>
</entry><entry>1</entry></row>
<row><entry>
mediumSetPresentNumber</entry><entry>This value represents
- the number of records to be returned as part of a search when when
+ the number of records to be returned as part of a search when
hits is less than or equal to large set lower bound and if hits
is greater than small set upper bound.
</entry><entry>0</entry></row>
</entry><entry>none</entry></row>
<row><entry>
mediumSetElementSetName</entry><entry>
- The element set name to be for medium-sized result sets.
+ The element set name to be used for medium-sized result sets.
</entry><entry>none</entry></row>
<row><entry>
init_opt_search, init_opt_present, init_opt_delSet, etc.</entry><entry>
<row><entry>
sru_version</entry><entry>
SRU/SRW version. Should be <literal>1.1</literal>, or
- <literal>1.2</literal>. This is , prior to connect, the version
+ <literal>1.2</literal>. This is, prior to connect, the version
to offer (highest version). And following connect (in fact
first operation), holds the negotiated version with the server
(same or lower version).
</entry><entry>1.2</entry></row>
+ <row id="zoom.extraArgs.option"><entry>
+ extraArgs</entry><entry>
+ Extra arguments for SRU/Solr URLs. The value must be
+ URL encoded already.
+ </entry><entry></entry></row>
<row id="zoom.facets.option"><entry>
facets</entry><entry>
- Requested or recommend facets may be given before a search is sent.
+ Requested or recommended facets may be given before a search is sent.
The value of this setting is described in <xref linkend="facets"/>
For inspection of the facets returned, refer to the functions
described in <xref linkend="zoom.facets"/>.
redis support is available for YAZ 5.2.0 or later. If this
option is supplied for an earlier version of YAZ, it is
<emphasis>ignored</emphasis>.
- The value of this option is a set options, similar to that
+ The value of this option is a set of options, similar to that
of the memcached setting. At this stage only --server=host[:port]
- and --expire=seconds is supported.
+ and --expire=seconds are supported.
</entry><entry>none</entry></row>
</tbody>
</tgroup>
The calls <function>ZOOM_connection_new</function> and
<function>ZOOM_connection_connect</function> establishes a TCP/IP
connection and sends an Initialize Request to the target if
- possible. In addition, the calls waits for an Initialize Response
+ possible. In addition, the calls wait for an Initialize Response
from the target and the result is inspected (OK or rejected).
</para>
<para>
<sect2 id="zoom.sru.init.behavior">
<title>SRU/Solr Protocol behavior</title>
<para>
- The HTTP based protocols (SRU, SRW, Solr) doesn't feature an
+ The HTTP based protocols (SRU, SRW, Solr) do not feature an
Inititialize Request, so the connection phase merely establishes a
TCP/IP connection with the HTTP server.
</para>
<function>ZOOM_query_sortby2</function> is similar to
<function>ZOOM_query_sortby</function> but allows a strategy for
sorting. The reason for the strategy parameter is that some
- protocols offers multiple ways of performing sorting.
+ protocols offer multiple ways of performing sorting.
For example, Z39.50 has the standard sort, which is performed after
search on an existing result set.
It's also possible to use CQL in Z39.50 as the query type and use
</synopsis>
<para>
Function <function>ZOOM_connection_search</function> creates
- a result set given a connection and query.
+ a result set, given a connection and query.
Destroy a result set by calling
<function>ZOOM_resultset_destroy</function>.
- Simple clients may using PQF only may use function
+ Simple clients using PQF only, may use the function
<function>ZOOM_connection_search_pqf</function> in which case
creating query objects is not necessary.
</para>
and <function>ZOOM_connection_option_set</function>.
</para>
<para>
- The number of hits also called result-count is returned by
+ The number of hits, also called result-count, is returned by
function <function>ZOOM_resultset_size</function>.
</para>
<table id="zoom.resultset.options"
<row>
<entry>searchresult.size</entry>
<entry>
- number of search result entries. This option is-nonexistant
+ number of search result entries. This option is non-existent
if no entries are returned by the server.
</entry>
</row>
<para>
<function>ZOOM_resultset_sort</function> and
<function>ZOOM_resultset_sort1</function> both sort an existing
- result-set. The sort_type parameter is not use. Set it to "yaz".
+ result-set. The sort_type parameter is not used. Set it to "yaz".
The sort_spec is same notation as ZOOM_query_sortby and identical
to that offered by yaz-client's
<link linkend="sortspec">sort command</link>.
The high-level mode allows you to fetch a range of records from
the result set with a given start offset. When you use this mode
the client will automatically use piggyback if that is possible
- with the target and perform one or more present requests as needed.
+ with the target, and perform one or more present requests as needed.
Even if the target returns fewer records as part of a present response
because of a record size limit, etc. the client will repeat sending
present requests. As an example, if option <literal>start</literal>
<para>
Current version of &yaz; does not take advantage of a result set id
returned by the SRU server. Future versions might do, however.
- Since, the ZOOM driver does not save result set IDs any
+ Since the ZOOM driver does not save result set IDs, any
present (retrieval) is transformed to a SRU SearchRetrieveRequest
with same query but, possibly, different offsets.
</para>
SRU SearchRetrieveRequest.
</para>
<para>
- Solr queries has to be done in Solr query format.
+ Solr queries need to be done in Solr query format.
</para>
<para>
- Unfortunately, SRU or Solr does not define a database setting. Hence,
+ Unfortunately, SRU and Solr do not define a database setting. Hence,
<literal>databaseName</literal> is unsupported and ignored.
However, the path part in host parameter for functions
<function>ZOOM_connecton_new</function> and
Function <function>ZOOM_resultset_records</function> retrieves
a number of records from a result set. Parameter <literal>start</literal>
and <literal>count</literal> specifies the range of records to
- be returned. Upon completion array
+ be returned. Upon completion, the array
<literal>recs[0], ..recs[count-1]</literal>
holds record objects for the records. The array of records
<literal>recs</literal> should be allocated prior the call
<function>ZOOM_resultset_records</function>. Note that for those
- records that couldn't be retrieved from the target
+ records that couldn't be retrieved from the target,
<literal>recs[ ..]</literal> is set to <literal>NULL</literal>.
</para>
<para id="zoom.record.get">
The <parameter>type</parameter> is a string of the format:
</para>
<para>
- <replaceable>format</replaceable>[;charset=<replaceable>from</replaceable>[/<replaceable>opacfrom</replaceable>][,<replaceable>to</replaceable>]][;format=<replaceable>v</replaceable>]
+ <replaceable>format</replaceable>[;charset=<replaceable>from</replaceable>[/<replaceable>opacfrom</replaceable>][,<replaceable>to</replaceable>]][;format=<replaceable>v</replaceable>][;base64=<replaceable>xpath</replaceable>]
</para>
<para>
- where <replaceable>format</replaceable> specifies the format of the
- returned record, <replaceable>from</replaceable>
+ If <literal>charset</literal> is given, then <replaceable>from</replaceable>
specifies the character set of the record in its original form
(as returned by the server), <replaceable>to</replaceable> specifies
- the output (returned)
- character set encoding.
- If <replaceable>to</replaceable> is omitted UTF-8 is assumed.
+ the output (returned) character set encoding.
+ If <replaceable>to</replaceable> is omitted, then UTF-8 is assumed.
If charset is not given, then no character set conversion takes place.
- </para>
-
- <para>OPAC records may be returned in a different
- set from the bibliographic MARC record. If this is this the case,
+ OPAC records may be returned in a different
+ set from the bibliographic MARC record. If this is this the case,
<replaceable>opacfrom</replaceable> should be set to the character set
of the OPAC record part.
</para>
+
+ <para>
+ The <literal>format</literal> is generic but can only be used to
+ specify XML indentation when the value <replaceable>v</replaceable>
+ is 1 (<literal>format=1</literal>).
+ </para>
+ <para>
+ The <literal>base64</literal> allows a full record to be extracted
+ from base64-encoded string in an XML document.
+ </para>
<note>
<para>
Specifying the OPAC record character set requires YAZ 4.1.5 or later.
</para>
+ <para>
+ Specifying the base64 parameter requires YAZ 4.2.35 or later.
+ </para>
</note>
<para>
The format argument controls whether record data should be XML
The following are the supported values for <replaceable>form</replaceable>.
<variablelist>
<varlistentry><term><literal>database</literal></term>
- <listitem><para>Database of record is returned
+ <listitem><para>The Database of the record is returned
as a C null-terminated string. Return type
<literal>const char *</literal>.
</para></listitem>
</varlistentry>
<varlistentry><term><literal>render</literal></term>
<listitem><para>The record is returned in a display friendly
- format. Upon completion buffer is returned
+ format. Upon completion, buffer is returned
(type <literal>const char *</literal>) and length is stored in
<literal>*len</literal>.
</para></listitem>
Present.
The functions may block (and perform network I/O) - even though option
<literal>async</literal> is 1, because they return records objects.
- (and there's no way to return records objects without retrieving them!).
+ (And there's no way to return records objects without retrieving them!)
</para>
<para>
There is a trick, however, in the usage of function
An array of facets field can be returned by
<function>ZOOM_resultset_facets</function>. The length of the array is
given by <function>ZOOM_resultset_facets_size</function>. The array is
- zero-based and last entry will be at
+ zero-based and the last entry will be at
<function>ZOOM_resultset_facets_size(result_set)</function>-1.
</para>
<para id="zoom.resultset.facets_names">
It is possible to interate over facets by name, by calling
<function>ZOOM_resultset_facets_names</function>.
- This will return an const array of char * where each string can be used
+ This will return a const array of char * where each string can be used
as parameter for <function>ZOOM_resultset_get_facet_field</function>.
</para>
<para>
<parameter>startpqf</parameter>.
If the operation was successful, the size of the scan set can be
retrieved by a call to <function>ZOOM_scanset_size</function>.
- Like result sets, the items are numbered 0,..size-1.
+ Like result sets, the items are numbered 0..size-1.
To obtain information about a particular scan term, call function
<function>ZOOM_scanset_term</function>. This function takes
a scan set offset <literal>pos</literal> and returns a pointer
<!-- all the ILL PDU options should go here too -->
</itemizedlist>
<para>
- To create an extended service operation a <literal>ZOOM_package</literal>
+ To create an extended service operation, a <literal>ZOOM_package</literal>
must be created. The operation is a five step operation. The
package is created, package is configured by means of options,
- the package is send, result is inspected (by means of options),
+ the package is sent, result is inspected (by means of options),
the package is destroyed.
</para>
<synopsis>
The <parameter>type</parameter> specifies the actual extended service
package type to be sent.
</para>
+ <table frame="top" id="zoom.extendedservices.type">
+ <title>Extended Service Type</title>
+ <tgroup cols="2">
+ <colspec colwidth="3*" colname="value"></colspec>
+ <colspec colwidth="7*" colname="description"></colspec>
+ <thead>
+ <row>
+ <entry>Type</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>itemorder</entry><entry>Item Order</entry>
+ </row>
+ <row>
+ <entry>update</entry><entry>Record Update</entry>
+ </row>
+ <row>
+ <entry>create</entry><entry>Database Create</entry>
+ </row>
+ <row>
+ <entry>drop</entry><entry>Database Drop</entry>
+ </row>
+ <row>
+ <entry>commit</entry><entry>Commit Operation</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
<table frame="top" id="zoom.extendedservices.options">
<title>Extended Service Common Options</title>
<tgroup cols="3">
<row>
<entry>package-name</entry>
<entry>Extended Service Request package name. Must be specified
- as part of a request</entry>
+ as part of a request.</entry>
<entry>none</entry>
</row>
<row>
<entry>user-id</entry>
- <entry>User ID of Extended Service Package. Is a request option</entry>
+ <entry>User ID of Extended Service Package. Is a request option.</entry>
<entry>none</entry>
</row>
<row>
<sect2 id="zoom.item.order">
<title>Item Order</title>
<para>
- For Item Order, type must be set to <literal>itemorder</literal> in
+ For Item Order, <literal>type</literal> must be set to
+ <literal>itemorder</literal> in
<function>ZOOM_package_send</function>.
</para>
<entry>none</entry>
</row>
<row>
+ <entry>itemorder-setname</entry>
+ <entry>Name of result set for record</entry>
+ <entry>default</entry>
+ </row>
+ <row>
<entry>itemorder-item</entry>
<entry>Position for item (record) requested. An integer</entry>
<entry>1</entry>
</tbody>
</tgroup>
</table>
+ <para>
+ There are two variants of item order: ILL-variant and
+ XML document variant. In order to use the XML variant the setting
+ <literal>doc</literal> must hold the XML item order document. If that
+ setting is unset, the ILL-variant is used.
+ </para>
+
+ <table frame="top" id="zoom.illrequest.options">
+ <title>ILL Request Options</title>
+ <tgroup cols="1">
+ <colspec colwidth="4*" colname="name"></colspec>
+ <thead>
+ <row>
+ <entry>Option</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row><entry>protocol-version-num</entry></row>
+ <row><entry>transaction-id,initial-requester-id,person-or-institution-symbol,person</entry></row>
+ <row><entry>transaction-id,initial-requester-id,person-or-institution-symbol,institution</entry></row>
+ <row><entry>transaction-id,initial-requester-id,name-of-person-or-institution,name-of-person</entry></row>
+ <row><entry>transaction-id,initial-requester-id,name-of-person-or-institution,name-of-institution</entry></row>
+ <row><entry>transaction-id,transaction-group-qualifier</entry></row>
+ <row><entry>transaction-id,transaction-qualifier</entry></row>
+ <row><entry>transaction-id,sub-transaction-qualifier</entry></row>
+ <row><entry>service-date-time,this,date</entry></row>
+ <row><entry>service-date-time,this,time</entry></row>
+ <row><entry>service-date-time,original,date</entry></row>
+ <row><entry>service-date-time,original,time</entry></row>
+ <row><entry>requester-id,person-or-institution-symbol,person</entry></row>
+ <row><entry>requester-id,person-or-institution-symbol,institution</entry></row>
+ <row><entry>requester-id,name-of-person-or-institution,name-of-person</entry></row>
+ <row><entry>requester-id,name-of-person-or-institution,name-of-institution</entry></row>
+ <row><entry>responder-id,person-or-institution-symbol,person</entry></row>
+ <row><entry>responder-id,person-or-institution-symbol,institution</entry></row>
+ <row><entry>responder-id,name-of-person-or-institution,name-of-person</entry></row>
+ <row><entry>responder-id,name-of-person-or-institution,name-of-institution</entry></row>
+ <row><entry>transaction-type</entry></row>
+ <row><entry>delivery-address,postal-address,name-of-person-or-institution,name-of-person</entry></row>
+ <row><entry>delivery-address,postal-address,name-of-person-or-institution,name-of-institution</entry></row>
+ <row><entry>delivery-address,postal-address,extended-postal-delivery-address</entry></row>
+ <row><entry>delivery-address,postal-address,street-and-number</entry></row>
+ <row><entry>delivery-address,postal-address,post-office-box</entry></row>
+ <row><entry>delivery-address,postal-address,city</entry></row>
+ <row><entry>delivery-address,postal-address,region</entry></row>
+ <row><entry>delivery-address,postal-address,country</entry></row>
+ <row><entry>delivery-address,postal-address,postal-code</entry></row>
+ <row><entry>delivery-address,electronic-address,telecom-service-identifier</entry></row>
+ <row><entry>delivery-address,electronic-address,telecom-service-addreess</entry></row>
+ <row><entry>billing-address,postal-address,name-of-person-or-institution,name-of-person</entry></row>
+ <row><entry>billing-address,postal-address,name-of-person-or-institution,name-of-institution</entry></row>
+ <row><entry>billing-address,postal-address,extended-postal-delivery-address</entry></row>
+ <row><entry>billing-address,postal-address,street-and-number</entry></row>
+ <row><entry>billing-address,postal-address,post-office-box</entry></row>
+ <row><entry>billing-address,postal-address,city</entry></row>
+ <row><entry>billing-address,postal-address,region</entry></row>
+ <row><entry>billing-address,postal-address,country</entry></row>
+ <row><entry>billing-address,postal-address,postal-code</entry></row>
+ <row><entry>billing-address,electronic-address,telecom-service-identifier</entry></row>
+ <row><entry>billing-address,electronic-address,telecom-service-addreess</entry></row>
+ <row><entry>ill-service-type</entry></row>
+ <row><entry>requester-optional-messages,can-send-RECEIVED</entry></row>
+ <row><entry>requester-optional-messages,can-send-RETURNED</entry></row>
+ <row><entry>requester-optional-messages,requester-SHIPPED</entry></row>
+ <row><entry>requester-optional-messages,requester-CHECKED-IN</entry></row>
+ <row><entry>search-type,level-of-service</entry></row>
+ <row><entry>search-type,need-before-date</entry></row>
+ <row><entry>search-type,expiry-date</entry></row>
+ <row><entry>search-type,expiry-flag</entry></row>
+ <row><entry>place-on-hold</entry></row>
+ <row><entry>client-id,client-name</entry></row>
+ <row><entry>client-id,client-status</entry></row>
+ <row><entry>client-id,client-identifier</entry></row>
+ <row><entry>item-id,item-type</entry></row>
+ <row><entry>item-id,call-number</entry></row>
+ <row><entry>item-id,author</entry></row>
+ <row><entry>item-id,title</entry></row>
+ <row><entry>item-id,sub-title</entry></row>
+ <row><entry>item-id,sponsoring-body</entry></row>
+ <row><entry>item-id,place-of-publication</entry></row>
+ <row><entry>item-id,publisher</entry></row>
+ <row><entry>item-id,series-title-number</entry></row>
+ <row><entry>item-id,volume-issue</entry></row>
+ <row><entry>item-id,edition</entry></row>
+ <row><entry>item-id,publication-date</entry></row>
+ <row><entry>item-id,publication-date-of-component</entry></row>
+ <row><entry>item-id,author-of-article</entry></row>
+ <row><entry>item-id,title-of-article</entry></row>
+ <row><entry>item-id,pagination</entry></row>
+ <row><entry>item-id,ISBN</entry></row>
+ <row><entry>item-id,ISSN</entry></row>
+ <row><entry>item-id,additional-no-letters</entry></row>
+ <row><entry>item-id,verification-reference-source</entry></row>
+ <row><entry>copyright-complicance</entry></row>
+ <row><entry>retry-flag</entry></row>
+ <row><entry>forward-flag</entry></row>
+ <row><entry>requester-note</entry></row>
+ <row><entry>forward-note</entry></row>
+ </tbody>
+ </tgroup>
+ </table>
</sect2>
<sect2 id="zoom.record.update">
<title>Record Update</title>
<para>
- For Record Update, type must be set to <literal>update</literal> in
+ For Record Update, <literal>type</literal> must be set to
+ <literal>update</literal> in
<function>ZOOM_package_send</function>.
</para>
<table frame="top" id="zoom.record.update.options">
Option <literal>recordOpaque</literal> is an alternative
to record - and <literal>record</literal> option (above) is
ignored if recordOpaque is set. This option is only available in
- YAZ 3.0.35 and later and is meant to facilitate Updates with
+ YAZ 3.0.35 and later, and is meant to facilitate Updates with
servers from OCLC.
</entry>
<entry>none</entry>
<sect2 id="zoom.database.create"><title>Database Create</title>
<para>
- For Database Create, type must be set to <literal>create</literal> in
+ For Database Create, <literal>type</literal> must be set to
+ <literal>create</literal> in
<function>ZOOM_package_send</function>.
</para>
<sect2 id="zoom.database.drop">
<title>Database Drop</title>
<para>
- For Database Drop, type must be set to <literal>drop</literal> in
+ For Database Drop, <literal>type</literal> must be set to
+ <literal>drop</literal> in
<function>ZOOM_package_send</function>.
</para>
<table frame="top" id="zoom.database.drop.options">
<sect2 id="zoom.commit">
<title>Commit Operation</title>
<para>
- For Commit, type must be set to <literal>commit</literal> in
+ For Commit, <literal>type</literal> must be set to
+ <literal>commit</literal> in
<function>ZOOM_package_send</function>.
</para>
</sect2>
</para>
<note>
<para>
- The database create, drop and commit services are privately defined
+ The database create, drop, and commit services are privately defined
operations.
Refer to <filename>esadmin.asn</filename> in YAZ for the ASN.1
definitions.
<title>Options</title>
<para>
Most &zoom; objects provide a way to specify options to change behavior.
- From an implementation point of view a set of options is just like
+ From an implementation point of view, a set of options is just like
an associative array / hash.
</para>
<synopsis>
<para>
<function>ZOOM_query_cql2rpn</function> translates the CQL string,
client-side, into RPN which may be passed to the server.
- This is useful for server's that don't themselves
+ This is useful for servers that don't themselves
support CQL, for which <function>ZOOM_query_cql</function> is useless.
`conn' is used only as a place to stash diagnostics if compilation
fails; if this information is not needed, a null pointer may be used.
The CQL conversion is driven by option <literal>cqlfile</literal> from
- connection conn. This specifies a conversion file (eg pqf.properties)
+ connection conn. This specifies a conversion file (e.g. pqf.properties)
which <emphasis>must</emphasis> be present.
</para>
<para>
client-side, into RPN which may be passed to the server.
The conversion is driven by the specification given by
<literal>config</literal>. Upon completion 0 is returned on success; -1
- is returned on on failure. Om failure <literal>error_string</literal> and
- <literal>error_pos</literal> holds error message and position of
+ is returned on failure. On failure <literal>error_string</literal> and
+ <literal>error_pos</literal> hold the error message and position of
first error in original CCL string.
</para>
</sect1>
a number of connections. Supply the number of connections in
<literal>no</literal> and an array of connections in
<literal>cs</literal> (<literal>cs[0] ... cs[no-1]</literal>).
- A pending event could be a sending a search, receiving a response,
+ A pending event could be sending a search, receiving a response,
etc.
When an event has occurred for one of the connections, this function
returns a positive integer <literal>n</literal> denoting that an event
occurred for connection <literal>cs[n-1]</literal>.
When no events are pending for the connections, a value of zero is
returned.
- To ensure that all outstanding requests are performed call this function
+ To ensure that all outstanding requests are performed, call this function
repeatedly until zero is returned.
</para>
<para>
- If <function>ZOOM_event</function> returns and returns non-zero, the
+ If <function>ZOOM_event</function> returns, and returns non-zero, the
last event that occurred can be expected.
</para>
<synopsis>
</row>
<row>
<entry>ZOOM_EVENT_RECV_DATA</entry>
- <entry>Data has been received)</entry>
+ <entry>Data has been received</entry>
</row>
<row>
<entry>ZOOM_EVENT_TIMEOUT</entry>
</row>
<row>
<entry>ZOOM_EVENT_RECV_SEARCH</entry>
- <entry>A search result been received</entry>
+ <entry>A search result has been received</entry>
</row>
</tbody>
</tgroup>
in YAZ 4.2.38.
</entry>
</row>
+ <row><entry><literal>s=sl</literal></entry>
+ <entry>
+ Tokens are split into sub-phrases of all combinations - in order.
+ This facility appeared in YAZ 5.14.0.
+ </entry>
+ </row>
<row><entry><literal>r=o</literal></entry>
<entry>
Allows ranges and the operators greather-than, less-than, ...
</listitem>
</varlistentry>
<varlistentry>
- <term><literal>xslt</literal></term>
+ <term><literal>select</literal></term>
<listitem>
<para>
- The <literal>xslt</literal> element specifies a conversion
- via &acro.xslt;. The following attributes may be specified:
+ The <literal>select</literal> selects one or more text nodes
+ and decodes them as XML.
+ The following attributes may be specified:
<variablelist>
- <varlistentry><term><literal>stylesheet</literal> (REQUIRED)</term>
+ <varlistentry><term><literal>path</literal> (REQUIRED)</term>
<listitem>
<para>
- Stylesheet file.
+ X-Path expression for selecting text nodes.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
+ <para>
+ This conversion is available in YAZ 5.8.0 and later.
+ </para>
</listitem>
</varlistentry>
<varlistentry>
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><literal>xslt</literal></term>
+ <listitem>
+ <para>
+ The <literal>xslt</literal> element specifies a conversion
+ via &acro.xslt;. The following attributes may be specified:
+ <variablelist>
+ <varlistentry><term><literal>stylesheet</literal> (REQUIRED)</term>
+ <listitem>
+ <para>
+ Stylesheet file.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</para>
</sect2>
projects / yaz-moved-to-github.git / blobdiff