-<!-- $Id: book.xml,v 1.16 2006-04-24 12:50:24 marc Exp $ -->
+<!-- $Id: book.xml,v 1.22 2006-04-27 12:26:26 adam Exp $ -->
<bookinfo>
<title>Metaproxy - User's Guide and Reference</title>
<author>
<screen>
Anything goes in!
Anything goes out!
- Cold bananas, fish, pyjamas,
+ Fish, bananas, cold pyjamas,
Mutton, beef and trout!
- attributed to Cole Porter.
</screen>
<chapter id="installation">
<title>Installation</title>
<para>
- Metaproxy depends on the folloing tools/libraries:
+ Metaproxy depends on the following tools/libraries:
<variablelist>
<varlistentry><term><ulink url="&url.yazplusplus;">YAZ++</ulink></term>
<listitem>
<listitem>
<para>This is an XSLT processor - based on
<ulink url="&url.libxml2;">Libxml2</ulink>. Both Libxml2 and
- Libxslt must be installed with the development components.
+ Libxslt must be installed with the development components
+ (header files, etc.) as well as the run-time libraries.
</para>
</listitem>
</varlistentry>
<varlistentry><term><ulink url="&url.boost;">Boost</ulink></term>
<listitem>
<para>
- The popular C++ library.
+ The popular C++ library. Initial versions of Metaproxy
+ was built with 1.33.0. Version 1.33.1 works too.
</para>
</listitem>
</varlistentry>
<section id="installation.windows">
<title>Installation on Windows</title>
<para>
- ### To be written
+ Compilation of Metaproxy can be done using
+ Microsoft <ulink url="&url.vstudio;">Visual Studio</ulink>.
+ We know Version 2003 works. We expect Version 2005 to
+ work as well.
</para>
+ <section id="installation.windows.boost">
+ <title>Boost</title>
+ <para>
+ Get Boost from its <ulink url="&url.boost;">home page</ulink>.
+ You also need Boost Jam (an alternative to make).
+ That's also available from this
+ home page. The files download are called something like:
+ <literal>boost_1_33-1.exe</literal>
+ and
+ <literal>boost-jam-3.1.12-1-ntx86.zip</literal>.
+ Unpack Boost Jam first. Put <literal>bjam.exe</literal>
+ in your system path. Make a command prompt and ensure
+ it can be found automatically. If not check the PATH.
+ The Boost .exe is a self-extracting exe with
+ complete source for Boost. Compile that source with
+ Boost Jam (An alternative to Make).
+ The compilation takes a while.
+ By default, the Boost build process puts the resulting
+ libraries + header files in
+ <literal>\boost\lib</literal>, <literal>\boost\include</literal>.
+ </para>
+ <para>
+ For more informatation about installing Boost refer to the
+ <ulink url="&url.boost.getting.started;">getting started</ulink>
+ pages.
+ </para>
+ </section>
+
+ <section id="installation.windows.libxslt">
+ <title>Libxslt</title>
+ <para>
+ <ulink url="&url.libxslt;">Libxslt</ulink> can be downloaded
+ for Windows from
+ <ulink url="&url.libxml2.download.win32;">here</ulink>.
+ </para>
+ <para>
+ Libxslt has other dependencies, but thes can all be downloaded
+ from the same site. Get the following:
+ iconv, zlib, libxml2, libxslt.
+ </para>
</section>
+
+ <section id="installation.windows.yaz">
+ <title>YAZ</title>
+ <para>
+ <ulink url="&url.yaz;">YAZ</ulink> can be downloaded
+ for Windows from
+ <ulink url="&url.yaz.download.win32;">here</ulink>.
+ </para>
+ </section>
+
+ <section id="installation.windows.yazplusplus">
+ <title>YAZ++</title>
+ <para>
+ Get <ulink url="&url.yazplusplus;">YAZ++</ulink> as well.
+ Version 1.0 or later is required. For now get it from
+ Index Data's
+ <ulink url="&url.snapshot.download;">Snapshot area</ulink>.
+ </para>
+ <para>
+ YAZ++ includes NMAKE makefiles, similar to those found in the
+ YAZ package.
+ </para>
+ </section>
+
+ <section id="installation.windows.metaproxy">
+ <title>Metaproxy</title>
+ <para>
+ Metaproxy is shipped with NMAKE makfiles as well - similar
+ to those found in the YAZ++/YAZ packages. Adjust this Makefile
+ to point to the proper locations of Boost, Libxslt, Libxml2,
+ zlib, iconv, yaz and yazpp.
+ </para>
+ <para>
+ After succesful compilation you'll find
+ <literal>metaproxy.exe</literal> in the
+ <literal>bin</literal> directory.
+ </para>
+ </section>
+
+ </section>
</chapter>
<chapter id="architecture">
<para>
Hold on tight - this may get a little hairy.
</para>
+ </section>
+
+
+ <section id="multidb.virt_db">
+ <title>Virtual databases with the <literal>virt_db</literal> filter</title>
<para>
In the general course of things, a Z39.50 Init request may carry
with it an otherInfo packet of type <literal>VAL_PROXY</literal>,
through it.
</para>
</section>
+
+ <section id="multidb.picture">
+ <title>A picture is worth a thousand words (but only five hundred on 64-bit architectures)</title>
+ <simpara>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="multi.png" format="PNG"/>
+ </imageobject>
+ <imageobject>
+ <imagedata fileref="multi.eps" format="EPS"/>
+ </imageobject>
+ <textobject>
+ <!-- Fall back if none of the images can be used -->
+ <phrase>
+ Diagram showing the progress of packages through the filters
+ during a simple virtual-database search and a multi-database
+ search.
+ </phrase>
+ </textobject>
+<!-- ### This used to work with an older version of DocBook
+ <caption>
+ <para>Caption: progress of packages through filters.</para>
+ </caption>
+-->
+ </inlinemediaobject>
+ </simpara>
+ </section>
</chapter>
&manref;
</section>
</chapter>
-<!-- Keep this Emacs mode comment at the end of the file
-Local variables:
-mode: nxml
-End:
--->
\ No newline at end of file
+
+
+
+ <!-- Keep this comment at the end of the file
+ Local variables:
+ mode: sgml
+ sgml-omittag:t
+ sgml-shorttag:t
+ sgml-minimize-attributes:nil
+ sgml-always-quote-attributes:t
+ sgml-indent-step:1
+ sgml-indent-data:t
+ sgml-parent-document: "main.xml"
+ sgml-local-catalogs: nil
+ sgml-namecase-general:t
+ End:
+ -->