X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=doc%2Fserver.xml;h=f09b2cfc35d6c8195bc7178618768015efaabae1;hb=27742a4ea82e9b3494c166203b06d1d7c48da923;hp=a21b5181cc5cf24cb236538be5342adee65136e3;hpb=a0e0e6201b34e05f715a65d19a9b5667b734a58f;p=idzebra-moved-to-github.git
diff --git a/doc/server.xml b/doc/server.xml
index a21b518..f09b2cf 100644
--- a/doc/server.xml
+++ b/doc/server.xml
@@ -1,5 +1,5 @@
-
+
The Z39.50 Server
@@ -16,7 +16,7 @@
zebrasrv manpage -->
- DESCRIPTION
+ DescriptionZebra is a high-performance, general-purpose structured text indexing
and retrieval engine. It reads structured records in a variety of input
formats (eg. email, XML, MARC) and allows access to them through exact
@@ -36,12 +36,12 @@
- SYNOPSIS
+ Synopsis
&zebrasrv-synopsis;
- OPTIONS
+ Options
The options for zebrasrv are the same
@@ -52,19 +52,13 @@
&zebrasrv-options;
- VIRTUAL HOSTS
-
- zebrasrv uses the YAZ server frontend and does
- support multiple virtual servers behind multiple listening sockets.
-
- &zebrasrv-virtual;
-
- FILES
+
+ Fileszebra.cfg
- SEE ALSO
+ See Alsozebraidx
@@ -76,18 +70,6 @@
- Section "The Z39.50 Server" in the Zebra manual.
- http://www.indexdata.dk/zebra/doc/server.tkl
-
-
- Section "Virtual Hosts" in the YAZ manual.
- http://www.indexdata.dk/yaz/doc/server.vhosts.tkl
-
-
- Section "Specification of CQL to RPN mappings" in the YAZ manual.
- http://www.indexdata.dk/yaz/doc/tools.tkl#tools.cql.map
-
-
The Zebra software is Copyright Index Datahttp://www.indexdata.dk
and distributed under the
@@ -497,8 +479,8 @@
-
-
+
+
Present
@@ -552,6 +534,76 @@
timeout.
+
+
+ Explain
+
+ Zebra maintains a "classic"
+ Explain database
+ on the-side.
+ This database is called IR-Explain-1 and can be
+ searched using attribute Exp-1.
+
+
+ The records in the explain database is of type
+ grs.sgml and can be retrieved as
+ SUTRS, XML, GRS-1 + ASN.1 Explain.
+
+
+ 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.
+
+
+ The root element for the Explain grs.sgml records is
+ explain, thus
+ explain.abs is used for indexing.
+
+
+
+ Zebra must be able to locate
+ explain.abs in order to index the Explain
+ records properly. Zebra will work without it but the information
+ will not be searchable.
+
+
+
+ The following Explain categories are supported: CategoryList, TargetInfo,
+ DatabaseInfo, AttributeDetails .
+
+
+ The following Explain search atributes are supported:
+ ExplainCategory (1), DatabaseName (3), DateAdded (9), DateChanged(10).
+ See tab/explain.att for more information.
+
+
+
+ Example searches
+
+
+ List supported categories:
+
+ @attr exp1 1=1 categorylist
+
+
+
+
+ Get targetinfo
+
+ @attr exp1 1=1 targetinfo
+
+
+
+
+ Get databaseinfo record for database Default.
+
+ @and @attr exp1 1=1 databaseinfo @attr exp1 1=3 Default
+
+
+
+
+
@@ -761,7 +813,68 @@
operation=explain
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
+ Virtual Hosts documentation.
+
+ Unfortunately, the data found in the
+ CQL-to-PQF text file must be added by hand-craft into the explain
+ section of the YAZ Frontend Server configuration file to be able
+ to provide a suitable explain record.
+ Too bad, but this is all extreme
+ new alpha stuff, and a lot of work has yet to be done ..
+
+
+ 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 ..). Zebra does not provide a means using
+ Z39.50 to obtain the ZeeRex record.
+
+
+
+
+ Some SRU Examples
+
+ Surf into http://localhost:9999
+ to get an explain response, or use
+
+
+
+ See number of hits for a query
+
+
+
+ Fetch record 5-7 in Dublin Core format
+
+
+
+ Even search using PQF queries using the extended naughty
+ verbx-pquery
+
+
+
+ Or scan indexes using the extended extremely naughty
+ verbx-pScanClause
+
+ Don't do this in production code!
+ But it's a great fast debugging aid.
+