Unicode::Collate v0.09
[p5sagit/p5-mst-13.2.git] / lib / Unicode / Collate / README
1 Unicode/Collate version 0.09
2 ===============================
3
4 use UCA (Unicode Collation Algorithm)
5
6   See UCA - Unicode TR #10.
7   http://www.unicode.org/unicode/reports/tr10/
8
9   Fetch the following file before use and put it into the Unicode/Collate dir.
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
15 SYNOPSIS
16
17   use Unicode::Collate;
18
19   #construct
20   $Collator = Unicode::Collate->new(%tailoring);
21
22   #sort
23   @sorted = $Collator->sort(@not_sorted);
24
25   #compare
26   $result = $Collator->cmp($a, $b); # returns 1, 0, or -1.
27   $result = $Collator->eq($a, $b);  # returns true/false
28     (similarly ->ne, ->lt, ->le, ->gt, ->ge)
29
30 INSTALLATION
31
32 Perl 5.006 or later
33
34 To install this module type the following:
35
36    perl Makefile.PL
37    make
38    make test
39    make install
40
41 DEPENDENCIES
42
43 It's better if you have Unicode::Normalize (v 0.10 or later)
44 although Unicode::Collate can be used without Unicode::Normalize.
45
46 COPYRIGHT AND LICENCE
47
48 SADAHIRO Tomoyuki <bqw10602@nifty.com>
49
50   http://homepage1.nifty.com/nomenclator/perl/
51
52   Copyright(C) 2001, SADAHIRO Tomoyuki. Japan. All rights reserved.
53
54   This program is free software; you can redistribute it and/or 
55   modify it under the same terms as Perl itself.
56