X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=doc%2Fserver.xml;h=f09b2cfc35d6c8195bc7178618768015efaabae1;hb=27742a4ea82e9b3494c166203b06d1d7c48da923;hp=063802a84222a58b9e256c7c07815e605ce95d41;hpb=47054fae00306e75212a26ee5305f00032c99001;p=idzebra-moved-to-github.git

diff --git a/doc/server.xml b/doc/server.xml
index 063802a..f09b2cf 100644
--- a/doc/server.xml
+++ b/doc/server.xml
@@ -1,5 +1,5 @@
 <chapter id="server">
- <!-- $Id: server.xml,v 1.18 2006-04-24 12:53:03 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>
 
@@ -866,9 +936,17 @@
  </sect1>
 </chapter>
 
- <!-- Keep this Emacs mode comment at the end of the file
-Local variables:
-mode: nxml
-End:
--->
-
+ <!-- Keep this comment at the end of the file
+ Local variables:
+ mode: sgml
+ sgml-omittag:t
+ sgml-shorttag:t
+ sgml-minimize-attributes:nil
+ sgml-always-quote-attributes:t
+ sgml-indent-step:1
+ sgml-indent-data:t
+ sgml-parent-document: "zebra.xml"
+ sgml-local-catalogs: nil
+ sgml-namecase-general:t
+ End:
+ -->