From c73cdef608e23dc827647fb5d3e69822f4614467 Mon Sep 17 00:00:00 2001
From: Mike Taylor <mike@indexdata.com>
Date: Wed, 8 Mar 2006 10:47:37 +0000
Subject: [PATCH] Comments on ZeeRex. Remove extraneous vertical space in
 <screen> sections.

---
 doc/server.xml           |   43 +++++++++++++++++++------------------------
 doc/zebrasrv-virtual.xml |    9 +++++++--
 2 files changed, 26 insertions(+), 26 deletions(-)

diff --git a/doc/server.xml b/doc/server.xml
index fd4dc07..52b0bc2 100644
--- a/doc/server.xml
+++ b/doc/server.xml
@@ -1,5 +1,5 @@
 <chapter id="server">
- <!-- $Id: server.xml,v 1.16 2006-02-16 16:50:18 marc Exp $ -->
+ <!-- $Id: server.xml,v 1.17 2006-03-08 10:47:37 mike Exp $ -->
  <title>The Z39.50 Server</title>
  
  <sect1 id="zebrasrv">
@@ -743,6 +743,9 @@
     <literal>operation</literal>=<literal>explain</literal>
     and version-number specified)
     or with a simple HTTP GET at the server's basename.
+    The ZeeRex record returned in response is the one embedded
+    in the YAZ Frontend Server configuration file that is described in the
+    <link linkend="gfs-config">Virtual Hosts</link> documentation.
    </para>
     <para>
      Unfortunately, the data found in the 
@@ -755,7 +758,8 @@
     <para>
      There is no linkeage whatsoever between the Z39.50 explain model
      and the SRU/SRW explain response (well, at least not implemented
-     in Zebra, that is ..).
+     in Zebra, that is ..).  Zebra does not provide a means using
+     Z39.50 to obtain the ZeeRex record.
      </para>
   </sect2>
 
@@ -764,49 +768,40 @@
     <para>
      Surf into <literal>http://localhost:9999</literal>
      to get an explain response, or use
-     <screen>
-     <![CDATA[
+     <screen><![CDATA[
       http://localhost:9999/?version=1.1&operation=explain
-     ]]>
-     </screen>
+     ]]></screen>
     </para>
     <para>
      See number of hits for a query
-     <screen>
-     <![CDATA[
+     <screen><![CDATA[
        http://localhost:9999/?version=1.1&operation=searchRetrieve
                        &query=text=(plant%20and%20soil)
-     ]]>
-     </screen>
+     ]]></screen>
     </para>
     <para>
       Fetch record 5-7 in Dublin Core format
-     <screen>
-     <![CDATA[
+     <screen><![CDATA[
        http://localhost:9999/?version=1.1&operation=searchRetrieve
                        &query=text=(plant%20and%20soil)
                        &startRecord=5&maximumRecords=2&recordSchema=dc
- 
-     ]]>
-     </screen>
+     ]]></screen>
     </para>
     <para>
      Even search using PQF queries using the <emphasis>extended naughty 
      verb</emphasis> <literal>x-pquery</literal>
-     <screen>
-     <![CDATA[
+     <screen><![CDATA[
       http://localhost:9999/?version=1.1&operation=searchRetrieve
                        &x-pquery=@attr%201=text%20@and%20plant%20soil
-     ]]> 
-     </screen>
-     or scan indexes using the <emphasis>extended extremely naughty 
+     ]]></screen>
+    </para>
+    <para>
+     Or scan indexes using the <emphasis>extended extremely naughty 
      verb</emphasis> <literal>x-pScanClause</literal>
-     <screen>
-     <![CDATA[
+     <screen><![CDATA[
       http://localhost:9999/?version=1.1&operation=scan
                        &x-pScanClause=@attr%201=text%20something
-     ]]> 
-     </screen>
+     ]]></screen>
      <emphasis>Don't do this in production code!</emphasis>
      But it's a great fast debugging aid.
     </para>
diff --git a/doc/zebrasrv-virtual.xml b/doc/zebrasrv-virtual.xml
index da72d6c..43c4d18 100644
--- a/doc/zebrasrv-virtual.xml
+++ b/doc/zebrasrv-virtual.xml
@@ -1,5 +1,5 @@
 <!-- 
-   $Id: zebrasrv-virtual.xml,v 1.3 2006-01-19 09:27:00 marc Exp $
+   $Id: zebrasrv-virtual.xml,v 1.4 2006-03-08 10:47:54 mike Exp $
    Description of the virtual host mechanism in YAZ GFS
    Included in both manual and man page for yaz-ztest
 -->
@@ -140,9 +140,14 @@
     <para>
      Specifies  <ulink url="http://www.loc.gov/standards/sru/srw/">SRW</ulink>/ <ulink url="http://www.loc.gov/standards/sru/">SRU</ulink> ZeeRex content for this server. Copied verbatim
      to the client. As things are now, some of the Explain content
-     seeem redundant because host information, etc. is also stored
+     seems redundant because host information, etc. is also stored
      elsewhere.
     </para>
+    <para>
+     The format of the Explain record is described in detail, with
+     examples, on the file ZeeRex web-site,
+     <ulink url="http://explain.z3950.org/"></ulink>.
+    </para>
    </listitem>
   </varlistentry>
  </variablelist>
-- 
1.7.10.4