Integrate mainline
[p5sagit/p5-mst-13.2.git] / ext / Encode / TW / TW.pm
1 package Encode::TW;
2 BEGIN {
3     if (ord("A") == 193) {
4         die "Encode::TW not supported on EBCDIC\n";
5     }
6 }
7 our $VERSION = do { my @r = (q$Revision: 1.0 $ =~ /\d+/g); sprintf "%d."."%02d" x $#r, @r };
8
9 use Encode;
10 use XSLoader;
11 XSLoader::load('Encode::TW',$VERSION);
12
13 1;
14 __END__
15
16 =head1 NAME
17
18 Encode::TW - Taiwan-based Chinese Encodings
19
20 =head1 SYNOPSIS
21
22     use Encode qw/encode decode/; 
23     $big5 = encode("big5", $utf8); # loads Encode::TW implicitly
24     $utf8 = decode("big5", $big5); # ditto
25
26 =head1 DESCRIPTION
27
28 This module implements Taiwan-based Chinese charset encodings.
29 Encodings supported are as follows.
30
31   Canonical   Alias             Description
32   --------------------------------------------------------------------
33   big5        /\bbig-?5$/i      The original Big5 encoding
34   big5-hkscs  /\bbig5-hk(scs)?$/i
35                                 Big5 plus Cantonese characters in 
36                                 Hong Kong
37   cp950                         Code Page 950 
38                                 (Big5 + Microsoft vendor mappings)
39   --------------------------------------------------------------------
40
41 To find how to use this module in detail, see L<Encode>.
42
43 =head1 NOTES
44
45 Due to size concerns, C<EUC-TW> (Extended Unix Character) and C<BIG5PLUS>
46 (CMEX's Big5+) are distributed separately on CPAN, under the name
47 L<Encode::HanExtra>. That module also contains extra China-based encodings.
48
49 =head1 BUGS
50
51 The C<CNS11643> encoding files are not complete (only the first two planes,
52 C<11643-1> and C<11643-2>, exist in the distribution). For common CNS11643
53 manipulation, please use C<EUC-TW> in L<Encode::HanExtra>, which contains
54 plane 1-7.
55
56 ASCII part (0x00-0x7f) is preserved for all encodings, even though it
57 conflicts with mappings by the Unicode Consortium.  See
58
59 L<http://www.debian.or.jp/~kubota/unicode-symbols.html.en>
60
61 to find why it is implemented that way.
62
63 =head1 SEE ALSO
64
65 L<Encode>,L<Encode::CJKguide>
66
67 =cut