X-Git-Url: http://lists.indexdata.com/cgi-bin?a=blobdiff_plain;f=doc%2Fzoom.xml;h=1355d762ca4073c5bad734ae3bf4e2f3c5cf4371;hb=4f606f0faf502a0aa4d05d3b84caca247759c806;hp=80bc5b69986b6832deeb0aff08542407739b172e;hpb=048cb527b39afbbb55f9b8f68c4393326390c683;p=metaproxy-moved-to-github.git

diff --git a/doc/zoom.xml b/doc/zoom.xml
index 80bc5b6..1355d76 100644
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -1,4 +1,4 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
  <!ENTITY % idcommon SYSTEM "common/common.ent">
@@ -9,18 +9,18 @@
   <productname>Metaproxy</productname>
   <info><orgname>Index Data</orgname></info>
  </refentryinfo>
- 
+
  <refmeta>
   <refentrytitle>zoom</refentrytitle>
   <manvolnum>3mp</manvolnum>
   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
  </refmeta>
- 
+
  <refnamediv>
   <refname>zoom</refname>
   <refpurpose>Metaproxy ZOOM Module</refpurpose>
  </refnamediv>
- 
+
  <refsect1>
   <title>DESCRIPTION</title>
   <para>
@@ -29,7 +29,7 @@
    The client implements the protocols that ZOOM C does: Z39.50, SRU
    (GET, POST, SOAP) and SOLR .
   </para>
-  
+
   <para>
    This filter only deals with Z39.50 on input. The following services
    are supported: init, search, present and close. The backend target
@@ -56,9 +56,10 @@
  <refsect1>
   <title>CONFIGURATION</title>
   <para>
-   The configuration consists of five parts: <literal>torus</literal>,
+   The configuration consists of six parts: <literal>torus</literal>,
    <literal>fieldmap</literal>, <literal>cclmap</literal>,
-   <literal>contentProxy</literal> and <literal>log</literal>.
+   <literal>contentProxy</literal>, <literal>log</literal>
+   and <literal>zoom</literal>.
   </para>
   <refsect2>
    <title>torus</title>
@@ -163,6 +164,19 @@
      </listitem>
     </varlistentry>
     <varlistentry>
+     <term>attribute <literal>record_xsl</literal></term>
+     <listitem>
+      <para>
+       Specifies a stylesheet that converts retrieval records after
+       transform/literal operations.
+      </para>
+      <para>
+       When Metaproxy creates a content proxy session, the XSL parameter
+       <literal>cproxyhost</literal> is passed to the transform.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
      <term>element <literal>records</literal></term>
      <listitem>
       <para>
@@ -219,6 +233,17 @@
    </para>
    <variablelist>
     <varlistentry>
+     <term>attribute <literal>config_file</literal></term>
+     <listitem>
+      <para>
+       Specifies the file that configures the cf-proxy system. Metaproxy
+       uses setting <literal>sessiondir</literal> and
+       <literal>proxyhostname</literal> from that file to configure
+       name of proxy host and directory of parameter files for the cf-proxy.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
      <term>attribute <literal>server</literal></term>
      <listitem>
       <para>
@@ -226,6 +251,12 @@
        host[:port]. That is without a method (such as HTTP) and optional
        port number.
       </para>
+      <note>
+       <para>
+	This setting is deprecated. Use the config_file (above)
+	to inform about the proxy server.
+       </para>
+      </note>
      </listitem>
     </varlistentry>
     <varlistentry>
@@ -238,6 +269,12 @@
        using the mkstemp(3) system call. The default value of this
        setting is <literal>/tmp/cf.XXXXXX.p</literal>.
       </para>
+      <note>
+       <para>
+	This setting is deprecated. Use the config_file (above)
+	to inform about the session file area.
+       </para>
+      </note>
      </listitem>
     </varlistentry>
    </variablelist>
@@ -263,6 +300,35 @@
     </varlistentry>
    </variablelist>
   </refsect2>
+
+  <refsect2>
+   <title>zoom</title>
+   <para>
+    The <literal>zoom</literal> element controls settings for the
+    ZOOM.
+   </para>
+   <variablelist>
+    <varlistentry>
+     <term>attribute <literal>timeout</literal></term>
+     <listitem>
+      <para>
+       Is an integer that specifies, in seconds, how long an operation
+       may take before ZOOM gives up. Default value is 40.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term>attribute <literal>proxy_timeout</literal></term>
+     <listitem>
+      <para>
+       Is an integer that specifies, in seconds, how long an operation
+       a proxy check will wait before giving up. Default value is 1.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </refsect2>
+
  </refsect1>
  <refsect1>
   <title>QUERY HANDLING</title>
@@ -282,7 +348,7 @@
   <para>
    Step 1: for CCL, the query is converted to RPN via
    <link linkend="cclmap"><literal>cclmap</literal></link> elements part of
-   the target profile as well as 
+   the target profile as well as
    <link linkend="cclmap_base">base CCL maps</link>.
   </para>
   <para>
@@ -300,13 +366,13 @@
    type.
   </para>
  </refsect1>
- 
+
  <refsect1>
   <title>SORTING</title>
   <para>
    The ZOOM module actively handle CQL sorting - using the SORTBY parameter
    which was introduced in SRU version 1.2. The conversion from SORTBY clause
