X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fzoom.xml;h=09c8afe2f8b37608798b2347daa016105c919c26;hb=7a5fb5eb34cc8f0d976259a4c90a448de29a3d3c;hp=d8ae9e25da95db4087369b56807247e15303e7c4;hpb=48303fd661d8987d0ad1211180b36cd7c2484d46;p=metaproxy-moved-to-github.git

diff --git a/doc/zoom.xml b/doc/zoom.xml
index d8ae9e2..09c8afe 100644
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -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>
@@ -71,15 +72,34 @@
      <term>attribute <literal>url</literal></term>
      <listitem>
       <para>
-       URL of Web service to be used to fetch target profile
-       for a given database (udb). The special sequence
-       <literal>%db</literal> of the URL is replaced by the
-       actual database specified as part of Search.
+       URL of Web service to be used when fetch target profiles from
+       a remote service (Torus normally).
+      </para>
+      <para>
+       The sequence <literal>%query</literal> is replaced with a CQL
+       query for the Torus search.
       </para>
       <para>
        The special sequence <literal>%realm</literal> is replaced by value
        of attribute <literal>realm</literal> or by realm DATABASE argument.
       </para>
+      <para>
+       The special sequence <literal>%db</literal> is replaced with
+       a single database while searching. Note that this sequence
+       is no longer needed, because the <literal>%query</literal> can already
+       query for a single database by using CQL query
+       <literal>udb==...</literal>.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term>attribute <literal>content_url</literal></term>
+     <listitem>
+      <para>
+       URL of Web service to be used to fetch target profile
+       for a given database (udb) of type content. Semantics otherwise like
+       <literal>url</literal> attribute above.
+      </para>
      </listitem>
     </varlistentry>
     <varlistentry>
@@ -134,6 +154,25 @@
      </listitem>
     </varlistentry>
     <varlistentry>
+     <term>attribute <literal>explain_xsl</literal></term>
+     <listitem>
+      <para>
+       Specifies a stylesheet that converts one or more Torus records
+       to ZeeExplain records. The content of recordData is assumed to be
+       holding each Explain record.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term>attribute <literal>record_xsl</literal></term>
+     <listitem>
+      <para>
+       Specifies a stylesheet that converts retrieval records after
+       transform/literal operations.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
      <term>element <literal>records</literal></term>
      <listitem>
       <para>
@@ -234,6 +273,26 @@
     </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>
+   </variablelist>
+  </refsect2>
+
  </refsect1>
  <refsect1>
   <title>QUERY HANDLING</title>
@@ -505,19 +564,20 @@
      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 
-     <literal>type="generated-url"</literal>.
+     <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
      ${field[pattern/result/flags]}, which will take content
      of field and perform a regular expression conversion using the pattern
      given. For example: <literal>${md-title[\s+/+/g]}</literal> takes
-     metadadata element <literal>title</literal> and converts one or more
+     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 the content proxy server.
+     augmented with a session string as well as host name of the
+     content proxy server.
     </para>
    </listitem>
    </varlistentry>
@@ -582,12 +642,12 @@
     <term>proxy</term>
     <listitem>
      <para>
-      Specifies proxy to be for backend. If this parameters is
+      Specifies one or more proxies for backend. If this parameter is
       omitted, the proxy will be taken from TARGET profile setting
       <link linkend="zoom-torus-cfproxy">
-       <literal>cfProxy</literal>
-      </link>
-      .
+       <literal>cfProxy</literal></link>.
+       The parameter is a list of  comma-separated  host:port entries.
+       Bost host and port must be given for each proxy.
      </para>
     </listitem>
    </varlistentry>
@@ -601,6 +661,15 @@
     </listitem>
    </varlistentry>
    <varlistentry>
+    <term>nocproxy</term>
+    <listitem>
+     <para>
+      If this parameter is specified, content-proyxing is disabled
+      for the search.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
     <term>realm</term>
     <listitem>
      <para>
@@ -638,7 +707,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"/>
@@ -654,6 +723,7 @@
         </qual>
       </cclmap>
       <log apdu="true"/>
+      <zoom timeout="40"/>
     </filter>
 ]]>
    </screen>