<chapter id="installation">
- <!-- $Id: installation.xml,v 1.10 2006-04-13 00:10:19 adam Exp $ -->
+ <!-- $Id: installation.xml,v 1.11 2006-04-26 12:17:23 adam Exp $ -->
<title>Installation</title>
<para>
You need a C++ compiler to compile and use YAZ proxy.
The software was implemented using
- <ulink url="http://gcc.gnu.org/">GCC</ulink> so we know that works
+ <ulink url="&url.gcc;">GCC</ulink> so we know that works
well with YAZ proxy. From time to time the software has been
compiled on Windows using Visual C++. Other compilers should
work too. Let us know of portability problems, etc. with
</para>
<para>
YAZ proxy is built on top of the
- <ulink url="http://indexdata.dk/yaz/">YAZ</ulink> and
- <ulink url="http://indexdata.dk/yazplusplus/">YAZ++</ulink>
+ <ulink url="&url.yaz;">YAZ</ulink> and
+ <ulink url="&url.yazplusplus;">YAZ++</ulink>
toolkits.
You need to install these first.
For some platforms there are binary packages available for YAZ/YAZ++.
</para>
<para>
We also highly recommend that
- <ulink url="http://xmlsoft.org/">libxml2</ulink> and
- <ulink url="http://xmlsoft.org/XSLT/">libXSLT</ulink> are installed.
+ <ulink url="&url.libxml2;">libxml2</ulink> and
+ <ulink url="&url.libxslt;">libXSLT</ulink> are installed.
YAZ must be configured with libxml2 support.
If not,
- <ulink url="http://www.loc.gov/standards/sru/">SRW/SRU</ulink>
+ <ulink url="&url.sru;">SRW/SRU</ulink>
is not supported.
The YAZ Proxy uses libXSLT for record conversions via XSLT.
</para>
formats. This is useful if you want the proxy to offer more
MARC record types than the backend target supports. Get USEMARCON
from:
- <ulink url="http://www.bl.uk/services/bibliographic/usemarcon.html">
- British Library USEMARCON page
+ <ulink url="&url.usemarcon;">British Library USEMARCON page
</ulink>.
</para>
<section id="unix">
<title>Building on Windows</title>
<para>
YAZ++ is shipped with "makefiles" for the NMAKE tool that comes
- with <ulink url="http://msdn.microsoft.com/vstudio/">
+ with <ulink url="&url.vstudio;">
Microsoft Visual Studio</ulink>.
Version 6 and .NET has been tested. We expect that YAZ++ compiles
with version 5 as well.
If <literal>HAVE_LIBXSLT</literal> is set to 1, the proxy is compiled
with XSLT and XML support. In this configuration, set
<literal>LIBXSLT_DIR</literal> to the
- <ulink url="http://www.xmlsoft.org/">libXSLT</ulink> source
+ <ulink url="&url.libxslt;">libXSLT</ulink> source
directory.
</para>
<para>
Windows versions of libXSLT, libxml2, zlib and iconv can be found
- <ulink url="http://www.zlatkovic.com/libxml.en.html">
+ <ulink url="&url.libxml2.download.win32;">
here</ulink>.
</para>
</listitem>
If <literal>HAVE_LIBXML2</literal> is set to 1, the proxy is compiled
with XML support. In this configuration, set
<literal>LIBXML2_DIR</literal> to the
- <ulink url="http://www.xmlsoft.org/">libxml2</ulink> source directory
+ <ulink url="&url.libxml2;">libxml2</ulink> source directory
and
<literal>ZLIB_DIR</literal> to the zlib directory.
</para>
-<!-- $Id: introduction.xml,v 1.7 2006-04-13 00:10:19 adam Exp $ -->
+<!-- $Id: introduction.xml,v 1.8 2006-04-26 12:17:23 adam Exp $ -->
<chapter id="introduction"><title>Introduction</title>
<para>
- The <ulink url="http://www.indexdata.dk/yazproxy/">YAZ Proxy</ulink> is
+ The <ulink url="&url.yazproxy;">YAZ Proxy</ulink> is
highly configurable and can be used in a number of different
applications, ranging from debugging Z39.50-based applications
and protecting overworked servers, to improving the performance of
<itemizedlist>
<listitem>
<para>
- <ulink url="http://www.loc.gov/standards/sru/">SRW/SRU</ulink>
+ <ulink url="&url.sru;">SRW/SRU</ulink>
server function, to allow any
- <ulink url="http://www.loc.gov/z3950/agency/">Z39.50</ulink>
+ <ulink url="&url.z39.50;">Z39.50</ulink>
server to also support the SRW/SRU protocols.
</para>
</listitem>
<listitem>
<para>
- <ulink url="http://www.w3.org/XML/">XML</ulink> support --
+ <ulink url="&url.xml;">XML</ulink> support --
MARC records can be converted to
- <ulink url="http://www.loc.gov/standards/marcxml/">MARCXML</ulink>, and
- <ulink url="http://www.w3.org/TR/xslt">XSLT</ulink>-transformations
+ <ulink url="&url.marcxml;">MARCXML</ulink>, and
+ <ulink url="&url.xslt;">XSLT</ulink>-transformations
allow the proxy to support arbitrary retrieval schemas in XML
</para>
</listitem>
usual YAZ address format (typically
<literal>tcp:<parameter>hostname</parameter>:<parameter>port</parameter></literal>)
as described in
- <ulink url="http://www.indexdata.dk/yaz/doc/comstack.addresses.tkl"
+ <ulink url="&url.yaz.comstack.addresses;"
>the Addresses section of the YAZ manual</ulink>.
</para>
</listitem>
</para>
<para>
The config file is XML based. The YAZ proxy must be compiled
- with <ulink url="http://www.xmlsoft.org/">libxml2</ulink> and
- <ulink url="http://xmlsoft.org/XSLT/">libXSLT</ulink> support in
+ with <ulink url="&url.libxml2;">libxml2</ulink> and
+ <ulink url="&url.libxslt;">libXSLT</ulink> support in
order for the config file facility to be enabled.
</para>
<para>
<para>
The proxy config file must have a root element called
<literal>proxy</literal> and scoped within namespace
- <literal> xmlns="http://indexdata.dk/yazproxy/schema/0.8/</literal>.
+ <literal> xmlns="http://indexdata.dk/yazproxy/schema/0.9/</literal>.
All information except an optional XML header must be stored
within the <literal>proxy</literal> element.
</para>
<screen>
<?xml version="1.0"?>
- <proxy xmlns="http://indexdata.dk/yazproxy/schema/0.8/">
+ <proxy xmlns="http://indexdata.dk/yazproxy/schema/0.9/">
<!-- content here .. -->
</proxy>
</screen>
</para>
<para>
See YAZ documentation for more information about the
- <ulink url="http://indexdata.dk/yaz/doc/tools.tkl#tools.cql.pqf">CQL
- to PQF</ulink> conversion. See also the
+ <ulink url="&url.yaz.cql2pqf;">CQL to PQF</ulink> conversion.
+ See also the
<filename>pqf.properties</filename> in the <filename>etc</filename>
(or <replaceable>prefix/share/yazproxy</replaceable>)
directory of the YAZ proxy distribution.
</para>
<tip>
<para>
- Using the <ulink url="http://www.gnu.org/software/bash/bash.html">
- bash</ulink> shell, you can set the limit with
+ Using the <ulink url="&url.bash;">bash</ulink> shell, you can set
+ the limit with
<literal>ulimit -n</literal><replaceable>no</replaceable>.
Use <literal>ulimit -a</literal> to display limits.
</para>
<screen><![CDATA[
<?xml version="1.0"?>
<!-- XML Schema for YAZ proxy config file.
- $Id: reference.xml,v 1.18 2006-04-16 07:45:03 adam Exp $
+ $Id: reference.xml,v 1.19 2006-04-26 12:17:23 adam Exp $
-->
<xs:schema
xmlns:xs="http://www.w3.org/2001/XMLSchema"
<!ENTITY chap-reference SYSTEM "reference.xml">
<!ENTITY yaz-proxy-ref SYSTEM "yaz-proxy-ref.xml">
<!ENTITY app-license SYSTEM "license.xml">
+ <!ENTITY % common SYSTEM "common/common.ent">
+ %common;
]>
-<!-- $Id: yazproxy.xml.in,v 1.6 2006-04-20 12:05:54 adam Exp $ -->
+<!-- $Id: yazproxy.xml.in,v 1.7 2006-04-26 12:17:23 adam Exp $ -->
<book id="yazproxy">
<bookinfo>
<title>YAZ proxy User's Guide and Reference</title>
</copyright>
<abstract>
<simpara>
- <ulink url="http://www.indexdata.dk/yazproxy/">YAZ proxy</ulink>
+ <ulink url="&url.yazproxy;">YAZ proxy</ulink>
is a powerful general purpose Z39.50/SRW/SRU proxy.
</simpara>
<simpara>
This manual covers version @VERSION@.
</simpara>
<simpara>
- CVS ID: $Id: yazproxy.xml.in,v 1.6 2006-04-20 12:05:54 adam Exp $
+ CVS ID: $Id: yazproxy.xml.in,v 1.7 2006-04-26 12:17:23 adam Exp $
</simpara>
<simpara>
<inlinemediaobject>
projects / yazproxy-moved-to-github.git / commitdiff