From: Adam Dickmeiss Date: Thu, 31 Oct 2002 10:11:39 +0000 (+0000) Subject: Brief description of xelm X-Git-Tag: ZEBRA.1.3.4~55 X-Git-Url: http://sru.miketaylor.org.uk/cgi-bin?a=commitdiff_plain;h=49f49aa27c8d63cea66dfb5a9e06e5735c835509;p=idzebra-moved-to-github.git Brief description of xelm --- diff --git a/doc/recordmodel.xml b/doc/recordmodel.xml index 8ad29e8..b438f33 100644 --- a/doc/recordmodel.xml +++ b/doc/recordmodel.xml @@ -1,5 +1,5 @@ - + The Record Model @@ -33,7 +33,7 @@ - + When records are accessed by the system, they are represented in their local, or native format. This might be SGML or HTML files, @@ -483,7 +483,7 @@ Begin a new data element. The type is one of the following: - + record @@ -692,35 +692,35 @@ Which of the two elements are transmitted to the client by the server depends on the specifications provided by the client, if any. - + In practice, each variant node is associated with a triple of class, type, value, corresponding to the variant mechanism of Z39.50. - + - + Data Elements - + Data nodes have no children (they are always leaf nodes in the record tree). - + - + - + Configuring Your Data Model - + The following sections describe the configuration files that govern the internal management of data records. The system searches for the files @@ -770,7 +770,7 @@ known. - + The variant set which is used in the profile. This provides a @@ -884,12 +884,12 @@ The file may contain the following directives: - + - + - name symbolic-name + name symbolic-name (m) This provides a shorthand name or @@ -898,17 +898,17 @@ - reference OID-name + reference OID-name (m) The reference name of the OID for the profile. The reference names can be found in the util - module of YAZ. + module of YAZ. - attset filename + attset filename (m) The attribute set that is used for @@ -917,7 +917,7 @@ - tagset filename + tagset filename (o) The tag set (if any) that describe @@ -926,7 +926,7 @@ - varset filename + varset filename (o) The variant set used in the profile. @@ -934,25 +934,27 @@ - maptab filename + maptab filename (o,r) This points to a conversion table that might be used if the client asks for the record in a different schema from the native one. - + + - marc filename + marc filename (o) Points to a file containing parameters - for representing the record contents in the ISO2709 syntax. Read the - description of the MARC representation facility below. + for representing the record contents in the ISO2709 syntax. + Read the description of the MARC representation facility below. - + + - esetname name filename + esetname name filename (o,r) Associates the @@ -960,9 +962,10 @@ given in place of the filename, this corresponds to a null mapping for the given element set name. - + + - any tags + any tags (o) This directive specifies a list of attributes @@ -972,49 +975,74 @@ provides an efficient way of supporting free-text searching across all elements. However, it does increase the size of the index significantly. The attributes can be qualified with a structure, as in - the elm directive below. + the elm directive below. - + + - elm path name attributes + elm path name attributes (o,r) Adds an element to the abstract record syntax of the schema. - The path follows the + The path follows the syntax which is suggested by the Z39.50 document - that is, a sequence - of tags separated by slashes (/). Each tag is given as a + of tags separated by slashes (/). Each tag is given as a comma-separated pair of tag type and -value surrounded by parenthesis. - The name is the name of the element, and - the attributes + The name is the name of the element, and + the attributes specifies which attributes to use when indexing the element in a comma-separated list. A ! in place of the attribute name is equivalent to specifying an attribute name identical to the element name. A - in place of the attribute name specifies that no indexing is to take place for the given element. - The attributes can be qualified with field - types to specify which + The attributes can be qualified with field + types to specify which character set should govern the indexing procedure for that field. The same data element may be indexed into several different fields, using different character set definitions. See the . - The default field type is "w" for word. + The default field type is w for + word. - + + + - encoding encodingname + xelm xpath attributes + + + Specifies indexing for record nodes given by + xpath. Unlike directive + 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. + + + + + + + encoding encodingname This directive specifies character encoding for external records. For records such as XML that specifies encoding within the file via a header this directive is ignored. If neither this directive is given, nor an encoding is set - within external records, ISO-8859-1 encoding is assmed. + within external records, ISO-8859-1 encoding is assumed. - xpath enable/disable + xpath enable/disable If this directive is followed by enable, @@ -1085,7 +1113,7 @@ The Attribute Set (.att) Files - This file type describes the Use elements of + This file type describes the Use elements of an attribute set. It contains the following directives. @@ -1093,7 +1121,7 @@ - name symbolic-name + name symbolic-name (m) This provides a shorthand name or @@ -1102,24 +1130,24 @@ - reference OID-name + reference OID-name (m) The reference name of the OID for the attribute set. - The reference names can be found in the util - module of YAZ. + The reference names can be found in the util + module of YAZ. - include filename + include filename (o,r) This directive is used to include another attribute set as a part of the current one. This is used when a new attribute set is defined as an extension to another set. For instance, many new attribute sets are defined as extensions - to the bib-1 set. + to the bib-1 set. This is an important feature of the retrieval system of Z39.50, as it ensures the highest possible level of interoperability, as those access points of your database which are @@ -1129,15 +1157,15 @@ att - att-value att-name [local-value] + att-value att-name [local-value] (o,r) This repeatable directive introduces a new attribute to the set. The attribute value is stored in the index (unless a - local-value is + local-value is given, in which case this is stored). The name is used to refer to the - attribute from the abstract syntax. + attribute from the abstract syntax.