X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fserver.xml;h=af98f12d7eb5b4ccb2a8b5d7ec61be6c0cec4e67;hb=de31c38f785cafdadae526d27c64005e33238761;hp=4fa607b6d859480b0ed9745fbd588c66bf4254eb;hpb=3746a1be699b247ca567fb9cda50cd4504f25928;p=idzebra-moved-to-github.git
diff --git a/doc/server.xml b/doc/server.xml
index 4fa607b..af98f12 100644
--- a/doc/server.xml
+++ b/doc/server.xml
@@ -1,5 +1,5 @@
-
+
The Z39.50 Server
@@ -242,243 +242,6 @@
also the following section).
-
- Use attributes are interpreted according to the
- attribute sets which have been loaded in the
- zebra.cfg file, and are matched against specific
- fields as specified in the .abs file which
- describes the profile of the records which have been loaded.
- If no Use attribute is provided, a default of Bib-1 Any is assumed.
-
-
-
- If a Structure attribute of
- Phrase is used in conjunction with a
- Completeness attribute of
- Complete (Sub)field, the term is matched
- against the contents of the phrase (long word) register, if one
- exists for the given Use attribute.
- A phrase register is created for those fields in the
- .abs file that contains a
- p-specifier.
-
-
-
-
- If Structure=Phrase is
- used in conjunction with Incomplete Field - the
- default value for Completeness, the
- search is directed against the normal word registers, but if the term
- contains multiple words, the term will only match if all of the words
- are found immediately adjacent, and in the given order.
- The word search is performed on those fields that are indexed as
- type w in the .abs file.
-
-
-
- If the Structure attribute is
- Word List,
- Free-form Text, or
- Document Text, the term is treated as a
- natural-language, relevance-ranked query.
- This search type uses the word register, i.e. those fields
- that are indexed as type w in the
- .abs file.
-
-
-
- If the Structure attribute is
- Numeric String the term is treated as an integer.
- The search is performed on those fields that are indexed
- as type n in the .abs file.
-
-
-
- If the Structure attribute is
- URx the term is treated as a URX (URL) entity.
- The search is performed on those fields that are indexed as type
- u in the .abs file.
-
-
-
- If the Structure attribute is
- Local Number the term is treated as
- native Zebra Record Identifier.
-
-
-
- If the Relation attribute is
- Equals (default), the term is matched
- in a normal fashion (modulo truncation and processing of
- individual words, if required).
- If Relation is Less Than,
- Less Than or Equal,
- Greater than, or Greater than or
- Equal, the term is assumed to be numerical, and a
- standard regular expression is constructed to match the given
- expression.
- If Relation is Relevance,
- the standard natural-language query processor is invoked.
-
-
-
- For the Truncation attribute,
- No Truncation is the default.
- Left Truncation is not supported.
- Process # in search term is supported, as is
- Regxp-1.
- Regxp-2 enables the fault-tolerant (fuzzy)
- search. As a default, a single error (deletion, insertion,
- replacement) is accepted when terms are matched against the register
- contents.
-
-
-
- Regular expressions
-
-
- Each term in a query is interpreted as a regular expression if
- the truncation value is either Regxp-1 (102)
- or Regxp-2 (103).
- Both query types follow the same syntax with the operands:
-
-
-
- x
-
-
- Matches the character x.
-
-
-
-
- .
-
-
- Matches any character.
-
-
-
-
- [..]
-
-
- Matches the set of characters specified;
- such as [abc] or [a-c].
-
-
-
-
- and the operators:
-
-
-
- x*
-
-
- Matches x zero or more times. Priority: high.
-
-
-
-
- x+
-
-
- Matches x one or more times. Priority: high.
-
-
-
-
- x?
-
-
- Matches x zero or once. Priority: high.
-
-
-
-
- xy
-
-
- Matches x, then y.
- Priority: medium.
-
-
-
-
- x|y
-
-
- Matches either x or y.
- Priority: low.
-
-
-
-
- The order of evaluation may be changed by using parentheses.
-
-
-
- If the first character of the Regxp-2 query
- is a plus character (+) it marks the
- beginning of a section with non-standard specifiers.
- The next plus character marks the end of the section.
- Currently Zebra only supports one specifier, the error tolerance,
- which consists one digit.
-
-
-
- Since the plus operator is normally a suffix operator the addition to
- the query syntax doesn't violate the syntax for standard regular
- expressions.
-
-
-
-
-
- Query examples
-
-
- Phrase search for information retrieval in
- the title-register:
-
- @attr 1=4 "information retrieval"
-
-
-
-
- Ranked search for the same thing:
-
- @attr 1=4 @attr 2=102 "Information retrieval"
-
-
-
-
- Phrase search with a regular expression:
-
- @attr 1=4 @attr 5=102 "informat.* retrieval"
-
-
-
-
- Ranked search with a regular expression:
-
- @attr 1=4 @attr 5=102 @attr 2=102 "informat.* retrieval"
-
-
-
-
- In the GILS schema (gils.abs), the
- west-bounding-coordinate is indexed as type n,
- and is therefore searched by specifying
- structure=Numeric String.
- To match all those records with west-bounding-coordinate greater
- than -114 we use the following query:
-
- @attr 4=109 @attr 2=5 @attr gils 1=2038 -114
-
-
-
@@ -546,17 +309,7 @@
The records in the explain database are of type
- grs.sgml and can be retrieved as
- SUTRS, XML,
- GRS-1 and 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 retrieval of this information
- in the other formats.
-
-
+ grs.sgml.
The root element for the Explain grs.sgml records is
explain, thus
explain.abs is used for indexing.
@@ -569,96 +322,6 @@
will not be searchable.
-
- The following Explain categories are supported:
- CategoryList, TargetInfo,
- DatabaseInfo, AttributeDetails.
-
-
- The following Explain search atributes are supported:
- ExplainCategory (@attr 1=1),
- DatabaseName (@attr 1=3),
- DateAdded (@attr 1=9),
- DateChanged(@ayyt 1=10).
- See tab/explain.att for more information.
-
-
-
- Example searches with yaz-client
-
-
-
- List supported categories to find out which explain commands are
- supported:
-
- Z> base IR-Explain-1
- Z> @attr exp1 1=1 categorylist
- Z> form sutrs
- Z> show 1+2
-
-
-
-
- Get target info, that is, investigate which databases exist at
- this server endpoint:
-
- Z> base IR-Explain-1
- Z> @attr exp1 1=1 targetinfo
- Z> form xml
- Z> show 1+1
- Z> form grs-1
- Z> show 1+1
- Z> form sutrs
- Z> show 1+1
-
-
-
-
- List all supported databases, the number of hits
- is the number of databases found, which most commonly are the
- following two:
- the Default and the
- IR-Explain-1 databases.
-
- Z> base IR-Explain-1
- Z> f @attr exp1 1=1 databaseinfo
- Z> form sutrs
- Z> show 1+2
-
-
-
-
- Get database info record for database Default.
-
- Z> base IR-Explain-1
- Z> @and @attr exp1 1=1 databaseinfo @attr exp1 1=3 Default
-
- Identical query with explicitly specified attribute set:
-
- Z> base IR-Explain-1
- Z> @attrset exp1 @and @attr 1=1 databaseinfo @attr 1=3 Default
-
-
-
-
- Get attribute details record for database
- Default.
- This query is very useful to study the internal Zebra indexes.
- If records have been indexed using the alvis
- XSLT filter, the string representation names of the known indexes can be
- found.
-
- Z> base IR-Explain-1
- Z> @and @attr exp1 1=1 attributedetails @attr exp1 1=3 Default
-
- Identical query with explicitly specified attribute set:
-
- Z> base IR-Explain-1
- Z> @attrset exp1 @and @attr 1=1 attributedetails @attr 1=3 Default
-
-
-
-
@@ -839,16 +502,16 @@
Scan
- Zebra does not support SRU's
+ Zebra supports SRU's
scan
operation, as described at
-
+ .
+ Scanning using CQL syntax is the default, where the
+ standard scanClause parameter is used.
- This is a rather embarrassing surprise as the pieces are all
- there: Z39.50 scan is supported, and SRU scan requests are
- recognised and diagnosed. To add further to the embarrassment, a
- mutant form of SRU scan is supported, using
+ In addition, a
+ mutant form of SRU scan is supported, using
the non-standard x-pScanClause parameter in
place of the standard scanClause to scan on a
PQF query clause.