-   to native sort for some target is driven by the two parameters: 
+   to native sort for some target is driven by the two parameters:
    <link linkend="sortStrategy"><literal>sortStrategy</literal></link>
    and <link linkend="sortmap"><literal>sortmap_</literal><replaceable>field</replaceable></link>.
   </para>
@@ -316,7 +382,7 @@
    conversion. It doesn't throw a diagnostic.
   </para>
  </refsect1>
- 
+
  <refsect1>
   <title>TARGET PROFILE</title>
   <para>
@@ -341,7 +407,7 @@
     </para>
    </listitem>
    </varlistentry>
-   
+
    <varlistentry id="cclmap">
     <term>cclmap_<replaceable>field</replaceable></term><listitem>
     <para>
@@ -353,7 +419,7 @@
     </para>
    </listitem>
    </varlistentry>
-   
+
    <varlistentry>
     <term>cfAuth</term><listitem>
     <para>
@@ -401,7 +467,7 @@
      <literal>element_raw</literal> from the configuration.
      By default that is the element sets <literal>pz2</literal>
      and <literal>raw</literal>.
-     If record transform is not enabled, this setting is 
+     If record transform is not enabled, this setting is
      not used and the element set specified by the client
      is passed verbatim.
     </para>
@@ -421,7 +487,7 @@
     </para>
    </listitem>
    </varlistentry>
-   
+
    <varlistentry>
     <term>piggyback</term><listitem>
     <para>
@@ -432,7 +498,7 @@
     </para>
    </listitem>
    </varlistentry>
-   
+
    <varlistentry>
     <term>queryEncoding</term><listitem>
     <para>
@@ -442,7 +508,7 @@
     </para>
    </listitem>
    </varlistentry>
-   
+
    <varlistentry>
     <term>recordEncoding</term><listitem>
     <para>
@@ -473,7 +539,7 @@
     </para>
    </listitem>
    </varlistentry>
-   
+
    <varlistentry id="sortStrategy">
     <term>sortStrategy</term><listitem>
     <para>
@@ -486,7 +552,7 @@
     </para>
    </listitem>
    </varlistentry>
-   
+
    <varlistentry>
     <term>sru</term><listitem>
     <para>
@@ -533,7 +599,7 @@
     <para>
      The value of this field is a string that generates a dynamic link
      based on record content. If the resulting string is non-zero in length
-     a new field, <literal>metadata</literal> with attribute 
+     a new field, <literal>metadata</literal> with attribute
      <literal>type="generated-url"</literal> is generated.
      The contents of this field is the result of the URL recipe conversion.
      The urlRecipe value may refer to an existing metadata element by
@@ -543,15 +609,9 @@
      metadata element <literal>title</literal> and converts one or more
      spaces to a plus character.
     </para>
-    <para>
-     If the <link linkend="zoom-torus-contentConnector">contentConnector</link>
-     setting also defined, the resulting value is
-     augmented with a session string as well as host name of the
-     content proxy server.
-    </para>
    </listitem>
    </varlistentry>
-   
+
    <varlistentry>
     <term>zurl</term><listitem>
     <para>
@@ -581,7 +641,7 @@
    is a comma rather than a question mark. What follows question mark are
    HTTP arguments (in this case SRU arguments).
   </para>
-  <variablelist>  
+  <variablelist>
    <varlistentry>
     <term>user</term>
     <listitem>
@@ -658,17 +718,17 @@
      </para>
     </listitem>
    </varlistentry>
-  </variablelist>  
+  </variablelist>
  </refsect1>
  <refsect1>
   <title>SCHEMA</title>
   <literallayout><xi:include
   xi:href="../xml/schema/filter_zoom.rnc"
-  xi:parse="text"  
+  xi:parse="text"
   xmlns:xi="http://www.w3.org/2001/XInclude" />
   </literallayout>
  </refsect1>
- 
+
  <refsect1>
   <title>EXAMPLES</title>
   <para>
@@ -677,7 +737,7 @@
    <screen><![CDATA[
     <filter type="zoom">
       <torus
-         url="http://torus.indexdata.com/src/records/?query=udb%3D%db"
+         url="http://torus.indexdata.com/src/records/?query=%query"
 	 proxy="localhost:3128"
          />
       <fieldmap cql="cql.anywhere"/>
@@ -685,7 +745,7 @@
       <fieldmap cql="dc.creator" ccl="au"/>
       <fieldmap cql="dc.title" ccl="ti"/>
       <fieldmap cql="dc.subject" ccl="su"/>
-      
+
       <cclmap>
         <qual name="ocn">
           <attr type="u" value="12"/>
@@ -693,13 +753,14 @@
         </qual>
       </cclmap>
       <log apdu="true"/>
+      <zoom timeout="40"/>
     </filter>
 ]]>
    </screen>
   </para>
-  
- </refsect1> 
- 
+
+ </refsect1>
+
  <refsect1>
   <title>SEE ALSO</title>
   <para>
@@ -715,7 +776,7 @@
    </citerefentry>
   </para>
  </refsect1>
- 
+
  &copyright;
 </refentry>