summaryrefslogtreecommitdiff
path: root/lib/Unicode/Collate/README
blob: 376a0c2c13cb29a46ca82caba4f996989207b163 (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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
Unicode/Collate version 0.33
===============================

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 later
(recommended: Perl 5.8.0 or later)

To use this module, it is recommended to install a table file
in the UCA format, by copying it into the directory
where F<Unicode/Collate.pm> is installed;
e.g. into F<perl/lib/Unicode/Collate/> directory
if you have F<perl/lib/Unicode/Collate.pm>.

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

  http://www.unicode.org/Public/UCA/latest/allkeys.txt (latest version)

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.

To install this module type the following:

   perl Makefile.PL
   make
   make test
   make install

(!! XSUB for Unicode::Collate is an EXPERIMENTAL support !!)
If you have a C compiler and want to use XSUB edition,
type the following (!! "enableXS" must run before "Makefile.PL" !!):

   perl enableXS
   perl Makefile.PL
   make
   make test
   make install

If you decide to install pure Perl (i.e. non-XS) edition after trying
to build XSUB, type the following:

   make clean
   perl disableXS
   perl Makefile.PL
   make
   make test
   make install

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 <SADAHIRO@cpan.org>

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

  Copyright(C) 2001-2003, 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.