diff options
author | David Mitchell <davem@iabyn.com> | 2009-06-12 17:29:39 +0100 |
---|---|---|
committer | David Mitchell <davem@iabyn.com> | 2009-06-12 17:34:56 +0100 |
commit | 4c6f7fd010fab0cc54f718d185e955486741df2f (patch) | |
tree | 05543d6fe77e1b2ce17494a5f289e1933fe3ac4e /ext | |
parent | 6a1d10d46a654de278f526bf17f99413b81d68bf (diff) | |
download | perl-4c6f7fd010fab0cc54f718d185e955486741df2f.tar.gz |
sync ext/Text-Soundex/README with the CPAN version
(cherry picked from commit 1edf8e51d749cc688006e65c45d210d69ed74c27)
Diffstat (limited to 'ext')
-rw-r--r-- | ext/Text-Soundex/README | 47 |
1 files changed, 10 insertions, 37 deletions
diff --git a/ext/Text-Soundex/README b/ext/Text-Soundex/README index 7fcf22e945..3c3b588e09 100644 --- a/ext/Text-Soundex/README +++ b/ext/Text-Soundex/README @@ -1,22 +1,4 @@ -Text::Soundex Version 3.02 - -NOTE: Users of Text::Soundex Version 2.x should consult the 'History' - section at the end of this document before installing this module. - The interface has been simplified, and existing code that takes - advantages of Version 2.x features may need to be altered to function - properly. - -This is a perl 5 module implementing the Soundex algorithm described by -Knuth. The algorithm is used quite often for locating a person by name -where the actual spelling of the name is not known. - -This version directly supercedes the version of Text::Soundex that can be -found in the core from Perl 5.8.0 and down. (This version is a drop-in -replacement) - -The algorithm used by soundex() is NOT fully compatible with the -algorithm used to index names for US Censuses. Use the soundex_nara() -subroutine to return codes for this purpose. +Text::Soundex - Implementation of the soundex algorithm. Basic Usage: @@ -75,9 +57,16 @@ Installation: History: + Version 3.03: + Updated to allow the XS implementation to work properly under an + EBCDIC/EBCDIC-UTF8 character set environment. + + Updated documentation to better describe the history of the + soundex algorithm and how it applies to this module. + Version 3.02: 3.01 and 3.00 used the 'U8' type incorrectly causing some strict - compilers to complain or refuse to compile the XS code. Also, unicode + compilers to complain or refuse to compile the XS code. Also, Unicode support did not work properly for Perl 5.6.x. Both of these problems are now fixed. @@ -127,25 +116,9 @@ History: NARA can be found at: http://www.nara.gov/genealogy/ - The algorithm requested by NARA can be found at: + The algorithm used by NARA can be found at: http://home.utah-inter.net/kinsearch/Soundex.html - Ways to use it in your code: - - Transparently change existing code like this: - ============================================= - use Text::Soundex qw(:NARA-Ruleset); - - ... soundex(...) ... - - -- - - Make the change visibly distinct like this: - =========================================== - use Text::Soundex qw(soundex_nara); - - ... soundex_nara(...) ... - Version 2.00: This version is a full re-write of the 1.0 engine by Mark Mielke. The goal was for speed... and this was achieved. There is an optional |