X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Frecordmodel.xml;h=e052f12e5b3218284191075410fea08fcdd37506;hb=230fdc17aa503a23c842cd587f241cfe2fce1c0d;hp=b438f33a51c3e678833fce486a27a640ac8e288a;hpb=49f49aa27c8d63cea66dfb5a9e06e5735c835509;p=idzebra-moved-to-github.git diff --git a/doc/recordmodel.xml b/doc/recordmodel.xml index b438f33..e052f12 100644 --- a/doc/recordmodel.xml +++ b/doc/recordmodel.xml @@ -1,5 +1,5 @@ - + The Record Model @@ -477,11 +477,12 @@ - begin type [parameter ... ] + begin type [parameter ... ] Begin a new - data element. The type is one of the following: + data element. The type is one of + the following: @@ -492,7 +493,7 @@ name of the schema that describes the structure of the record, eg. gils or wais (see below). The begin record call should precede - any other use of the begin statement. + any other use of the begin statement. @@ -512,7 +513,7 @@ Begin a new node in a variant tree. The parameters are - class type value. + class type value. @@ -521,7 +522,7 @@ - data + data parameter Create a data element. The concatenated arguments make @@ -530,28 +531,41 @@ the layout (whitespace) of the data should be retained for transmission. The option -element - tag wraps the data up in - the tag. + tag wraps the data up in + the tag. The use of the -element option is equivalent to - preceding the command with a begin - element command, and following - it with the end command. + preceding the command with a begin + element command, and following + it with the end command. - end [type] + end [type] Close a tagged element. If no parameter is given, the last element on the stack is terminated. The first parameter, if any, is a type name, similar - to the begin statement. - For the element type, a tag + to the begin statement. + For the element type, a tag name can be provided to terminate a specific tag. + + + unread no + + + Move the input pointer to the offset of first character that + match rule given by no. + The first rule from left-to-right is numbered zero, + the second rule is named 1 and so on. + + + + @@ -571,23 +585,21 @@ /^Subject:/ BODY /$/ { data -element title $1 } /^Date:/ BODY /$/ { data -element lastModified $1 } /\n\n/ BODY END { - begin element bodyOfDisplay - begin variant body iana "text/plain" - data -text $1 - end record + begin element bodyOfDisplay + begin variant body iana "text/plain" + data -text $1 + end record } - If Zebra is compiled with support for Tcl (Tool Command Language) - enabled, the statements described above are supplemented with a complete + If Zebra is compiled with support for Tcl enabled, the statements + described above are supplemented with a complete scripting environment, including control structures (conditional expressions and loop constructs), and powerful string manipulation - mechanisms for modifying the elements of a record. Tcl is a popular - scripting environment, with several tutorials available both online - and in hardcopy. + mechanisms for modifying the elements of a record. @@ -1017,8 +1029,8 @@ elm, this directive allows you to index attribute contents. The xpath uses a syntax similar to XPath. The attributes - have same syntax and meaning as directive elm, except that ! - refers to the nodes selected by xpath. + have same syntax and meaning as directive elm, except that operator + ! refers to the nodes selected by xpath. + + + + + systag + systemTag + actualTag + + + + Specifies what information, if any, Zebra should + automatically include in retrieval records for the + ``system fields'' that it supports. + systemTag may + be any of the following: + + + rank + + An integer indicating the relevance-ranking score + assigned to the record. + + + + sysno + + An automatically generated identifier for the record, + unique within this database. It is represented by the + <localControlNumber> element in + XML and the (1,14) tag in GRS-1. + + + + size + + The size, in bytes, of the retrieved record. + + + + + + The actualTag parameter may be + none to indicate that the named element + should be omitted from retrieval records. + + + @@ -1086,23 +1195,23 @@ esetname G gils-g.est esetname F @ - elm (1,10) rank - - elm (1,12) url - - elm (1,14) localControlNumber Local-number - elm (1,16) dateOfLastModification Date/time-last-modified - elm (2,1) title w:!,p:! - elm (4,1) controlIdentifier Identifier-standard - elm (2,6) abstract Abstract - elm (4,51) purpose ! - elm (4,52) originator - - elm (4,53) accessConstraints ! - elm (4,54) useConstraints ! - elm (4,70) availability - - elm (4,70)/(4,90) distributor - - elm (4,70)/(4,90)/(2,7) distributorName ! - elm (4,70)/(4,90)/(2,10 distributorOrganization ! - elm (4,70)/(4,90)/(4,2) distributorStreetAddress ! - elm (4,70)/(4,90)/(4,3) distributorCity ! + elm (1,10) rank - + elm (1,12) url - + elm (1,14) localControlNumber Local-number + elm (1,16) dateOfLastModification Date/time-last-modified + elm (2,1) title w:!,p:! + elm (4,1) controlIdentifier Identifier-standard + elm (2,6) abstract Abstract + elm (4,51) purpose ! + elm (4,52) originator - + elm (4,53) accessConstraints ! + elm (4,54) useConstraints ! + elm (4,70) availability - + elm (4,70)/(4,90) distributor - + elm (4,70)/(4,90)/(2,7) distributorName ! + elm (4,70)/(4,90)/(2,10) distributorOrganization ! + elm (4,70)/(4,90)/(4,2) distributorStreetAddress ! + elm (4,70)/(4,90)/(4,3) distributorCity !