X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Frecordmodel.xml;h=660c95ed678dae2718675beee2775cadd2c66c4c;hb=4fe772289b1ab968655c27b144d08fc69c113fd9;hp=d9e5006c325fd3540be12deece2a52e02b582846;hpb=79dbb0556936ee101483f693d38bd5e97c49689e;p=idzebra-moved-to-github.git diff --git a/doc/recordmodel.xml b/doc/recordmodel.xml index d9e5006..660c95e 100644 --- a/doc/recordmodel.xml +++ b/doc/recordmodel.xml @@ -1,5 +1,5 @@ - + The Record Model @@ -18,6 +18,8 @@ structured record type grs as introduced in . + FIXME - Need to describe the simple string-tag model, or at least + refer to it here. -H @@ -132,7 +134,7 @@ This allows Zebra to read records in the ISO2709 (MARC) encoding standard. In this case, the - last paramemeter abstract syntax names the + last parameter abstract syntax names the .abs file (see below) which describes the specific MARC structure of the input record as well as the indexing rules. @@ -188,7 +190,7 @@ The indentation used above is used to illustrate how Zebra - interprets the markup. The indentation, in itself, has no + interprets the mark-up. The indentation, in itself, has no significance to the parser for the canonical input format, which discards superfluous whitespace. @@ -431,7 +433,7 @@ FINISH - The expression asssociated with this pattern is evaluated + The expression associated with this pattern is evaluated once, before the application terminates. It can be used to release system resources - typically ones allocated in the INIT step. @@ -469,7 +471,7 @@ record - Begin a new record. The followingparameter should be the + Begin a new record. The following parameter should be the name of the schema that describes the structure of the record, eg. gils or wais (see below). The begin record call should precede @@ -691,7 +693,7 @@ - Documentation needs extension here about types of nodes - numerical, + FIXME! Documentation needs extension here about types of nodes - numerical, textual, etc., plus the various types of inclusion notes. @@ -721,6 +723,10 @@ + FIXME - Need a diagram here, or a simple explanation how it all hangs together -H + + + @@ -826,7 +832,7 @@ Generally, settings are characterized by a single keyword, identifying the setting, followed by a number of parameters. Some settings are repeatable (r), while others may occur only once in a - file. Some settings are optional (o), whicle others again are + file. Some settings are optional (o), while others again are mandatory (m). @@ -1183,7 +1189,7 @@ The names parameter is a list of names by which the tag should be recognized in the input file format. The names should be separated by slashes (/). - The type is th recommended datatype of + The type is the recommended data type of the tag. It should be one of the following: @@ -1520,7 +1526,7 @@ - NOTE: The schema-mapping functions are so far limited to a + NOTE: FIXME! The schema-mapping functions are so far limited to a straightforward mapping of elements. This should be extended with mechanisms for conversions of the element contents, and conditional mappings of elements based on the record contents. @@ -1575,7 +1581,7 @@ - NOTE: This will be described better. We're in the process of + NOTE: FIXME! This will be described better. We're in the process of re-evaluating and most likely changing the way that MARC records are handled by the system. @@ -1697,8 +1703,8 @@ (preceded by x). In addition, the combinations \\, \\r, \\n, \\t, \\s (space — remember that real - space-characters may ot occur in the value definition), and - \\ are recognised, with their usual interpretation. + space-characters may not occur in the value definition), and + \\ are recognized, with their usual interpretation. @@ -1706,7 +1712,7 @@ 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 entroduce 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. @@ -1806,10 +1812,11 @@ - SUTRS. Again, the mapping is fairly straighforward. Indentation + SUTRS. Again, the mapping is fairly straightforward. Indentation 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 @@ -1852,6 +1859,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 ? What is SOIF anyway? -H