This is still totally non-functional.

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

diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index 0ec7e6d..1e7e91b 100644 (file)
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -8,7 +8,7 @@
      <!ENTITY % common SYSTEM "common/common.ent">
      %common;
 ]>
-<!-- $Id: pazpar2_conf.xml,v 1.5 2007-01-19 19:12:16 quinn Exp $ -->
+<!-- $Id: pazpar2_conf.xml,v 1.9 2007-03-27 11:25:57 marc Exp $ -->
 <refentry id="pazpar2_conf">
  <refentryinfo>
   <productname>Pazpar2</productname>
@@ -84,7 +84,10 @@
              If this item is given, pazpar2 will forward all incoming HTTP
              requests that do not contain the filename 'search.pz2' to the
              host and port specified using the 'host' and 'port'
-             attributes. This functionality is crucial if you wish to use
+             attributes. The 'myurl' attribute is required, and should provide
+             the base URL of the server. Generally, the HTTP URL for the host
+             specified in the 'listen' parameter. This functionality is
+             crucial if you wish to use
              pazpar2 in conjunction with browser-based code (JS, Flash,
              applets, etc.) which operates in a security sandbox. Such code
              can only connect to the same server from which the enclosing
@@ -98,6 +101,21 @@
        </varlistentry>
 
        <varlistentry>
+         <term>zproxy</term>
+         <listitem>
+           <para>
+             If this item is given, pazpar2 will send all Z39.50
+             packages through this Z39.50 proxy server.
+              At least one of the 'host' and 'post' attributes is required.
+              The 'host' attribute may contain both host name and port
+             number, seperated by a colon ':', or only the host name.
+              An empty 'host' attribute sets the Z39.50 host address
+             to 'localhost'.  
+           </para>
+         </listitem>
+       </varlistentry>
+
+       <varlistentry>
          <term>service</term>
          <listitem>
            <para>
@@ -105,7 +123,7 @@
              respect to your data model. In pazpar2, incoming records are
              normalized, using XSLT, into an internal representation (see
              the <link
-             id="config-retrievalprofile">retrievalprofile</link> secion.
+             linkend="config-retrievalprofile">retrievalprofile</link> secion.
              The 'service' section controls the further processing and
              extraction of data from the internal representation, primarily
              through the 'metdata' sub-element.
@@ -226,7 +244,7 @@
       </variablelist>           <!-- Data elements in server directive -->
     </refsect2>
 
-    <refsect2 id="config-queryprofile">
+    <refsect2 id="config-queryprofile"><title>queryprofile</title>
       <para>
         At the moment, this directive is ignored; there is one global
        CCL-mapping file which governs the mapping of queries to Z39.50
@@ -235,7 +253,7 @@
       </para>
     </refsect2>
 
-    <refsect2 id="config_retrievalprofile">
+    <refsect2 id="config_retrievalprofile"><title>retrievalprofile</title>
       <para>
        Note: In the present version, there is a single retrieval
        profile. However, in a future release, it will be possible to
@@ -313,10 +331,45 @@
 
   </refsect1>
  
- <refsect1><title>EXAMPLES</title>
-  <para></para>
- </refsect1> 
+ <refsect1><title>EXAMPLE</title>
+  <para>Below is a working example configuration:
+  <screen><![CDATA[
+<?xml version="1.0" encoding="UTF-8"?>
+<pazpar2 xmlns="http://www.indexdata.com/pazpar2/1.0">
+
+<server>
+  <listen port="9004"/>
+  <proxy host="us1.indexdata.com" myurl="us1.indexdata.com"/>
+
+  <!-- <zproxy host="localhost" port="9000"/> -->
+  <!-- <zproxy host="localhost:9000"/> -->
+  <!-- <zproxy port="9000"/> -->
+
+  <service>
+    <metadata name="title" brief="yes" sortkey="skiparticle" merge="longest" rank="6"/>
+    <metadata name="isbn" merge="unique"/>
+    <metadata name="date" brief="yes" sortkey="numeric" type="year" merge="range"
+           termlist="yes"/>
+    <metadata name="author" brief="yes" termlist="yes" merge="longest" rank="2"/>
+    <metadata name="subject" merge="unique" termlist="yes" rank="3"/>
+    <metadata name="url" merge="unique"/>
+  </service>
+</server>
 
+<queryprofile/>  <!-- Like a CCL profile++ . Can optionally refer to XSLT to 
+       convert ZeeRex into queryprofile. Multiple profiles can exist.  -->
+
+<retrievalprofile>
+  <requestsyntax>marc21</requestsyntax>
+  <nativesyntax name="iso2709" format="marc21" encoding="marc8s" mapto="marcxml"/>
+  <map type="xslt" stylesheet="marc21.xsl"/>
+</retrievalprofile>
+
+</pazpar2>
+]]></screen>
+   </para>
+ </refsect1> 
+</refentry>
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml