From 3b8c3227f359d5a4ff1b2df52139f1b88a01ce34 Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Mon, 14 Aug 2006 22:33:46 +0000 Subject: [PATCH] Use Docbook tables rather than HTML tables. This makes jade happy and allows us to make PDF. --- doc/administration.xml | 141 ++-- doc/querymodel.xml | 1762 ++++++++++++++++++++++++------------------------ 2 files changed, 955 insertions(+), 948 deletions(-) diff --git a/doc/administration.xml b/doc/administration.xml index 503b032..0445860 100644 --- a/doc/administration.xml +++ b/doc/administration.xml @@ -1,5 +1,5 @@ - + Administrating Zebra - @@ -1332,6 +1330,7 @@ where g = rset_count(terms[i]->rset) is the count of all documents in this speci mitaylor2microsoft.com --> + Dynamically ranking CQL queries @@ -1437,12 +1436,14 @@ where g = rset_count(terms[i]->rset) is the count of all documents in this speci Extended Services: Remote Insert, Update and Delete + Extended services are only supported when accessing the Zebra server using the Z39.50 protocol. The SRU protocol does not support extended services. - - + + + The extended services are not enabled by default in zebra - due to the fact that they modify the system. Zebra can be configured @@ -1483,20 +1484,23 @@ where g = rset_count(terms[i]->rset) is the count of all documents in this speci shadow: directoryname: size (e.g. 1000M) - It is not possible to carry information about record types or - similar to Zebra when using extended services, due to - limitations of the Z39.50 - protocol. Therefore, indexing filters can not be chosen on a - per-record basis. One and only one general XML indexing filter - must be defined. - - + + + It is not possible to carry information about record types or + similar to Zebra when using extended services, due to + limitations of the Z39.50 + protocol. Therefore, indexing filters can not be chosen on a + per-record basis. One and only one general XML indexing filter + must be defined. + + + @@ -1511,69 +1515,68 @@ where g = rset_count(terms[i]->rset) is the count of all documents in this speci information to the servers, which are encoded in seven package fields: - - - - +
Extended services Z39.50 Package Fields
+ Extended services Z39.50 Package Fields + - - - - - + + Parameter + Value + Notes + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + +
ParameterValueNotes
type'update'Must be set to trigger extended services
actionstring + + type + 'update' + Must be set to trigger extended services + + + action + string + Extended service action type with one of four possible values: recordInsert, recordReplace, recordDelete, and specialUpdate -
recordXML stringAn XML formatted string containing the record
syntax'xml'Only XML record syntax is supported
recordIdOpaquestring + + + + record + XML string + An XML formatted string containing the record + + + syntax + 'xml' + Only XML record syntax is supported + + + recordIdOpaque + string + Optional client-supplied, opaque record identifier used under insert operations. -
recordIdNumber positive numberZebra's internal system number, only for update + + + + recordIdNumber + positive number + Zebra's internal system number, only for update actions. -
databaseNamedatabase identifier + + + + databaseName + database identifier + The name of the database to which the extended services should be applied. -
diff --git a/doc/querymodel.xml b/doc/querymodel.xml index 831eeff..82d25ec 100644 --- a/doc/querymodel.xml +++ b/doc/querymodel.xml @@ -1,5 +1,5 @@ - + Query Model @@ -14,7 +14,7 @@ Z39.50 and SRU, and implement the - type-1 Reverse Polish Notation (RPN) query + type-1 Reverse Polish Notation (RPN) query model defined there. Unfortunately, this model has only defined a binary encoded representation, which is used as transport packaging in @@ -22,7 +22,7 @@ readable, nor defines any convenient way to specify queries. - Since the type-1 (RPN) + Since the type-1 (RPN) query structure has no direct, useful string representation, every client application needs to provide some form of mapping from a local query notation or representation to it. @@ -39,8 +39,8 @@ type-1 RPN queries. PQF has been adopted by other parties developing Z39.50 software, and is often referred to as - Prefix Query Notation, or in short - PQN. See + Prefix Query Notation, or in short + PQN. See for further explanations and descriptions of Zebra's capabilities. @@ -67,9 +67,9 @@ Operation types Zebra supports all of the three different - Z39.50/SRU operations defined in the - standards: explain, search, - and scan. A short description of the + Z39.50/SRU operations defined in the + standards: explain, search, + and scan. A short description of the functionality and purpose of each is quite in order here. @@ -81,8 +81,7 @@ semantics - taking into account a particular servers functionalities and abilities - must be discovered from case to case. Enters the - explain operation, which provides the means - for learning which + explain operation, which provides the means for learning which fields (also called indexes or access points) are provided, which default parameter the server uses, which @@ -90,21 +89,20 @@ of the general query model are supported. - The Z39.50 embeds the explain operation + The Z39.50 embeds the explain operation by performing a - search in the magic + search in the magic IR-Explain-1 database; see . - In SRU, explain is an entirely separate - operation, which returns an ZeeRex - XML record according to the + In SRU, explain is an entirely separate + operation, which returns an ZeeRex XML record according to the structure defined by the protocol. In both cases, the information gathered through - explain operations can be used to + explain operations can be used to auto-configure a client user interface to the servers capabilities. @@ -126,14 +124,14 @@ Scan Operation - The scan operation is a helper functionality, + The scan operation is a helper functionality, which operates on one index or access point a time. It provides the means to investigate the content of specific indexes. Scanning an index returns a handful of terms actually found in - the indexes, and in addition the scan + the indexes, and in addition the scan operation returns the number of documents indexed by each term. A search client can use this information to propose proper spelling of search terms, to auto-fill search boxes, or to @@ -179,74 +177,74 @@ definitions, others can easily be defined and added to the configuration. - - - - - +
Attribute sets predefined in Zebra
+ Attribute sets predefined in Zebra + - - - - - - - - + + Attribute set + Short hand + Status + Notes + + + - - - - - - - - - - - - - - - - - - + processing. + default + + + GILS + gils + Extension to the Bib1 attribute set. + predefined + +
Attribute setShort handStatusNotes
Explainexp-1Special attribute set used on the special automagic + + Explain + exp-1 + Special attribute set used on the special automagic IR-Explain-1 database to gain information on server capabilities, database names, and database - and semantics.predefined
Bib1bib-1Standard PQF query language attribute set which defines the + and semantics. + predefined + + + Bib1 + bib-1 + Standard PQF query language attribute set which defines the semantics of Z39.50 searching. In addition, all of the non-use attributes (types 2-11) define the hard-wired Zebra internal query - processing.default
GILSgilsExtension to the Bib1 attribute set.predefined
+ + + The use attributes (type 1) mappings the + predefined attribute sets are found in the + attribute set configuration files tab/*.att. + + + + + The Zebra internal query processing is modeled after + the Bib1 attribute set, and the non-use + attributes type 2-6 are hard-wired in. It is therefore essential + to be familiar with . + + + - - - The use attributes (type 1) mappings the - predefined attribute sets are found in the - attribute set configuration files tab/*.att. - - - - The Zebra internal query processing is modeled after - the Bib1 attribute set, and the non-use - attributes type 2-6 are hard-wired in. It is therefore essential - to be familiar with . - - Boolean operators @@ -256,39 +254,39 @@ Thus, boolean operators are always internal nodes in the query tree. - - - +
Boolean operators
+ Boolean operators + - - - - - - + + Keyword + Operator + Description + + - - - - - - - - - - - - - - - - + @and + binary AND operator + Set intersection of two atomic queries hit sets + + @or + binary OR operator + Set union of two atomic queries hit sets + + @not + binary AND NOT operator + Set complement of two atomic queries hit sets + + @prox + binary PROXIMITY operator + Set intersection of two atomic queries hit sets. In + addition, the intersection set is purged for all + documents which do not satisfy the requested query + term proximity. Usually a proper subset of the AND + operation. + +
KeywordOperatorDescription
@andbinary AND operatorSet intersection of two atomic queries hit sets
@orbinary OR operatorSet union of two atomic queries hit sets
@notbinary AND NOT operatorSet complement of two atomic queries hit sets
@proxbinary PROXIMITY operatorSet intersection of two atomic queries hit sets. In - addition, the intersection set is purged for all - documents which do not satisfy the requested query - term proximity. Usually a proper subset of the AND - operation.
@@ -355,34 +353,34 @@ See for details. - - - +
Atomic queries (APT)
+ Atomic queries (APT) + - - - - - + + Name + Type + Notes + - - - - - - - - - - + + + + term + single term + or quoted term list + Here the search terms or list of search terms is added + to the query + +
NameTypeNotes
attribute listList of orthogonal attributesAny of the orthogonal attribute types may be omitted, + + attribute list + List of orthogonal attributes + Any of the orthogonal attribute types may be omitted, these are inherited from higher query tree nodes, or if not inherited, are set to the default Zebra configuration values. -
termsingle term - or quoted term list Here the search terms or list of search terms is added - to the query
Querying for the term information in the @@ -461,14 +459,15 @@ - Named result sets are only supported by the Z39.50 protocol. - The SRU web service is stateless, and therefore the notion of - named result sets does not exist when accessing a Zebra server by - the SRU protocol. + + Named result sets are only supported by the Z39.50 protocol. + The SRU web service is stateless, and therefore the notion of + named result sets does not exist when accessing a Zebra server by + the SRU protocol. + - - + Zebra's special access point of type 'string' @@ -547,11 +546,13 @@ .abs configuration files. - Only a very restricted subset of the - XPath 1.0 - standard is supported as the GRS record model is simpler than - a full XML DOM structure. See the following examples for - possibilities. + + Only a very restricted subset of the + XPath 1.0 + standard is supported as the GRS record model is simpler than + a full XML DOM structure. See the following examples for + possibilities. + Finding all documents which have the term "content" @@ -615,15 +616,15 @@ - It is worth mentioning that these dynamic performed XPath - queries are a performance bottleneck, as no optimized - specialized indexes can be used. Therefore, avoid the use of - this facility when speed is essential, and the database content - size is medium to large. + + It is worth mentioning that these dynamic performed XPath + queries are a performance bottleneck, as no optimized + specialized indexes can be used. Therefore, avoid the use of + this facility when speed is essential, and the database content + size is medium to large. + - - @@ -847,74 +848,73 @@ side of the relation), e.g., Date-publication <= 1975. - - - - - - - - - +
Relation Attributes (type 2)
RelationValueNotes
+ Relation Attributes (type 2) + + + + Relation + Value + Notes + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + Less than + 1 + supported + + + Less than or equal + 2 + supported + + + Equal + 3 + default + + + Greater or equal + 4 + supported + + + Greater than + 5 + supported + + + Not equal + 6 + unsupported + + + Phonetic + 100 + unsupported + + + Stem + 101 + unsupported + + + Relevance + 102 + supported + + + AlwaysMatches + 103 + supported + +
Less than1supported
Less than or equal2supported
Equal3default
Greater or equal4supported
Greater than5supported
Not equal6unsupported
Phonetic100unsupported
Stem101unsupported
Relevance102supported
AlwaysMatches103supported
- + - The relation attributes - 1-5 are supported and work exactly as + The relation attributes 1-5 are supported and work exactly as expected. All ordering operations are based on a lexicographical ordering, expect when the @@ -922,23 +922,23 @@ this case, ordering is numerical. See . - Z> find @attr 1=Title @attr 2=1 music + Z> find @attr 1=Title @attr 2=1 music ... Number of hits: 11745, setno 1 ... - Z> find @attr 1=Title @attr 2=2 music + Z> find @attr 1=Title @attr 2=2 music ... Number of hits: 11771, setno 2 ... - Z> find @attr 1=Title @attr 2=3 music + Z> find @attr 1=Title @attr 2=3 music ... Number of hits: 532, setno 3 ... - Z> find @attr 1=Title @attr 2=4 music + Z> find @attr 1=Title @attr 2=4 music ... Number of hits: 11463, setno 4 ... - Z> find @attr 1=Title @attr 2=5 music + Z> find @attr 1=Title @attr 2=5 music ... Number of hits: 11419, setno 5 @@ -992,34 +992,34 @@ within the field or subfield in which it appears. - - - - - - - - - +
Position Attributes (type 3)
PositionValueNotes
+ Position Attributes (type 3) + + + + Position + Value + Notes + - - - - - - - - - - - - - - - + + First in field + 1 + unsupported + + + First in subfield + 2 + unsupported + + + Any position in field + 3 + supported + +
First in field 1unsupported
First in subfield2unsupported
Any position in field3supported
@@ -1049,102 +1049,101 @@ The default configuration is summarized in this table. - - - - - - - - - +
Structure Attributes (type 4)
StructureValueNotes
+ Structure Attributes (type 4) + + + + Structure + Value + Notes + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + Phrase + 1 + default + + + Word + 2 + supported + + + Key + 3 + supported + + + Year + 4 + supported + + + Date (normalized) + 5 + supported + + + Word list + 6 + supported + + + Date (un-normalized) + 100 + unsupported + + + Name (normalized) + 101 + unsupported + + + Name (un-normalized) + 102 + unsupported + + + Structure + 103 + unsupported + + + Urx + 104 + supported + + + Free-form-text + 105 + supported + + + Document-text + 106 + supported + + + Local-number + 107 + supported + + + String + 108 + unsupported + + + Numeric string + 109 + supported + +
Phrase 1default
Word2supported
Key3supported
Year4supported
Date (normalized)5supported
Word list6supported
Date (un-normalized)100unsupported
Name (normalized) 101unsupported
Name (un-normalized) 102unsupported
Structure103unsupported
Urx104supported
Free-form-text105supported
Document-text106supported
Local-number107supported
String108unsupported
Numeric string109supported
- The structure attribute values Word list (6) @@ -1202,15 +1201,16 @@ Z> find @attr 4=109 @attr 2=5 @attr gils 1=2038 -114 - + - The exact mapping between PQF queries and Zebra internal indexes - and index types is explained in + + The exact mapping between PQF queries and Zebra internal indexes + and index types is explained in . - - - - + + + + Truncation Attributes (type = 5) @@ -1221,54 +1221,54 @@ document hit set of a search query. - - - - - - - - - +
Truncation Attributes (type 5)
TruncationValueNotes
+ Truncation Attributes (type 5) + + + + Truncation + Value + Notes + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + Right truncation + 1 + supported + + + Left truncation + 2 + supported + + + Left and right truncation + 3 + supported + + + Do not truncate + 100 + default + + + Process # in search term + 101 + supported + + + RegExpr-1 + 102 + supported + + + RegExpr-2 + 103 + supported + +
Right truncation 1supported
Left truncation2supported
Left and right truncation3supported
Do not truncate100default
Process # in search term101supported
RegExpr-1 102supported
RegExpr-2103supported
@@ -1353,33 +1353,34 @@ (Complete field (3)). - - - - - - - - +
Completeness Attributes (type = 6)
CompletenessValueNotes
+ Completeness Attributes (type = 6) + + + + Completeness + Value + Notes + - - - - - - - - - - - - - - - + + Incomplete subfield + 1 + default + + + Complete subfield + 2 + deprecated + + + Complete field + 3 + supported + +
Incomplete subfield1default
Complete subfield2deprecated
Complete field3supported
@@ -1404,10 +1405,12 @@ - The exact mapping between PQF queries and Zebra internal indexes - and index types is explained in + + The exact mapping between PQF queries and Zebra internal indexes + and index types is explained in . - + + @@ -1455,11 +1458,12 @@ - The special string index _ALLRECORDS is - experimental, and the provided functionality and syntax may very - well change in future releases of Zebra. + + The special string index _ALLRECORDS is + experimental, and the provided functionality and syntax may very + well change in future releases of Zebra. + - @@ -1469,97 +1473,96 @@ recognized regardless of attribute set used in a search operation query. - - - - - - - - - - - + +
Zebra Search Attribute Extensions
NameValueOperationZebra version
+ Zebra Search Attribute Extensions + + + + Name + Value + Operation + Zebra version + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Embedded Sort7search1.1
Term Set8search1.1
Rank Weight9search1.1
Approx Limit9search1.4
Term Reference10search1.4
- + + + Embedded Sort + 7 + search + 1.1 + + + Term Set + 8 + search + 1.1 + + + Rank Weight + 9 + search + 1.1 + + + Approx Limit + 11 + search + 1.4 + + + Term Reference + 10 + search + 1.4 + + + + + Zebra Extension Embedded Sort Attribute (type 7) - - - The embedded sort is a way to specify sort within a query - thus - removing the need to send a Sort Request separately. It is both - faster and does not require clients to deal with the Sort - Facility. - - - - All ordering operations are based on a lexicographical ordering, - expect when the - structure attribute numeric (109) is used. In - this case, ordering is numerical. See + + The embedded sort is a way to specify sort within a query - thus + removing the need to send a Sort Request separately. It is both + faster and does not require clients to deal with the Sort + Facility. + + + + All ordering operations are based on a lexicographical ordering, + expect when the + structure attribute numeric (109) is used. In + this case, ordering is numerical. See . - - - - The possible values after attribute type 7 are - 1 ascending and - 2 descending. - The attributes+term (APT) node is separate from the - rest and must be @or'ed. - The term associated with APT is the sorting level in integers, - where 0 means primary sort, - 1 means secondary sort, and so forth. - See also . - - - For example, searching for water, sort by title (ascending) - - Z> find @or @attr 1=1016 water @attr 7=1 @attr 1=4 0 - - - - Or, searching for water, sort by title ascending, then date descending - - Z> find @or @or @attr 1=1016 water @attr 7=1 @attr 1=4 0 @attr 7=2 @attr 1=30 1 - - - + + + + The possible values after attribute type 7 are + 1 ascending and + 2 descending. + The attributes+term (APT) node is separate from the + rest and must be @or'ed. + The term associated with APT is the sorting level in integers, + where 0 means primary sort, + 1 means secondary sort, and so forth. + See also . + + + For example, searching for water, sort by title (ascending) + + Z> find @or @attr 1=1016 water @attr 7=1 @attr 1=4 0 + + + + Or, searching for water, sort by title ascending, then date descending + + Z> find @or @or @attr 1=1016 water @attr 7=1 @attr 1=4 0 @attr 7=2 @attr 1=30 1 + + + - - - - Experimental. Do not use in production code. - - - + --> + + + Experimental. Do not use in production code. + + + + @@ -1689,52 +1699,51 @@ Zebra extends the Bib1 attribute types, and these extensions are recognized regardless of attribute - set used in a scan operation query. + set used in a scan operation query. - - - - - - - - - - +
Zebra Scan Attribute Extensions
NameTypeOperationZebra version
+ Zebra Scan Attribute Extensions + + + + Name + Type + Operation + Zebra version + - - - - - - - - - - - - - - -
Result Set Narrow8scan1.3
Approximative Limit9scan1.4
- + + + Result Set Narrow + 8 + scan + 1.3 + + + Approximative Limit + 9 + scan + 1.4 + + + + + Zebra Extension Result Set Narrow (type 8) - - - If attribute Result Set Narrow (type 8) - is given for scan, the value is the name of a - result set. Each hit count in scan is - @and'ed with the result set given. - - - Consider for example - the case of scanning all title fields around the - scanterm mozart, then refining the scan by - issuing a filtering query for amadeus to - restrict the scan to the result set of the query: - + + If attribute Result Set Narrow (type 8) + is given for scan, the value is the name of a + result set. Each hit count in scan is + @and'ed with the result set given. + + + Consider for example + the case of scanning all title fields around the + scanterm mozart, then refining the scan by + issuing a filtering query for amadeus to + restrict the scan to the result set of the query: + Z> scan @attr 1=4 mozart ... * mozart (43) @@ -1753,42 +1762,42 @@ mozartiana (0) mozarts (1) ... - - - + + + - Experimental. Do not use in production code. - + + Experimental. Do not use in production code. + + + Zebra Extension Approximative Limit (type 11) - - - The Zebra Extension Approximative Limit (type - 11) is a way to enable approximate - hit counts for scan hit counts, in the same - way as for search hit counts. - - - - Experimental and buggy. Definitely not to be used in production code. - - - + --> + + + Experimental and buggy. Definitely not to be used in production code. + + + - Zebra special IDXPATH Attribute Set for GRS indexing The attribute-set idxpath consists of a single - Use (type 1) attribute. All non-use attributes - behave as normal. + Use (type 1) attribute. All non-use attributes behave as normal. This feature is enabled when defining the @@ -1798,9 +1807,12 @@ main Zebra configuration file zebra.cfg directive attset: idxpath.att must be enabled. - The idxpath is deprecated, may not be - supported in future Zebra versions, and should definitely - not be used in production code. + + + The idxpath is deprecated, may not be + supported in future Zebra versions, and should definitely + not be used in production code. + @@ -1810,57 +1822,59 @@ records by XPATH like structured index names. - The idxpath option defines hard-coded - index names, which might clash with your own index names. + + + The idxpath option defines hard-coded + index names, which might clash with your own index names. + - - - - - - - - - - +
Zebra specific IDXPATH Use Attributes (type 1)
IDXPATHValueString IndexNotes
+ Zebra specific IDXPATH Use Attributes (type 1) + + + + IDXPATH + Value + String Index + Notes + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + XPATH Begin + 1 + _XPATH_BEGIN + deprecated + + + XPATH End + 2 + _XPATH_END + deprecated + + + XPATH CData + 1016 + _XPATH_CDATA + deprecated + + + XPATH Attribute Name + 3 + _XPATH_ATTR_NAME + deprecated + + + XPATH Attribute CData + 1015 + _XPATH_ATTR_CDATA + deprecated + +
XPATH Begin1_XPATH_BEGINdeprecated
XPATH End2_XPATH_ENDdeprecated
XPATH CData1016_XPATH_CDATAdeprecated
XPATH Attribute Name3_XPATH_ATTR_NAMEdeprecated
XPATH Attribute CData1015_XPATH_ATTR_CDATAdeprecated
- See tab/idxpath.att for more information. @@ -1952,54 +1966,54 @@ All other access point types are Zebra specific, and non-portable. - - - +
Access point name mapping
+ Access point name mapping + - - - - - - + + Access Point + Type + Grammar + Notes + - - - - - - - - - - - - - - - - - - - - - - - - - -
Access PointTypeGrammarNotes
Use attributenumeric[1-9][1-9]*directly mapped to string index name
String index namestring[a-zA-Z](\-?[a-zA-Z0-9])*normalized name is used as internal string index name
Zebra internal index namezebra_[a-zA-Z](_?[a-zA-Z0-9])*hardwired internal string index name
XPATH special indexXPath/.*special xpath search for GRS indexed records
- - - Attribute set names and - string index names are normalizes - according to the following rules: all single - hyphens '-' are stripped, and all upper case - letters are folded to lower case. + + Use attribute + numeric + [1-9][1-9]* + directly mapped to string index name + + + String index name + string + [a-zA-Z](\-?[a-zA-Z0-9])* + normalized name is used as internal string index name + + + Zebra internal index name + zebra + _[a-zA-Z](_?[a-zA-Z0-9])* + hardwired internal string index name + + + XPATH special index + XPath + /.* + special xpath search for GRS indexed records + + + + + + + Attribute set names and + string index names are normalizes + according to the following rules: all single + hyphens '-' are stripped, and all upper case + letters are folded to lower case. - + Numeric use attributes are mapped to the Zebra internal @@ -2035,9 +2049,8 @@ 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 Use Any (1016) is - assumed. - The predefined use attribute sets + Bib-1 Use Any (1016) is assumed. + The predefined use attribute sets can be reconfigured by tweaking the configuration files tab/*.att, and new attribute sets can be defined by adding similar files in the @@ -2045,10 +2058,10 @@ - String indexes can be accessed directly, + String indexes can be accessed directly, independently which attribute set is in use. These are just ignored. The above mentioned name normalization applies. - String index names are defined in the + String index names are defined in the used indexing filter configuration files, for example in the GRS *.abs configuration files, or in the @@ -2056,10 +2069,10 @@ - Zebra internal indexes can be accessed directly, + Zebra internal indexes can be accessed directly, according to the same rules as the user defined - string indexes. The only difference is that - Zebra internal index names are hardwired, + string indexes. The only difference is that + Zebra internal index names are hardwired, all uppercase and must start with the character '_'. @@ -2089,87 +2102,87 @@ bitfields and string based text needs different rule sets. - - - +
Structure and completeness mapping to register types
+ Structure and completeness mapping to register types + - - - - - - - - - - + + phrase (@attr 4=1), word (@attr 4=2), word-list (@attr 4=6), free-form-text (@attr 4=105), or document-text (@attr 4=106) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
StructureCompletenessRegister typeNotes
+ + Structure + Completeness + Register type + Notes + + +
Incomplete field (@attr 6=1)Word ('w')Traditional tokenized and character normalized word index
+ + Incomplete field (@attr 6=1) + Word ('w') + Traditional tokenized and character normalized word index + + + phrase (@attr 4=1), word (@attr 4=2), word-list (@attr 4=6), free-form-text (@attr 4=105), or document-text (@attr 4=106) - complete field' (@attr 6=3)Phrase ('p')Character normalized, but not tokenized index for phrase + + complete field' (@attr 6=3) + Phrase ('p') + Character normalized, but not tokenized index for phrase matches -
urx (@attr 4=104)ignoredURX/URL ('u')Special index for URL web addresses
numeric (@attr 4=109)ignoredNumeric ('u')Special index for digital numbers
key (@attr 4=3)ignoredNull bitmap ('0')Used for non-tokenizated and non-normalized bit sequences
year (@attr 4=4)ignoredYear ('y')Non-tokenizated and non-normalized 4 digit numbers
date (@attr 4=5)ignoredDate ('d')Non-tokenizated and non-normalized ISO date strings
ignoredignoredSort ('s')Used with special sort attribute set (@attr 7=1, @attr 7=2)
overruledoverruledspecialInternal record ID register, used whenever - Relation Always Matches (@attr 2=103) is specified
- + + + + urx (@attr 4=104) + ignored + URX/URL ('u') + Special index for URL web addresses + + + numeric (@attr 4=109) + ignored + Numeric ('u') + Special index for digital numbers + + + key (@attr 4=3) + ignored + Null bitmap ('0') + Used for non-tokenizated and non-normalized bit sequences + + + year (@attr 4=4) + ignored + Year ('y') + Non-tokenizated and non-normalized 4 digit numbers + + + date (@attr 4=5) + ignored + Date ('d') + Non-tokenizated and non-normalized ISO date strings + + + ignored + ignored + Sort ('s') + Used with special sort attribute set (@attr 7=1, @attr 7=2) + + + overruled + overruled + special + Internal record ID register, used whenever + Relation Always Matches (@attr 2=103) is specified + + + + + @@ -2183,7 +2196,7 @@ GRS *.abs file that contains a p-specifier. - Z> scan @attr 1=Title @attr 4=1 @attr 6=3 beethoven + Z> scan @attr 1=Title @attr 4=1 @attr 6=3 beethoven ... bayreuther festspiele (1) * beethoven bibliography database (1) @@ -2209,7 +2222,7 @@ The word search is performed on those fields that are indexed as type w in the GRS *.abs file. - Z> scan @attr 1=Title @attr 4=1 @attr 6=1 beethoven + Z> scan @attr 1=Title @attr 4=1 @attr 6=1 beethoven ... beefheart (1) * beethoven (18) @@ -2298,77 +2311,68 @@ Both query types follow the same syntax with the operands: - - - - - - - - - - - - - - - - - - -
Regular Expression Operands
xMatches the character x.
.Matches any character.
[ .. ]Matches the set of characters specified; - such as [abc] or [a-c].
+ + Regular Expression Operands + + + + x + Matches the character x. + + + . + Matches any character. + + + [ .. ] + Matches the set of characters specified; + such as [abc] or [a-c]. + + + +
The above operands can be combined with the following operators: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Regular Expression 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.
- + + + Regular Expression 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 -- 1.7.10.4