projects
/
idzebra-moved-to-github.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
data1 cleanup
[idzebra-moved-to-github.git]
/
doc
/
recordmodel.xml
diff --git
a/doc/recordmodel.xml
b/doc/recordmodel.xml
index
d9e5006
..
660c95e
100644
(file)
--- a/
doc/recordmodel.xml
+++ b/
doc/recordmodel.xml
@@
-1,5
+1,5
@@
<chapter id="record-model">
<chapter id="record-model">
- <!-- $Id: recordmodel.xml,v 1.1 2002-04-09 13:26:26 adam Exp $ -->
+ <!-- $Id: recordmodel.xml,v 1.3 2002-04-10 14:47:49 heikki Exp $ -->
<title>The Record Model</title>
<para>
<title>The Record Model</title>
<para>
@@
-18,6
+18,8
@@
structured
record type <literal>grs</literal> as introduced in
<xref linkend="record-types"/>.
structured
record type <literal>grs</literal> as introduced in
<xref linkend="record-types"/>.
+ FIXME - Need to describe the simple string-tag model, or at least
+ refer to it here. -H
</para>
<para>
</para>
<para>
@@
-132,7
+134,7
@@
<para>
This allows Zebra to read
records in the ISO2709 (MARC) encoding standard. In this case, the
<para>
This allows Zebra to read
records in the ISO2709 (MARC) encoding standard. In this case, the
- last paramemeter <emphasis>abstract syntax</emphasis> names the
+ last parameter <emphasis>abstract syntax</emphasis> names the
<literal>.abs</literal> file (see below)
which describes the specific MARC structure of the input record as
well as the indexing rules.
<literal>.abs</literal> file (see below)
which describes the specific MARC structure of the input record as
well as the indexing rules.
@@
-188,7
+190,7
@@
<note>
<para>
The indentation used above is used to illustrate how Zebra
<note>
<para>
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.
</para>
significance to the parser for the canonical input format, which
discards superfluous whitespace.
</para>
@@
-431,7
+433,7
@@
<term>FINISH</term>
<listitem>
<para>
<term>FINISH</term>
<listitem>
<para>
- 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
<emphasis>INIT</emphasis> step.
once, before the application terminates. It can be used to release
system resources - typically ones allocated in the
<emphasis>INIT</emphasis> step.
@@
-469,7
+471,7
@@
<term>record</term>
<listitem>
<para>
<term>record</term>
<listitem>
<para>
- 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.
<literal>gils</literal> or <literal>wais</literal> (see below).
The <literal>begin record</literal> call should precede
name of the schema that describes the structure of the record, eg.
<literal>gils</literal> or <literal>wais</literal> (see below).
The <literal>begin record</literal> call should precede
@@
-691,7
+693,7
@@
<note>
<para>
<note>
<para>
- 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.
</para>
</note>
textual, etc., plus the various types of inclusion notes.
</para>
</note>
@@
-721,6
+723,10
@@
</para>
<para>
</para>
<para>
+ FIXME - Need a diagram here, or a simple explanation how it all hangs together -H
+ </para>
+
+ <para>
<itemizedlist>
<listitem>
<itemizedlist>
<listitem>
@@
-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
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).
</para>
mandatory (m).
</para>
@@
-1183,7
+1189,7
@@
The <emphasis>names</emphasis> 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 <emphasis>names</emphasis> 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 <emphasis>type</emphasis> is th recommended datatype of
+ The <emphasis>type</emphasis> is the recommended data type of
the tag.
It should be one of the following:
the tag.
It should be one of the following:
@@
-1520,7
+1526,7
@@
</para>
<para>
</para>
<para>
- <emphasis>NOTE: The schema-mapping functions are so far limited to a
+ <emphasis>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.</emphasis>
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.</emphasis>
@@
-1575,7
+1581,7
@@
</para>
<para>
</para>
<para>
- <emphasis>NOTE: This will be described better. We're in the process of
+ <emphasis>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.</emphasis>
</para>
re-evaluating and most likely changing the way that MARC records are
handled by the system.</emphasis>
</para>
@@
-1697,8
+1703,8
@@
(preceded by <literal>x</literal>).
In addition, the combinations
\\, \\r, \\n, \\t, \\s (space — remember that real
(preceded by <literal>x</literal>).
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.
</para>
</listitem>
</para>
</listitem>
@@
-1706,7
+1712,7
@@
<para>
Curly braces {} may be used to enclose ranges of single
characters (possibly using the escape convention described in the
<para>
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.
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
@@
<listitem>
<para>
<listitem>
<para>
- 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.
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
</para>
</listitem>
</para>
</listitem>
@@
-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.
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
</para>
</listitem>
</para>
</listitem>