normalizer.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.normalizer" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
 <title>The Normalizer class</title>
 <titleabbrev>Normalizer</titleabbrev>

 <partintro>

  <!-- {{{ Normalizer intro -->
  <section xml:id="normalizer.intro">
   &reftitle.intro;
   <simpara>
    Normalization is a process that involves transforming characters and
    sequences of characters into a formally-defined underlying representation.
    This process is most important when text needs to be compared for sorting
    and searching, but it is also used when storing text to ensure that the
    text is stored in a consistent representation.
   </simpara>
   <para>
    The Unicode Consortium has defined a number of normalization forms
    reflecting the various needs of applications:
    <simplelist>
     <member>Normalization Form D (NFD) - Canonical Decomposition</member>
     <member>
      Normalization Form C (NFC) - Canonical Decomposition followed by
      Canonical Composition
     </member>
     <member>
      Normalization Form KD (NFKD) - Compatibility Decomposition
     </member>
     <member>
      Normalization Form KC (NFKC) - Compatibility Decomposition followed by
      Canonical Composition
     </member>
    </simplelist>
    The different forms are defined in terms of a set of transformations on
    the text, transformations that are expressed by both an algorithm and a
    set of data files.
   </para>
  </section>
  <!-- }}} -->

  <section xml:id="normalizer.synopsis">
   &reftitle.classsynopsis;

   <!-- {{{ Synopsis -->
   <classsynopsis class="class">
    <ooclass>
     <classname>Normalizer</classname>
    </ooclass>

    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="normalizer.constants.form-d">Normalizer::FORM_D</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="normalizer.constants.nfd">Normalizer::NFD</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="normalizer.constants.form-kd">Normalizer::FORM_KD</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="normalizer.constants.nfkd">Normalizer::NFKD</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="normalizer.constants.form-c">Normalizer::FORM_C</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="normalizer.constants.nfc">Normalizer::NFC</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="normalizer.constants.form-kc">Normalizer::FORM_KC</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="normalizer.constants.nfkc">Normalizer::NFKC</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="normalizer.constants.form-kc-cf">Normalizer::FORM_KC_CF</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="normalizer.constants.nfkc-cf">Normalizer::NFKC_CF</varname>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.normalizer')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='Normalizer'])">
     <xi:fallback/>
    </xi:include>
   </classsynopsis>
   <!-- }}} -->

  </section>

  <!-- {{{ Normalizer properties
   <section xml:id="normalizer.props">
   &reftitle.properties;
   <variablelist>
   <varlistentry xml:id="normalizer.props.name">
   <term><varname>name</varname></term>
   <listitem>
   <para>Prop description</para>
   </listitem>
   </varlistentry>
   </variablelist>
   </section>
   }}} -->

  &reference.intl.normalizer-constants;

  <section xml:id="normalizer.seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
     <member>
      <link xlink:href="&url.unicode.normalization;">
       Unicode Normalization
      </link>
     </member>
     <member>
      <link xlink:href="&url.unicode.normalization.faq;">
       Unicode Normalization FAQ
      </link>
     </member>
     <member>
      <link xlink:href="&url.icu.normalization.guide;">
       ICU User Guide - Normalization
      </link>
     </member>
     <member>
      <link xlink:href="&url.icu.normalization.api;">
       ICU API Reference - Normalization
      </link>
     </member>
    </simplelist>
   </para>
  </section>

  <section role="changelog">
   &reftitle.changelog;
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.4.0</entry>
       <entry>
        The class constants are now typed.
       </entry>
      </row>
      <row>
       <entry>8.0.0</entry>
       <entry>
        <constant>Normalizer::NONE</constant> has been removed.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </section>
 </partintro>

 &reference.intl.entities.normalizer;

</reference>
<!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
 sgml-omittag:t
 sgml-shorttag:t
 sgml-minimize-attributes:nil
 sgml-always-quote-attributes:t
 sgml-indent-step:1
 sgml-indent-data:t
 indent-tabs-mode:nil
 sgml-parent-document:nil
 sgml-default-dtd-file:"~/.phpdoc/manual.ced"
 sgml-exposed-tags:nil
 sgml-local-catalogs:nil
 sgml-local-ecat-files:nil
 End:
 vim600: syn=xml fen fdm=syntax fdl=2 si
 vim: et tw=78 syn=sgml
 vi: ts=1 sw=1
-->