From 30006392c5d236b5da322842855bd246b2ccfdd8 Mon Sep 17 00:00:00 2001
From: Adam Dickmeiss <adam@indexdata.dk>
Date: Fri, 25 Nov 2011 08:45:21 +0100
Subject: [PATCH] zoom doc: describe database parameters

---
 doc/zoom.xml |   89 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 89 insertions(+)

diff --git a/doc/zoom.xml b/doc/zoom.xml
index 2c85515..b80df07 100644
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -76,9 +76,22 @@
        <literal>%db</literal> of the URL is replaced by the
        actual database specified as part of Search.
       </para>
+      <para>
+       The special sequence <literal>%realm</literal> is replaced by value
+       of attribute <literal>realm</literal> or by realm DATABASE argument.
+      </para>
      </listitem>
     </varlistentry>
     <varlistentry>
+      <term>attribute <literal>realm</literal></term>
+      <listitem>
+	<para>
+	 The default realm value. Used for %realm in URL, unless
+	 specified in DATABASE argument.
+	</para>
+      </listitem>
+    </varlistentry>
+    <varlistentry>
      <term>attribute <literal>proxy</literal></term>
      <listitem>
       <para>
@@ -510,6 +523,82 @@
   </variablelist>
  </refsect1>
  <refsect1>
+  <title>DATABASE parameters</title>
+  <para>
+   Extra information may be carried in the Z39.50 Datbase or SRU path,
+   such as authentication to be passed to backend etc. Some of
+   the parameters override TARGET profile values. The format is
+  </para>
+  <para>
+   udb,parm1=value1&amp;parm2=value2&amp;...
+  </para>
+  <para>
+   Where udb is the unique database recognised by the backend and parm1,
+   value1, .. are parameters to be passed. The following describes the
+   supported parameters.
+  </para>
+  <variablelist>  
+   <varlistentry>
+    <term>user</term>
+    <listitem>
+     <para>
+      Specifies user to be passed to backend. If this parameters is
+      omitted, the user will be taken from TARGET profile setting
+      <literal>authentication</literal>.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term>password</term>
+    <listitem>
+     <para>
+      Specifies password to be passed to backend. If this parameters is
+      omitted, the password will be taken from TARGET profile setting
+      <literal>authentication</literal>.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term>proxy</term>
+    <listitem>
+     <para>
+      Specifies proxy to be for backend. If this parameters is
+      omitted, the proxy will be taken from TARGET profile setting
+      <literal>cfProxy</literal>.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term>cproxysession</term>
+    <listitem>
+     <para>
+      Session ID for content proxy. This parameter is, generally,
+      not used by anything but the content proxy itself.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term>realm</term>
+    <listitem>
+     <para>
+      Session realm to be used for this target, changed the resulting
+      URL to be used for getting a target profile, by changing the
+      value that gets substituted for the %realm string.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term>x-parm</term>
+    <listitem>
+     <para>
+      All parameters that has prefix x, dash are passed verbatim
+      to the backend.
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>  
+ </refsect1>
+ <refsect1>
   <title>SCHEMA</title>
   <literallayout><xi:include
   xi:href="../xml/schema/filter_zoom.rnc"
-- 
1.7.10.4