Mergekey changes - order + required/optional.

[pazpar2-moved-to-github.git] / doc / pazpar2_conf.xml

diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index 9d08cbc..6dca610 100644 (file)
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -265,9 +265,22 @@
          <varlistentry><term>mergekey</term>
           <listitem>
            <para>
-            If set to <literal>yes</literal>, the value of this
-            metadata element is appended to the resulting mergekey.
-            By default metadata is not part of a mergekey.
+            If set to '<literal>required</literal>', the value of this
+            metadata element is appended to the resulting mergekey if
+            the metadata is present in a record instance.
+            If the metadata element is not present, the a unique mergekey
+            will be generated instead.
+           </para>
+           <para>
+            If set to '<literal>optional</literal>', the value of this
+            metadata element is appended to the resulting mergekey if the
+            the metadata is present in a record instance. If the metadata
+            is not present, it will be empty.
+           </para>
+           <para>
+            If set to '<literal>no</literal>' or the mergekey attribute is
+            omitted, the metadata will not be used in the creation of a
+            mergekey.
            </para>
           </listitem>
          </varlistentry>
@@ -400,10 +413,19 @@
          Specifies timeout parameters for this service.
          The <literal>timeout</literal>
          element supports the following attributes: 
-         <literal>session</literal>, <literal>z3950_connect</literal>,
+         <literal>session</literal>, <literal>z3950_operation</literal>,
          <literal>z3950_session</literal> which specifies
-         'session timeout', 'Z39.50 connect timeout', 'Z39.50 session timeout'
-         respectively.
+         'session timeout', 'Z39.50 operation timeout',
+         'Z39.50 session timeout' respectively. The Z39.50 operation
+         timeout is the time Pazpar2 will wait for an active Z39.50/SRU
+         operation before it gives up (times out). The Z39.50 session
+         time out is the time Pazpar2 will keep the session alive for
+         an idle session (no operation).
+        </para>
+        <para>
+         The following is recommended but not required:
+         z3950_operation (30) &lt; session (60) &lt; z3950_session (180) .
+         The default values are given in parantheses.
         </para>
        </listitem>
        </varlistentry>
@@ -825,6 +847,20 @@
        Provides the path of an XSLT stylesheet which will be used to
        map incoming records to the internal representation.
       </para>
+      <para>
+       When mapping MARC XML records, XSLT can be bypassed for increased 
+       performance with the alternate "MARC map" format.  Provide the
+       path of a file with extension ".mmap" containing on each line:
+       <programlisting>
+        &lt;field&gt; &lt;subfield&gt; &lt;metadata element&gt;</programlisting>
+       For example:
+       <programlisting>
+        245 a title
+        500 $ description
+        773 * citation</programlisting>
+       To map the field value specify a subfield of '$'.  To store a 
+       concatenation of all subfields, specify a subfield of '*'.
+      </para>
      </listitem>
     </varlistentry>
     <varlistentry>