From: Adam Dickmeiss <adam@indexdata.dk>
Date: Tue, 6 Jun 2006 08:55:22 +0000 (+0000)
Subject: Added some information about "classic" Explain.
X-Git-Tag: before.bug.529~83
X-Git-Url: http://git.indexdata.com/?p=idzebra-moved-to-github.git;a=commitdiff_plain;h=c9454ba7556b581f6fabd13946dc183d073c0795

Added some information about "classic" Explain.
---

diff --git a/doc/server.xml b/doc/server.xml
index 9f6499f..f09b2cf 100644
--- a/doc/server.xml
+++ b/doc/server.xml
@@ -1,5 +1,5 @@
 <chapter id="server">
- <!-- $Id: server.xml,v 1.19 2006-04-25 12:26:26 marc Exp $ -->
+ <!-- $Id: server.xml,v 1.20 2006-06-06 08:55:22 adam Exp $ -->
  <title>The Z39.50 Server</title>
  
  <sect1 id="zebrasrv">
@@ -479,8 +479,8 @@
      </screen> 
     </para>
    </sect3>
-  </sect2>
-
+   </sect2>
+   
   <sect2>
    <title>Present</title>
    <para>
@@ -534,6 +534,76 @@
     timeout.
    </para>
   </sect2>
+   
+   <sect2>
+    <title>Explain</title>
+    <para>
+     Zebra maintains a "classic" 
+     <ulink url="&url.z39.50.explain;">Explain</ulink> database
+     on the-side. 
+     This database is called <literal>IR-Explain-1</literal> and can be
+     searched using attribute Exp-1.
+    </para>
+    <para>
+     The records in the explain database is of type 
+     <literal>grs.sgml</literal> and can be retrieved as
+     SUTRS, XML, GRS-1 + ASN.1 Explain.
+    </para>
+    <para>
+     Classic Explain only defines retrieaval of Explain information
+     via ASN.1. Pratically no Z39.50 clients supports this. Fortunately
+     they don't have to - since Zebra allows retrieaval of this information
+     in the other formats.
+    </para>
+    <para>
+     The root element for the Explain grs.sgml records is 
+     <literal>explain</literal>, thus 
+     <filename>explain.abs</filename> is used for indexing.
+    </para>
+    <note>
+     <para>
+      Zebra <emphasis>must</emphasis> be able to locate
+      <filename>explain.abs</filename> in order to index the Explain
+      records properly. Zebra will work without it but the information
+      will not be searchable.
+     </para>
+    </note>
+    <para>
+     The following Explain categories are supported: CategoryList, TargetInfo,
+     DatabaseInfo, AttributeDetails .
+    </para>
+    <para>
+     The following Explain search atributes are supported:
+     ExplainCategory (1), DatabaseName (3), DateAdded (9), DateChanged(10).
+     See <filename>tab/explain.att</filename> for more information.
+    </para>
+    
+    <sect3>
+     <title>Example searches</title>
+     
+     <para>
+      List supported categories:
+      <screen>
+       @attr exp1 1=1 categorylist
+      </screen>
+     </para>
+
+     <para>
+      Get targetinfo
+      <screen>
+       @attr exp1 1=1 targetinfo
+      </screen>
+     </para>
+     
+     <para>
+      Get databaseinfo record for database <literal>Default</literal>.
+      <screen>
+       @and @attr exp1 1=1 databaseinfo @attr exp1 1=3 Default
+      </screen>
+     </para>
+
+    </sect3>
+   </sect2>
  </sect1>
 </chapter>