doc/field-structure.xml

   1  <chapter id="fields-and-charsets">
   2   <!-- $Id: field-structure.xml,v 1.4 2006-11-13 14:53:40 marc Exp $ -->
   3   <title>Field Structure and Character Sets
   4   </title>
   5
   6   <para>
   7    In order to provide a flexible approach to national character set
   8    handling, Zebra allows the administrator to configure the set up the
   9    system to handle any 8-bit character set &mdash; including sets that
  10    require multi-octet diacritics or other multi-octet characters. The
  11    definition of a character set includes a specification of the
  12    permissible values, their sort order (this affects the display in the
  13    SCAN function), and relationships between upper- and lowercase
  14    characters. Finally, the definition includes the specification of
  15    space characters for the set.
  16   </para>
  17
  18   <para>
  19    The operator can define different character sets for different fields,
  20    typical examples being standard text fields, numerical fields, and
  21    special-purpose fields such as WWW-style linkages (URx).
  22   </para>
  23
  24   <section id="default-idx-file">
  25    <title>The default.idx file</title>
  26    <para>
  27     The field types, and hence character sets, are associated with data
  28     elements by the .abs files (see above).
  29     The file <literal>default.idx</literal>
  30     provides the association between field type codes (as used in the .abs
  31     files) and the character map files (with the .chr suffix). The format
  32     of the .idx file is as follows
  33    </para>
  34
  35    <para>
  36     <variablelist>
  37
  38      <varlistentry>
  39       <term>index <replaceable>field type code</replaceable></term>
  40       <listitem>
  41        <para>
  42         This directive introduces a new search index code.
  43         The argument is a one-character code to be used in the
  44         .abs files to select this particular index type. An index, roughly,
  45         corresponds to a particular structure attribute during search. Refer
  46         to <xref linkend="zebrasrv-search"/>.
  47        </para>
  48       </listitem></varlistentry>
  49      <varlistentry>
  50       <term>sort <replaceable>field code type</replaceable></term>
  51       <listitem>
  52        <para>
  53         This directive introduces a
  54         sort index. The argument is a one-character code to be used in the
  55         .abs fie to select this particular index type. The corresponding
  56         use attribute must be used in the sort request to refer to this
  57         particular sort index. The corresponding character map (see below)
  58         is used in the sort process.
  59        </para>
  60       </listitem></varlistentry>
  61      <varlistentry>
  62       <term>completeness <replaceable>boolean</replaceable></term>
  63       <listitem>
  64        <para>
  65         This directive enables or disables complete field indexing.
  66         The value of the <replaceable>boolean</replaceable> should be 0
  67         (disable) or 1. If completeness is enabled, the index entry will
  68         contain the complete contents of the field (up to a limit), with words
  69         (non-space characters) separated by single space characters
  70         (normalized to " " on display). When completeness is
  71         disabled, each word is indexed as a separate entry. Complete subfield
  72         indexing is most useful for fields which are typically browsed (eg.
  73         titles, authors, or subjects), or instances where a match on a
  74         complete subfield is essential (eg. exact title searching). For fields
  75         where completeness is disabled, the search engine will interpret a
  76         search containing space characters as a word proximity search.
  77        </para>
  78       </listitem></varlistentry>
  79
  80      <varlistentry id="default.idx.firstinfield">
  81       <term>firstinfield <replaceable>boolean</replaceable></term>
  82       <listitem>
  83        <para>
  84         This directive enables or disables first-in-field indexing.
  85         The value of the <replaceable>boolean</replaceable> should be 0
  86         (disable) or 1.
  87        </para>
  88       </listitem></varlistentry>
  89
  90      <varlistentry id="default.idx.alwaysmatches">
  91       <term>alwaysmatches <replaceable>boolean</replaceable></term>
  92       <listitem>
  93        <para>
  94         This directive enables or disables alwaysmatches indexing.
  95         The value of the <replaceable>boolean</replaceable> should be 0
  96         (disable) or 1.
  97        </para>
  98       </listitem></varlistentry>
  99
 100      <varlistentry>
 101       <term>charmap <replaceable>filename</replaceable></term>
 102       <listitem>
 103        <para>
 104         This is the filename of the character
 105         map to be used for this index for field type.
 106        </para>
 107       </listitem></varlistentry>
 108     </variablelist>
 109    </para>
 110   </section>
 111
 112   <section id="character-map-files">
 113    <title>The character map file format</title>
 114    <para>
 115     The contents of the character map files are structured as follows:
 116    </para>
 117
 118    <para>
 119     <variablelist>
 120
 121      <varlistentry>
 122       <term>lowercase <replaceable>value-set</replaceable></term>
 123       <listitem>
 124        <para>
 125         This directive introduces the basic value set of the field type.
 126         The format is an ordered list (without spaces) of the
 127         characters which may occur in "words" of the given type.
 128         The order of the entries in the list determines the
 129         sort order of the index. In addition to single characters, the
 130         following combinations are legal:
 131        </para>
 132
 133        <para>
 134
 135         <itemizedlist>
 136          <listitem>
 137           <para>
 138            Backslashes may be used to introduce three-digit octal, or
 139            two-digit hex representations of single characters
 140            (preceded by <literal>x</literal>).
 141            In addition, the combinations
 142            \\, \\r, \\n, \\t, \\s (space &mdash; remember that real
 143            space-characters may not occur in the value definition), and
 144            \\ are recognized, with their usual interpretation.
 145           </para>
 146          </listitem>
 147
 148          <listitem>
 149           <para>
 150            Curly braces {} may be used to enclose ranges of single
 151            characters (possibly using the escape convention described in the
 152            preceding point), eg. {a-z} to introduce the
 153            standard range of ASCII characters.
 154            Note that the interpretation of such a range depends on
 155            the concrete representation in your local, physical character set.
 156           </para>
 157          </listitem>
 158
 159          <listitem>
 160           <para>
 161            paranthesises () may be used to enclose multi-byte characters -
 162            eg. diacritics or special national combinations (eg. Spanish
 163            "ll"). When found in the input stream (or a search term),
 164            these characters are viewed and sorted as a single character, with a
 165            sorting value depending on the position of the group in the value
 166            statement.
 167           </para>
 168          </listitem>
 169
 170         </itemizedlist>
 171
 172        </para>
 173       </listitem></varlistentry>
 174      <varlistentry>
 175       <term>uppercase <replaceable>value-set</replaceable></term>
 176       <listitem>
 177        <para>
 178         This directive introduces the
 179         upper-case equivalencis to the value set (if any). The number and
 180         order of the entries in the list should be the same as in the
 181         <literal>lowercase</literal> directive.
 182        </para>
 183       </listitem></varlistentry>
 184      <varlistentry>
 185       <term>space <replaceable>value-set</replaceable></term>
 186       <listitem>
 187        <para>
 188         This directive introduces the character
 189         which separate words in the input stream. Depending on the
 190         completeness mode of the field in question, these characters either
 191         terminate an index entry, or delimit individual "words" in
 192         the input stream. The order of the elements is not significant &mdash;
 193         otherwise the representation is the same as for the
 194         <literal>uppercase</literal> and <literal>lowercase</literal>
 195         directives.
 196        </para>
 197       </listitem></varlistentry>
 198      <varlistentry>
 199       <term>map <replaceable>value-set</replaceable>
 200        <replaceable>target</replaceable></term>
 201       <listitem>
 202        <para>
 203         This directive introduces a mapping between each of the
 204         members of the value-set on the left to the character on the
 205         right. The character on the right must occur in the value
 206         set (the <literal>lowercase</literal> directive) of the
 207         character set, but it may be a paranthesis-enclosed
 208         multi-octet character. This directive may be used to map
 209         diacritics to their base characters, or to map HTML-style
 210         character-representations to their natural form, etc. The
 211         map directive can also be used to ignore leading articles in
 212         searching and/or sorting, and to perform other special
 213         transformations. See section <xref
 214          linkend="leading-articles"/>.
 215        </para>
 216       </listitem></varlistentry>
 217     </variablelist>
 218    </para>
 219   </section>
 220   <section id="leading-articles">
 221    <title>Ignoring leading articles</title>
 222    <para>
 223     In addition to specifying sort orders, space (blank) handling,
 224     and upper/lowercase folding, you can also use the character map
 225     files to make Zebra ignore leading articles in sorting records,
 226     or when doing complete field searching.
 227    </para>
 228    <para>
 229     This is done using the <literal>map</literal> directive in the
 230     character map file. In a nutshell, what you do is map certain
 231     sequences of characters, when they occur <emphasis> in the
 232      beginning of a field</emphasis>, to a space. Assuming that the
 233     character "@" is defined as a space character in your file, you
 234     can do:
 235     <screen>
 236      map (^The\s) @
 237      map (^the\s) @
 238     </screen>
 239     The effect of these directives is to map either 'the' or 'The',
 240     followed by a space character, to a space. The hat ^ character
 241     denotes beginning-of-field only when complete-subfield indexing
 242     or sort indexing is taking place; otherwise, it is treated just
 243     as any other character.
 244    </para>
 245    <para>
 246     Because the <literal>default.idx</literal> file can be used to
 247     associate different character maps with different indexing types
 248     -- and you can create additional indexing types, should the need
 249     arise -- it is possible to specify that leading articles should
 250     be ignored either in sorting, in complete-field searching, or
 251     both.
 252    </para>
 253    <para>
 254     If you ignore certain prefixes in sorting, then these will be
 255     eliminated from the index, and sorting will take place as if
 256     they weren't there. However, if you set the system up to ignore
 257     certain prefixes in <emphasis>searching</emphasis>, then these
 258     are deleted both from the indexes and from query terms, when the
 259     client specifies complete-field searching. This has the effect
 260     that a search for 'the science journal' and 'science journal'
 261     would both produce the same results.
 262    </para>
 263   </section>
 264   <section id="default-idx-debug">
 265    <title>Field structure debugging using the special
 266           <literal>zebra::</literal> element set</title>
 267    <para>
 268     At some time, it is very hard to figure out what exactly has been
 269     indexed how and in which indexes. Using the indexing stylesheet of
 270     the Alvis filter, one can at least see which portion of the record
 271     went into which index, but a similar aid does not exist for all
 272     other indexing filters.
 273    </para>
 274    <para>
 275     Starting with <literal>Zebra</literal> version
 276     <literal>2.0.4-2</literal> or newer, one has the possibility to
 277     use the special
 278     <literal>zebra::</literal> element set name, which is only defined for
 279     the <literal>SUTRS</literal> and <literal>XML</literal> record
 280     formats.
 281     <screen>
 282       Z> f @attr 1=dc_all minutter
 283       Z> format sutrs
 284       Z> elements zebra::
 285       Z> s 1+1
 286     </screen>
 287     will display all indexed tokens from all indexed fields of the
 288     first record, and it will display in <literal>SUTRS</literal>
 289     record syntax, whereas
 290     <screen>
 291       Z> f @attr 1=dc_all minutter
 292       Z> format xml
 293       Z> elements zebra::dc_publisher
 294       Z> s 1+1
 295       Z> elements zebra::dc_publisher:p
 296       Z> s 1+1
 297     </screen>
 298     displays in <literal>XML</literal> record syntax only the content
 299       of the zebra string index <literal>dc_publisher</literal>, or
 300       even only the type <literal>p</literal> phrase indexed part of it.
 301    </para>
 302   </section>
 303  </chapter>
 304  <!-- Keep this comment at the end of the file
 305  Local variables:
 306  mode: sgml
 307  sgml-omittag:t
 308  sgml-shorttag:t
 309  sgml-minimize-attributes:nil
 310  sgml-always-quote-attributes:t
 311  sgml-indent-step:1
 312  sgml-indent-data:t
 313  sgml-parent-document: "zebra.xml"
 314  sgml-local-catalogs: nil
 315  sgml-namecase-general:t
 316  End:
 317  -->