7802331e354ca4cb93637dd9d6f7518c3344e515
[metaproxy-moved-to-github.git] / doc / zoom.xml
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 
2     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
3  <!ENTITY copyright SYSTEM "copyright.xml">
4  <!ENTITY % idcommon SYSTEM "common/common.ent">
5      %idcommon;
6 ]>
7 <refentry id="ref-zoom">
8  <refentryinfo>
9   <productname>Metaproxy</productname>
10   <info><orgname>Index Data</orgname></info>
11  </refentryinfo>
12
13  <refmeta>
14   <refentrytitle>zoom</refentrytitle>
15   <manvolnum>3mp</manvolnum>
16   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
17  </refmeta>
18  
19  <refnamediv>
20   <refname>zoom</refname>
21   <refpurpose>Metaproxy Package ZOOM Module</refpurpose>
22  </refnamediv>
23  
24  <refsect1><title>DESCRIPTION</title>
25   <para>
26    This filter implements a generic client based on
27    <ulink url="&url.yaz.zoom;">ZOOM</ulink> of YAZ.
28    The client implements the protocols that ZOOM C does: Z39.50, SRU
29    (GET, POST, SOAP) and SOLR .
30   </para>
31  </refsect1>
32  
33  <refsect1><title>SCHEMA</title>
34    <literallayout><xi:include
35                      xi:href="../xml/schema/filter_zoom.rnc"
36                      xi:parse="text"  
37                      xmlns:xi="http://www.w3.org/2001/XInclude" />
38    </literallayout>
39  </refsect1>
40  
41  <refsect1><title>EXAMPLES</title>
42   <para>
43    The following configuration illustrates most of the
44    facilities:
45    <screen><![CDATA[
46     <filter type="zoom">
47       <torus
48          url="http://torus.indexdata.com/src/records/?query=udb%3D%db"
49          xsldir="."
50          />
51       <fieldmap cql="cql.anywhere"/>
52       <fieldmap cql="cql.serverChoice"/>
53       <fieldmap cql="dc.creator" ccl="au"/>
54       <fieldmap cql="dc.title" ccl="ti"/>
55       <fieldmap cql="dc.subject" ccl="su"/>
56       
57       <cclmap>
58         <qual name="ocn">
59           <attr type="u" value="12"/>
60           <attr type="s" value="107"/>
61         </qual>
62       </cclmap>
63     </filter>
64 ]]>
65    </screen>
66   </para>
67
68  </refsect1> 
69  
70  <refsect1><title>SEE ALSO</title>
71   <para>
72    <citerefentry>
73     <refentrytitle>metaproxy</refentrytitle>
74     <manvolnum>1</manvolnum>
75    </citerefentry>
76   </para>
77   <para>
78    <citerefentry>
79     <refentrytitle>virt_db</refentrytitle>
80     <manvolnum>3mp</manvolnum>
81    </citerefentry>
82   </para>
83  </refsect1>
84  
85  &copyright;
86 </refentry>
87
88 <!-- Keep this comment at the end of the file
89 Local variables:
90 mode: sgml
91 sgml-omittag:t
92 sgml-shorttag:t
93 sgml-minimize-attributes:nil
94 sgml-always-quote-attributes:t
95 sgml-indent-step:1
96 sgml-indent-data:t
97 sgml-parent-document:nil
98 sgml-local-catalogs: nil
99 sgml-namecase-general:t
100 End:
101 -->