Integrate mainline.
[p5sagit/p5-mst-13.2.git] / lib / Unicode / Collate / README
1 Unicode/Collate version 0.20
2 ===============================
3
4 Unicode::Collate - Unicode Collation Algorithm
5
6   UCA - Unicode TR #10.
7   http://www.unicode.org/unicode/reports/tr10/
8
9   Fetch the following file and put it into the Unicode/Collate directory.
10   http://www.unicode.org/unicode/reports/tr10/allkeys.txt
11
12   You can install this module using a subset "keys.txt"
13   contained in this distribution without the "allkeys.txt";
14   but "keys.txt" is small and not very useful.
15
16 SYNOPSIS
17
18   use Unicode::Collate;
19
20   #construct
21   $Collator = Unicode::Collate->new(%tailoring);
22
23   #sort
24   @sorted = $Collator->sort(@not_sorted);
25
26   #compare
27   $result = $Collator->cmp($a, $b); # returns 1, 0, or -1.
28   $result = $Collator->eq($a, $b);  # returns true/false
29     (similarly ->ne, ->lt, ->le, ->gt, ->ge)
30
31 INSTALLATION
32
33 Perl 5.6.1 or better
34
35 To install this module type the following:
36
37    perl Makefile.PL
38    make
39    make test
40    make install
41
42 DEPENDENCIES
43
44   The conformant collation requires Unicode::Normalize (v 0.10 or later)
45   although Unicode::Collate can be used without Unicode::Normalize.
46
47 COPYRIGHT AND LICENCE
48
49 SADAHIRO Tomoyuki <bqw10602@nifty.com>
50
51   http://homepage1.nifty.com/nomenclator/perl/
52
53   Copyright(C) 2001-2002, SADAHIRO Tomoyuki. Japan. All rights reserved.
54
55   This library is free software; you can redistribute it
56   and/or modify it under the same terms as Perl itself.
57