This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Updated Unicode-Collate to CPAN version 0.76
[perl5.git] / cpan / Unicode-Collate / README
index 9df8d22..fcda1f3 100644 (file)
@@ -1,4 +1,4 @@
-Unicode/Collate version 0.63
+Unicode/Collate version 0.76
 ===============================
 
 NAME
@@ -20,6 +20,11 @@ SYNOPSIS
   $result = $Collator->eq($a, $b);  # returns true/false
     (similarly ->ne, ->lt, ->le, ->gt, ->ge)
 
+Note: Strings in @not_sorted, $a and $b are interpreted
+according to Perl's Unicode support. See perlunicode,
+perluniintro, perlunitut, perlunifaq, utf8.
+Otherwise you can use "preprocess" or should decode them before.
+
 INSTALL
 
   Perl 5.6.1 or later is required.
@@ -30,10 +35,12 @@ INSTALL
   and practically useless for any other purpose.
 
   Installation of Unicode::Collate::Locale requires Collate/Locale.pm,
-  Collate/Locale/*.pm and Collate/allkeys.txt.  On building,
-  Unicode::Collate::Locale doesn't require data/*.txt and mklocale.
+  Collate/Locale/*.pm, Collate/CJK/*.pm and Collate/allkeys.txt.
+  On building, Unicode::Collate::Locale doesn't require any of data/*.txt,
+  gendata/*, and mklocale.
   Tests for Unicode::Collate::Locale are named t/loc_*.t.
 
+Since 0.54, XSUB that requires a C compiler will be built by default.
 To install this module type the following:
 
    perl Makefile.PL
@@ -41,20 +48,20 @@ To install this module type the following:
    make test
    make install
 
-If you have a C compiler and want to use XSUB edition,
-type the following (!! "enableXS" must run before "Makefile.PL" !!):
+Even if a C compiler is not available, pure Perl (i.e. non-XS) edition
+is available; type the following:
 
-   perl enableXS
+   perl disableXS
    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:
+If you decide to install XSUB edition after trying to build pure Perl,
+type the following:
 
    make clean
-   perl disableXS
+   perl enableXS
    perl Makefile.PL
    make
    make test
@@ -87,16 +94,27 @@ ABOUT DUCET
   from http://www.unicode.org/Public/UCA/latest/allkeys.txt
   to <a place in @INC>/Unicode/Collate/allkeys.txt manually.
 
+HOW TO CHANGE DUCET (NOT WARRANTED)
+
+  0. rewriting UCA_Version and Base_Unicode_Version in Collate.pm
+     and t/version.t is preferred.
+  1. replace Collate/allkeys.txt with a new DUCET.
+  2. run mklocale to generate new Locale/*.pl and Korean.pm.
+  3. replace Collate/Locale/*.pl with the new Locale/*.pl,
+     and Collate/CJK/Korean.pm with the new Korean.pm.
+  4. make test.
+     IF FAIL, it may require more changes, not be easy.
+
 AUTHOR, COPYRIGHT AND LICENSE
 
 The Unicode::Collate module for perl was written by SADAHIRO Tomoyuki,
-<SADAHIRO@cpan.org>. This module is Copyright(C) 2001-2010,
+<SADAHIRO@cpan.org>. This module is Copyright(C) 2001-2011,
 SADAHIRO Tomoyuki. Japan. All rights reserved.
 
 This module is free software; you can redistribute it and/or
 modify it under the same terms as Perl itself.
 
 The file Unicode/Collate/allkeys.txt was copied verbatim
-from http://www.unicode.org/Public/UCA/5.2.0/allkeys.txt
-This file is Copyright (c) 1991-2009 Unicode, Inc. All rights reserved.
+from http://www.unicode.org/Public/UCA/6.0.0/allkeys.txt
+This file is Copyright (c) 1991-2010 Unicode, Inc. All rights reserved.
 Distributed under the Terms of Use in http://www.unicode.org/copyright.html