for result-set caching for ZOOM.
The prefix can not be given. Note that YAZ will only search
for libMemcached if Libgcrypt is also enabled.
+ Note that 0.40 of libmemcached is required.
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>
+ <literal>--with-redis</literal>
+ </term>
+ <listitem>
+ <para>&yaz; will be linked with the hiredis C library
+ to allow for result-set caching for ZOOM on a
+ <ulink url="&url.redis;">redis</ulink> server.
+ The prefix can not be given. Note that YAZ will only search
+ for hiredis if Libgcrypt is also enabled.
+ </para>
+ </listitem>
+ </varlistentry>
+
</variablelist>
</para>
<para>
</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>
</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>
+ <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:\libxmlt-2.9.2.win32\lib \
+ include=c:\libxmlt-2.9.2.win32\include\libxml2
+ nmake
+ nmake install
+ </screen>
+ </para>
+ </sect2>
+
</sect1>
</chapter>
<!--
If given and non-empty,
<ulink url="&url.libmemcached;">libMemcached</ulink>
will be configured for the connection.
- This option is inspected by ZOOM when a connection is established.
+ This option is inspected by ZOOM when a connection is established.
If the <literal>memcached</literal> option is given
and YAZ is compiled without libMemcached support, an internal
diagnostic (10018) will be thrown.
libMemcached support is available for YAZ 5.0.13 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 string passed verbatim to
- the <function>memcached</function> function part of libMemcached.
- Refer to man page
- <ulink url="http://manned.org/memcached.3">memcached(3)</ulink>.
- Earlier versions of libMemcached
- do not offer this function. In this case only the option
- <literal>--server=</literal><replaceable>host</replaceable> may
- be given (YAZ emulates that part of libMemcached).
+ The value of this option is a list options - each is of the
+ form <literal>--name=value</literal>.
+ Option <literal>--server=</literal>host[:port] specifies a memcached
+ server. It may be repeated for multiple memcached servers.
+ Option <literal>--expire=</literal>seconds sets expiry time in seconds
+ for how long result sets are to be cached.
+ </entry><entry>none</entry></row>
+ <row><entry>
+ redis</entry><entry>
+ If given and non-empty,
+ a <ulink url="&url.redis;">redis</ulink> context will be created
+ for the connection.
+ This option is inspected by ZOOM when a connection is established.
+ If the <literal>redis</literal> option is given
+ and YAZ is compiled without redis support, an internal
+ diagnostic (10018) will be thrown.
+ 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
+ of the memcached setting. At this stage only --server=host[:port]
+ and --expire=seconds is supported.
</entry><entry>none</entry></row>
</tbody>
</tgroup>
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
</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