Commit | Line | Data |
ac5ea531 |
1 | |
2 | =head1 NAME |
3 | |
4 | Unicode::Normalize - normalized forms of Unicode text |
5 | |
6 | =head1 SYNOPSIS |
7 | |
8 | use Unicode::Normalize; |
9 | |
10 | $string_NFD = NFD($raw_string); # Normalization Form D |
11 | $string_NFC = NFC($raw_string); # Normalization Form C |
12 | $string_NFKD = NFKD($raw_string); # Normalization Form KD |
13 | $string_NFKC = NFKC($raw_string); # Normalization Form KC |
14 | |
15 | or |
16 | |
17 | use Unicode::Normalize 'normalize'; |
18 | |
19 | $string_NFD = normalize('D', $raw_string); # Normalization Form D |
20 | $string_NFC = normalize('C', $raw_string); # Normalization Form C |
21 | $string_NFKD = normalize('KD', $raw_string); # Normalization Form KD |
22 | $string_NFKC = normalize('KC', $raw_string); # Normalization Form KC |
23 | |
24 | =head1 DESCRIPTION |
25 | |
26 | =over 4 |
27 | |
28 | =item C<$string_NFD = NFD($raw_string)> |
29 | |
30 | returns the Normalization Form D (formed by canonical decomposition). |
31 | |
32 | |
33 | =item C<$string_NFC = NFC($raw_string)> |
34 | |
35 | returns the Normalization Form C (formed by canonical decomposition |
36 | followed by canonical composition). |
37 | |
38 | =item C<$string_NFKD = NFKD($raw_string)> |
39 | |
40 | returns the Normalization Form KD (formed by compatibility decomposition). |
41 | |
42 | =item C<$string_NFKC = NFKC($raw_string)> |
43 | |
44 | returns the Normalization Form KC (formed by compatibility decomposition |
45 | followed by B<canonical> composition). |
46 | |
47 | =item C<$normalized_string = normalize($form_name, $raw_string)> |
48 | |
49 | As C<$form_name>, one of the following names must be given. |
50 | |
51 | 'C' or 'NFC' for Normalization Form C |
52 | 'D' or 'NFD' for Normalization Form D |
53 | 'KC' or 'NFKC' for Normalization Form KC |
54 | 'KD' or 'NFKD' for Normalization Form KD |
55 | |
56 | =back |
57 | |
58 | =head2 EXPORT |
59 | |
60 | C<NFC>, C<NFD>, C<NFKC>, C<NFKD>: by default. |
61 | |
62 | C<normalize>: on request. |
63 | |
64 | =head1 AUTHOR |
65 | |
66 | SADAHIRO Tomoyuki, E<lt>SADAHIRO@cpan.orgE<gt> |
67 | |
68 | http://homepage1.nifty.com/nomenclator/perl/ |
69 | |
70 | Copyright(C) 2001, SADAHIRO Tomoyuki. Japan. All rights reserved. |
71 | |
72 | This program is free software; you can redistribute it and/or |
73 | modify it under the same terms as Perl itself. |
74 | |
75 | =head1 SEE ALSO |
76 | |
77 | =over 4 |
78 | |
79 | =item L<Lingua::KO::Hangul::Util> |
80 | |
81 | utility functions for Hangul Syllables |
82 | |
83 | =item http://www.unicode.org/unicode/reports/tr15/ |
84 | |
85 | Unicode Normalization Forms - UAX #15 |
86 | |
87 | =back |
88 | |
89 | =cut |