Fix documentation of of chr's equivalent directive ZEB-672

[idzebra-moved-to-github.git] / doc / field-structure.xml

diff --git a/doc/field-structure.xml b/doc/field-structure.xml
index 98c4183..a19838e 100644 (file)
--- a/doc/field-structure.xml
+++ b/doc/field-structure.xml
@@ -29,7 +29,7 @@
   </para>
 
   <para>
-   Version 2.1 of Zebra can also be configured - per field - to use the
+   Version 2.0.20 of Zebra can also be configured - per field - to use the
    <ulink url="&url.icu;">ICU</ulink> library to perform tokenization and
    normalization of strings. This is an alternative to the "charmap"
    files which has been part of Zebra since its first release.
@@ -436,21 +436,22 @@
       <term>equivalent <replaceable>value-set</replaceable></term>
       <listitem>
        <para>
-       This directive introduces equivalence classes of characters
-       and/or strings for sorting purposes only. It resembles the map
-       directive, but does not affect search and retrieval indexing,
-       but only sorting order under present requests. 
+       This directive introduces equivalence classes of strings for
+       searching purposes only. It's a one-to-many
+       conversion that takes place only during search before the map
+       directive kicks in.
        </para>
        <para>
-        For example, <literal>scan.chr</literal> contains the following
-        equivalent sorting instructions, which can be uncommented:
+        For example given:
         <screen><![CDATA[
-         # equivalent æä(ae)
-         # equivalent øö(oe)
-         # equivalent å(aa)
-         # equivalent uü
+         equivalent æä(ae)
         ]]></screen>
        </para>
+       <para>
+        a search for the <literal>äsel</literal> will be be match any of
+        <literal>æsel</literal>, <literal>äsel</literal> and
+        <literal>aesel</literal>.
+       </para>
       </listitem></varlistentry>
     </variablelist>
    </para>
@@ -533,7 +534,7 @@
  sgml-always-quote-attributes:t
  sgml-indent-step:1
  sgml-indent-data:t
- sgml-parent-document: "zebra.xml"
+ sgml-parent-document: "idzebra.xml"
  sgml-local-catalogs: nil
  sgml-namecase-general:t
  End: