lib/Unicode/Collate/README

   1 Unicode/Collate version 0.28
   2 ===============================
   3
   4 NAME
   5
   6   Unicode::Collate - Unicode Collation Algorithm
   7
   8 SYNOPSIS
   9
  10   use Unicode::Collate;
  11
  12   #construct
  13   $Collator = Unicode::Collate->new(%tailoring);
  14
  15   #sort
  16   @sorted = $Collator->sort(@not_sorted);
  17
  18   #compare
  19   $result = $Collator->cmp($a, $b); # returns 1, 0, or -1.
  20   $result = $Collator->eq($a, $b);  # returns true/false
  21     (similarly ->ne, ->lt, ->le, ->gt, ->ge)
  22
  23 INSTALLATION
  24
  25 Perl 5.6.1 or later
  26
  27 To install this module type the following:
  28
  29    perl Makefile.PL
  30    make
  31    make test
  32    make install
  33
  34 To use this module, it is better to install a table file in the UCA format,
  35 by copying it into the lib/Unicode/Collate directory.
  36
  37 The most preferable one is "The Default Unicode Collation Element Table",
  38 available from the Unicode consortium's website:
  39
  40     http://www.unicode.org/reports/tr10/allkeys.txt
  41
  42 Though this distribution contains a subset of allkeys.txt, named "keys.txt",
  43 this one is intended only for doing a test of this module
  44 and practically useless for any other purpose.
  45
  46 DEPENDENCIES
  47
  48   The conformant collation requires Unicode::Normalize (v 0.10 or later)
  49   although Unicode::Collate can be used without Unicode::Normalize.
  50
  51 COPYRIGHT AND LICENCE
  52
  53 SADAHIRO Tomoyuki <SADAHIRO@cpan.org>
  54
  55   http://homepage1.nifty.com/nomenclator/perl/
  56
  57   Copyright(C) 2001-2003, SADAHIRO Tomoyuki. Japan. All rights reserved.
  58
  59   This library is free software; you can redistribute it
  60   and/or modify it under the same terms as Perl itself.
  61