X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Frecordmodel.xml;h=8ad29e8c01e62584efbabadceecbdfd62d19b06f;hb=aa36decbdd330b8858eac641056bf607a8eea8a1;hp=960cc37c298e02aaf8a6ac314a3df53d01ff66b8;hpb=9c7cf0ea5cde299283402db722e308c041ec2db7;p=idzebra-moved-to-github.git diff --git a/doc/recordmodel.xml b/doc/recordmodel.xml index 960cc37..8ad29e8 100644 --- a/doc/recordmodel.xml +++ b/doc/recordmodel.xml @@ -1,5 +1,5 @@ - + The Record Model @@ -8,7 +8,7 @@ kind of structured data. Each record in the system is associated with a record schema which lends context to the data elements of the record. - Any number of record schema can coexist in the system. + Any number of record schemas can coexist in the system. Although it may be wise to use only a single schema within one database, the system poses no such restrictions. @@ -16,10 +16,12 @@ The record model described in this chapter applies to the fundamental, structured - record type grs as introduced in + record type grs, introduced in . + @@ -40,7 +42,8 @@ input filter by preparing conversion rules based on regular expressions and possibly augmented by a flexible scripting language (Tcl). - The input filter produces as output an internal representation: + The input filter produces as output an internal representation, + a tree structure. @@ -92,7 +95,7 @@ subsequent sections. Zebra can read structured records in many different formats. How this is done is governed by additional parameters after the - "grs" keyboard, separated by "." characters. + "grs" keyword, separated by "." characters. @@ -183,29 +186,32 @@ <Distributor> - <Name> USGS/WRD </Name> - <Organization> USGS/WRD </Organization> - <Street-Address> - U.S. GEOLOGICAL SURVEY, 505 MARQUETTE, NW - </Street-Address> - <City> ALBUQUERQUE </City> - <State> NM </State> - <Zip-Code> 87102 </Zip-Code> - <Country> USA </Country> - <Telephone> (505) 766-5560 </Telephone> + <Name> USGS/WRD </Name> + <Organization> USGS/WRD </Organization> + <Street-Address> + U.S. GEOLOGICAL SURVEY, 505 MARQUETTE, NW + </Street-Address> + <City> ALBUQUERQUE </City> + <State> NM </State> + <Zip-Code> 87102 </Zip-Code> + <Country> USA </Country> + <Telephone> (505) 766-5560 </Telephone> </Distributor> - - + + The keywords surrounded by <...> are tags, while the sections of text @@ -215,7 +221,7 @@ Each element is terminated by a closing tag - beginning with </, and containing the same symbolic tag-name as the corresponding opening tag. - The general closing tag - <>/ - + The general closing tag - </> - terminates the element started by the last opening tag. The structuring of elements is significant. The element Telephone, @@ -246,7 +252,7 @@ <gils> - <title>Zen and the Art of Motorcycle Maintenance</title> + <title>Zen and the Art of Motorcycle Maintenance</title> </gils> @@ -254,7 +260,7 @@ - + Variants @@ -299,7 +305,7 @@ tag with the same class and value settings, or by the appearance of another, normal tag. In other words, the end-tags for - the variants used in the example above could have been saved. + the variants used in the example above could have been omitted. @@ -455,12 +461,12 @@ - An action is surrounded by curly braces ({...}), and + An action is surrounded by curly braces ({...}), and consists of a sequence of statements. Statements may be separated by newlines or semicolons (;). Within actions, the strings that matched the expressions immediately preceding the action can be referred to as - $0, $1, $2, etc. + $0, $1, $2, etc. @@ -471,7 +477,7 @@ - begin type [parameter ... ] + begin type [parameter ... ] Begin a new @@ -534,7 +540,7 @@ - end [type] + end [type] Close a tagged element. If no parameter is given, @@ -603,9 +609,9 @@ - TITLE "Zen and the Art of Motorcycle Maintenance" ROOT - AUTHOR "Robert Pirsig" + TITLE "Zen and the Art of Motorcycle Maintenance" + AUTHOR "Robert Pirsig" @@ -618,11 +624,11 @@ - TITLE "Zen and the Art of Motorcycle Maintenance" ROOT - FIRST-NAME "Robert" - AUTHOR - SURNAME "Pirsig" + TITLE "Zen and the Art of Motorcycle Maintenance" + AUTHOR + FIRST-NAME "Robert" + SURNAME "Pirsig" @@ -702,12 +708,11 @@ tree). - - + @@ -733,9 +738,9 @@ or all of the following: - + @@ -758,7 +763,7 @@ - The Tag set (again, this can consist of several different sets). + The tag set (again, this can consist of several different sets). This is used when reading the records from a file, to recognize the different tags, and when transmitting the record to the client - mapping the tags to their numerical representation, if they are @@ -836,8 +841,8 @@ Generally, the files are simple ASCII files, which can be maintained - using any text editor. Blank lines, and lines beginning with a (#) are - ignored. Any characters on a line followed by a (#) are also ignored. + using any text editor. Blank lines, and lines beginning with a (#) are + ignored. Any characters on a line followed by a (#) are also ignored. All other lines contain directives, which provide some setting or value to the system. Generally, settings are characterized by a single @@ -849,7 +854,7 @@ - + The Abstract Syntax (.abs) Files @@ -1124,7 +1129,7 @@ att - att-value att-name [local-value] + att-value att-name [local-value] (o,r) This @@ -1459,7 +1464,7 @@ simpleElement - path ['variant' variant-request] + path ['variant' variant-request] (o,r) This corresponds to a simple element request @@ -1559,12 +1564,12 @@ is assumed by the MARC family in Z39.50. - + These are the directives of the schema mapping file format: @@ -1614,11 +1619,11 @@ header of the record. - - NOTE: FIXME! This will be described better. We're in the process of + @@ -1744,9 +1749,9 @@ - Curly braces {} may be used to enclose ranges of single + Curly braces {} may be used to enclose ranges of single characters (possibly using the escape convention described in the - preceding point), eg. {a-z} to introduce the + preceding point), eg. {a-z} to introduce the standard range of ASCII characters. Note that the interpretation of such a range depends on the concrete representation in your local, physical character set. @@ -1850,7 +1855,7 @@ is used to show the hierarchical structure of the record. All "GRS" type records support both the GRS-1 and SUTRS representations. - FIXME - What is SUTRS - should be expanded here + @@ -1893,7 +1898,7 @@ abstract syntaxes can be mapped to the SOIF format, although nested elements are represented by concatenation of the tag names at each level. - FIXME - Is this used anywhere ? -H +