doc/field-structure.xml

   1  <chapter id="fields-and-charsets">
   2   <!-- $Id: field-structure.xml,v 1.9 2006-11-28 14:18:26 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         See <xref linkend="character-map-files"/> for details.
 107        </para>
 108       </listitem></varlistentry>
 109     </variablelist>
 110    </para>
 111   </section>
 112
 113   <section id="character-map-files">
 114    <title>The character map file format</title>
 115    <para>
 116     The character map files are used to define the word tokenization
 117     and character normalization performed before inserting text into
 118     the inverse indexes. Zebra ships with the predefined character map
 119     files <filename>tab/*.chr</filename>. Users are allowed to add
 120     and/or modify maps according to their needs.
 121    </para>
 122
 123    <table id="querymodel-attribute-sets-table" frame="top">
 124      <title>Character maps predefined in Zebra</title>
 125       <tgroup cols="3">
 126        <thead>
 127         <row>
 128          <entry>File name</entry>
 129          <entry>Intended type</entry>
 130          <entry>Description</entry>
 131         </row>
 132        </thead>
 133        <tbody>
 134         <row>
 135          <entry><literal>numeric.chr</literal></entry>
 136          <entry><literal>:n</literal></entry>
 137          <entry>Numeric digit tokenization and normalization map. All
 138          characters not in the set <literal>-{0-9}.,</literal> will be
 139          suppressed. Note that floating point numbers are processed
 140          fine, but scientific exponential numbers are trashed.</entry>
 141         </row>
 142         <row>
 143          <entry><literal>scan.chr</literal></entry>
 144          <entry><literal>:w or :p</literal></entry>
 145          <entry>Word tokenization char map for Scandinavian
 146          languages. This one resembles the generic word tokenization
 147          character map <literal>tab/string.chr</literal>, the main
 148          differences are sorting of the special characters
 149         <literal>üzæäøöå</literal> and equivalence maps according to
 150          Scandinavian language rules.</entry>
 151         </row>
 152         <row>
 153          <entry><literal>string.chr</literal></entry>
 154          <entry><literal>:w or :p</literal></entry>
 155          <entry>General word tokenization and normalization character
 156          map, mostly useful for English texts. Use this to derive your
 157          own language tokenization and normalization derivatives.</entry>
 158         </row>
 159         <row>
 160          <entry><literal>urx.chr</literal></entry>
 161          <entry><literal>:u</literal></entry>
 162          <entry>URL parsing and tokenization character map.</entry>
 163         </row>
 164         <row>
 165          <entry><literal>@</literal></entry>
 166          <entry><literal>:0</literal></entry>
 167          <entry>Do-nothing character map used for literal binary
 168          indexing. There is no existing file associated to it, and
 169          there is no normalization or tokenization performed at all.</entry>
 170         </row>
 171       </tbody>
 172      </tgroup>
 173    </table>
 174
 175    <para>
 176     The contents of the character map files are structured as follows:
 177     <variablelist>
 178      <varlistentry>
 179       <term>encoding <replaceable>encoding-name</replaceable></term>
 180       <listitem>
 181        <para>
 182         This directive must be at the very beginning of the file, and it
 183         specifies the character encoding used in the entire file. If
 184         omitted, the encoding <literal>ISO-8859-1</literal> is assumed.
 185        </para>
 186        <para>
 187         For example, one of the test files found at
 188           <literal>test/rusmarc/tab/string.chr</literal> contains the following
 189         encoding directive:
 190         <screen>
 191          encoding koi8-r
 192         </screen>
 193           and the test file
 194           <literal>test/charmap/string.utf8.chr</literal> is encoded
 195           in UTF-8:
 196         <screen>
 197          encoding utf-8
 198         </screen>
 199        </para>
 200       </listitem></varlistentry>
 201
 202      <varlistentry>
 203       <term>lowercase <replaceable>value-set</replaceable></term>
 204       <listitem>
 205        <para>
 206         This directive introduces the basic value set of the field type.
 207         The format is an ordered list (without spaces) of the
 208         characters which may occur in "words" of the given type.
 209         The order of the entries in the list determines the
 210         sort order of the index. In addition to single characters, the
 211         following combinations are legal:
 212        </para>
 213
 214        <para>
 215
 216         <itemizedlist>
 217          <listitem>
 218           <para>
 219            Backslashes may be used to introduce three-digit octal, or
 220            two-digit hex representations of single characters
 221            (preceded by <literal>x</literal>).
 222            In addition, the combinations
 223            \\, \\r, \\n, \\t, \\s (space &mdash; remember that real
 224            space-characters may not occur in the value definition), and
 225            \\ are recognized, with their usual interpretation.
 226           </para>
 227          </listitem>
 228
 229          <listitem>
 230           <para>
 231            Curly braces {} may be used to enclose ranges of single
 232            characters (possibly using the escape convention described in the
 233            preceding point), eg. {a-z} to introduce the
 234            standard range of ASCII characters.
 235            Note that the interpretation of such a range depends on
 236            the concrete representation in your local, physical character set.
 237           </para>
 238          </listitem>
 239
 240          <listitem>
 241           <para>
 242            paranthesises () may be used to enclose multi-byte characters -
 243            eg. diacritics or special national combinations (eg. Spanish
 244            "ll"). When found in the input stream (or a search term),
 245            these characters are viewed and sorted as a single character, with a
 246            sorting value depending on the position of the group in the value
 247            statement.
 248           </para>
 249          </listitem>
 250
 251         </itemizedlist>
 252
 253        </para>
 254        <para>
 255         For example, <literal>scan.chr</literal> contains the following
 256         lowercase normalization and sorting order:
 257         <screen>
 258          lowercase {0-9}{a-y}üzæäøöå
 259         </screen>
 260        </para>
 261       </listitem></varlistentry>
 262      <varlistentry>
 263       <term>uppercase <replaceable>value-set</replaceable></term>
 264       <listitem>
 265        <para>
 266         This directive introduces the
 267         upper-case equivalences to the value set (if any). The number and
 268         order of the entries in the list should be the same as in the
 269         <literal>lowercase</literal> directive.
 270        </para>
 271        <para>
 272         For example, <literal>scan.chr</literal> contains the following
 273         uppercase equivalent:
 274         <screen>
 275          uppercase {0-9}{A-Y}ÜZÆÄØÖÅ
 276         </screen>
 277        </para>
 278       </listitem></varlistentry>
 279      <varlistentry>
 280       <term>space <replaceable>value-set</replaceable></term>
 281       <listitem>
 282        <para>
 283         This directive introduces the character
 284         which separate words in the input stream. Depending on the
 285         completeness mode of the field in question, these characters either
 286         terminate an index entry, or delimit individual "words" in
 287         the input stream. The order of the elements is not significant &mdash;
 288         otherwise the representation is the same as for the
 289         <literal>uppercase</literal> and <literal>lowercase</literal>
 290         directives.
 291        </para>
 292        <para>
 293         For example, <literal>scan.chr</literal> contains the following
 294         space instruction:
 295         <screen><![CDATA[
 296          space {\001-\040}!"#$%&'\()*+,-./:;<=>?@\[\\]^_`\{|}~
 297         ]]></screen>
 298        </para>
 299       </listitem></varlistentry>
 300      <varlistentry>
 301       <term>map <replaceable>value-set</replaceable>
 302        <replaceable>target</replaceable></term>
 303       <listitem>
 304        <para>
 305         This directive introduces a mapping between each of the
 306         members of the value-set on the left to the character on the
 307         right. The character on the right must occur in the value
 308         set (the <literal>lowercase</literal> directive) of the
 309         character set, but it may be a parenthesis-enclosed
 310         multi-octet character. This directive may be used to map
 311         diacritics to their base characters, or to map HTML-style
 312         character-representations to their natural form, etc. The
 313         map directive can also be used to ignore leading articles in
 314         searching and/or sorting, and to perform other special
 315         transformations. See section <xref
 316          linkend="leading-articles"/>.
 317        </para>
 318        <para>
 319         For example, <literal>scan.chr</literal> contains the following
 320         map instructions among others, to make sure that HTML entity
 321         encoded  Danish special characters are mapped to the
 322         equivalent Latin-1 characters:
 323         <screen><![CDATA[
 324          map (&aelig;)      æ
 325          map (&oslash;)     ø
 326          map (&aring;)      å
 327         ]]></screen>
 328        </para>
 329       </listitem></varlistentry>
 330      <varlistentry>
 331       <term>equivalent <replaceable>value-set</replaceable></term>
 332       <listitem>
 333        <para>
 334         This directive introduces equivalence classes of characters
 335         and/or strings for sorting purposes only. It resembles the map
 336         directive, but does not affect search and retrieval indexing,
 337         but only sorting order under present requests.
 338        </para>
 339        <para>
 340         For example, <literal>scan.chr</literal> contains the following
 341         equivalent sorting instructions, which can be uncommented:
 342         <screen><![CDATA[
 343          # equivalent æä(ae)
 344          # equivalent øö(oe)
 345          # equivalent å(aa)
 346          # equivalent uü
 347         ]]></screen>
 348        </para>
 349       </listitem></varlistentry>
 350     </variablelist>
 351    </para>
 352   </section>
 353   <section id="leading-articles">
 354    <title>Ignoring leading articles</title>
 355    <para>
 356     In addition to specifying sort orders, space (blank) handling,
 357     and upper/lowercase folding, you can also use the character map
 358     files to make Zebra ignore leading articles in sorting records,
 359     or when doing complete field searching.
 360    </para>
 361    <para>
 362     This is done using the <literal>map</literal> directive in the
 363     character map file. In a nutshell, what you do is map certain
 364     sequences of characters, when they occur <emphasis> in the
 365      beginning of a field</emphasis>, to a space. Assuming that the
 366     character "@" is defined as a space character in your file, you
 367     can do:
 368     <screen>
 369      map (^The\s) @
 370      map (^the\s) @
 371     </screen>
 372     The effect of these directives is to map either 'the' or 'The',
 373     followed by a space character, to a space. The hat ^ character
 374     denotes beginning-of-field only when complete-subfield indexing
 375     or sort indexing is taking place; otherwise, it is treated just
 376     as any other character.
 377    </para>
 378    <para>
 379     Because the <literal>default.idx</literal> file can be used to
 380     associate different character maps with different indexing types
 381     -- and you can create additional indexing types, should the need
 382     arise -- it is possible to specify that leading articles should
 383     be ignored either in sorting, in complete-field searching, or
 384     both.
 385    </para>
 386    <para>
 387     If you ignore certain prefixes in sorting, then these will be
 388     eliminated from the index, and sorting will take place as if
 389     they weren't there. However, if you set the system up to ignore
 390     certain prefixes in <emphasis>searching</emphasis>, then these
 391     are deleted both from the indexes and from query terms, when the
 392     client specifies complete-field searching. This has the effect
 393     that a search for 'the science journal' and 'science journal'
 394     would both produce the same results.
 395    </para>
 396   </section>
 397
 398  </chapter>
 399  <!-- Keep this comment at the end of the file
 400  Local variables:
 401  mode: sgml
 402  sgml-omittag:t
 403  sgml-shorttag:t
 404  sgml-minimize-attributes:nil
 405  sgml-always-quote-attributes:t
 406  sgml-indent-step:1
 407  sgml-indent-data:t
 408  sgml-parent-document: "zebra.xml"
 409  sgml-local-catalogs: nil
 410  sgml-namecase-general:t
 411  End:
 412  -->