summaryrefslogtreecommitdiff
path: root/lib/Unicode/Collate/README
blob: 957fc95ba3bac1f9c7248bb476b664eec298748a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
Unicode/Collate version 0.21
===============================

NAME

  Unicode::Collate - Unicode Collation Algorithm

SYNOPSIS

  use Unicode::Collate;

  #construct
  $Collator = Unicode::Collate->new(%tailoring);

  #sort
  @sorted = $Collator->sort(@not_sorted);

  #compare
  $result = $Collator->cmp($a, $b); # returns 1, 0, or -1.
  $result = $Collator->eq($a, $b);  # returns true/false
    (similarly ->ne, ->lt, ->le, ->gt, ->ge)

INSTALLATION

Perl 5.6.1 or better

To install this module type the following:

   perl Makefile.PL
   make
   make test
   make install

To use this module, it is better to install a table file in the UCA format,
by copying it into the lib/Unicode/Collate directory.

The most preferable one is "The Default Unicode Collation Element Table",
available from the Unicode consortium's website:

    http://www.unicode.org/reports/tr10/allkeys.txt

Though this distribution contains a subset of allkeys.txt, named "keys.txt",
this one is intended only for doing a test of this module
and practically useless for any other purpose.

DEPENDENCIES

  The conformant collation requires Unicode::Normalize (v 0.10 or later)
  although Unicode::Collate can be used without Unicode::Normalize.

COPYRIGHT AND LICENCE

SADAHIRO Tomoyuki <bqw10602@nifty.com>

  http://homepage1.nifty.com/nomenclator/perl/

  Copyright(C) 2001-2002, SADAHIRO Tomoyuki. Japan. All rights reserved.

  This library is free software; you can redistribute it
  and/or modify it under the same terms as Perl itself.