perl-unicode

[PATCH Encode 0.97] spell check & pod check

2002-03-23 23:28:00
Nothing fancy, just spell-checked and pod-checked the documents.

Also, shouldn't EncodeFormat.pod be renamed to Encode/Format.pod for
consistency's sake?

Thanks,
/Autrijus/

diff -durN lib.old/Encode/Details.pod lib/Encode/Details.pod
--- lib.old/Encode/Details.pod  Sun Mar 24 13:22:06 2002
+++ lib/Encode/Details.pod      Sun Mar 24 13:43:14 2002
@@ -1,11 +1,6 @@
-
 =head1 NAME
 
-Encode - character encodings
-
-=head1 SYNOPSIS
-
-    use Encode;
+Encode::Details - implementation details of Encode.pm
 
 =head1 DESCRIPTION
 
@@ -19,7 +14,7 @@
 the legacy encoding is some variant of EBCDIC rather than a super-set
 of ASCII - see L<perlebcdic>).
 
-Traditionaly computer data has been moved around in 8-bit chunks
+Traditionally computer data has been moved around in 8-bit chunks
 often called "bytes". These chunks are also known as "octets" in
 networking standards. Perl is widely used to manipulate data of
 many types - not only strings of characters representing human or
@@ -92,7 +87,7 @@
 Not really very "encoded" encodings. The Unicode code points
 are just represented as 4-octet integers. None the less because
 different architectures use different representations of integers
-(so called "endian") there at least two disctinct encodings.
+(so called "endian") there at least two distinct encodings.
 
 =item * Multi-byte encodings
 
@@ -265,7 +260,7 @@
 
   UTF-16 KOI8-U ISO-2022-JP-2 
 
-are IANA-registered preferred MIME names but probably shoule
+are IANA-registered preferred MIME names but probably should
 be avoided as encoding for web pages due to lack of browser 
 support.
 
@@ -412,25 +407,21 @@
 =head2 UTF-8 / utf8
 
 The Unicode consortium defines the UTF-8 standard as a way of encoding
-the entire Unicode repertiore as sequences of octets.  This encoding is
-expected to become very widespread. Perl can use this form internaly
+the entire Unicode repertoire as sequences of octets.  This encoding is
+expected to become very widespread. Perl can use this form internally
 to represent strings, so conversions to and from this form are
 particularly efficient (as octets in memory do not have to change,
 just the meta-data that tells Perl how to treat them).
 
 =over 4
 
-=item *
-
-        $bytes = encode_utf8($string);
+=item $bytes = encode_utf8($string);
 
 The characters that comprise string are encoded in Perl's superset of UTF-8
 and the resulting octets returned as a sequence of bytes. All possible
 characters have a UTF-8 representation so this function cannot fail.
 
-=item *
-
-        $string = decode_utf8($bytes [,CHECK]);
+=item $string = decode_utf8($bytes [,CHECK]);
 
 The sequence of octets represented by $bytes is decoded from UTF-8
 into a sequence of logical characters. Not all sequences of octets
@@ -505,10 +496,10 @@
   define_alias( qr/^iso8859-(\d+)$/i => '"iso-8859-$1"' );
 
 In this case if I<ENCODING> is not a reference it is C<eval>-ed to
-allow C<$1> etc. to be subsituted.  The example is one way to names as
+allow C<$1> etc. to be substituted.  The example is one way to names as
 used in X11 font names to alias the MIME names for the iso-8859-*
 family.  Note the double quote inside the single quote.  If you are
-using regex here, y ou have to do so or it won't work in this case.
+using regex here, you have to do so or it won't work in this case.
 
 =item As a code reference, e.g.:
 
@@ -622,15 +613,13 @@
 
 =over 4
 
-=item * is_utf8(STRING [, CHECK])
+=item is_utf8(STRING [, CHECK])
 
 [INTERNAL] Test whether the UTF-8 flag is turned on in the STRING.
 If CHECK is true, also checks the data in STRING for being well-formed
 UTF-8.  Returns true if successful, false otherwise.
 
-=item *
-
-        _utf8_on(STRING)
+=item _utf8_on(STRING)
 
 [INTERNAL] Turn on the UTF-8 flag in STRING.  The data in STRING is
 B<not> checked for being well-formed UTF-8.  Do not use unless you
@@ -638,9 +627,7 @@
 state of the UTF-8 flag (so please don't test the return value as
 I<not> success or failure), or C<undef> if STRING is not a string.
 
-=item *
-
-        _utf8_off(STRING)
+=item _utf8_off(STRING)
 
 [INTERNAL] Turn off the UTF-8 flag in STRING.  Do not use frivolously.
 Returns the previous state of the UTF-8 flag (so please don't test the
@@ -816,6 +803,4 @@
 L<perlunicode>, L<perlebcdic>, L<perlfunc/open>, L<PerlIO>, L<encoding>,
 L<utf8>, the Perl Unicode Mailing List 
E<lt>perl-unicode(_at_)perl(_dot_)orgE<gt>
 
-
 =cut
-
diff -durN lib.old/Encode/Supported.pod lib/Encode/Supported.pod
--- lib.old/Encode/Supported.pod        Sun Mar 24 13:22:06 2002
+++ lib/Encode/Supported.pod    Sun Mar 24 13:29:35 2002
@@ -24,7 +24,7 @@
 
 As of Perl 5.8.0, at least the following encodings are recognized.
 Note that unless otherwise specified, they are all case insensitive
-(via alias) and all occurance of spaces are replaced with '-'.  In
+(via alias) and all occurrance of spaces are replaced with '-'.  In
 other words, "ISO 8859 1" and "iso-8859-1" are identical.
 
 Encodings are categorized and implemented in several different modules
@@ -102,8 +102,9 @@
 =head2 The CJK: Chinese, Japanese, Korean (Multibyte)
 
 Note Vietnamese is listed above.  Also read "Encoding vs Charset"
-below.  Also note these are impelemented in distinct module by
-languages, due the the size concerns.  See these perldocs also.
+below.  Also note these are implemented in distinct module by
+languages, due the the size concerns.  Please also refer to their
+respective document pages.
 
 =over 4
 
@@ -172,7 +173,7 @@
   posix-bc
   -----------------------
 
-=item Enocode::Symbols
+=item Encode::Symbols
 
 For symbols  and dingbats.
 
@@ -208,19 +209,19 @@
   ISO-2022-CN ISO-2022-JP Big5
   EUC-CN      EUC-JP      EUC-KR
 
-are <http://www.iana.org/assignments/character-sets>-registered as
-preferred MIME names and may probably be used  over the Internet.  So is
+are registered in L<http://www.iana.org/assignments/character-sets> as
+preferred MIME names and may probably be used over the Internet.  So is
 
   Shift_JIS
 
 but despite its wide spread it bears the label of being
-Microsft proprietary -- was.  Now Shift JIS is official as of
+Microsoft proprietary -- or used to.  Now Shift JIS is official as of
 JIS X 0208-1997.
 
-         UTF-16 KOI8-U
+  UTF-16 KOI8-U
 
 are IANA-registered preferred MIME names but probably
-shoule be avoided as encoding for web pages due to lack of
+should be avoided as encoding for web pages due to lack of
 browser support.
 
   ISO-2022      (http://www.ecma.ch/ecma1/STAND/ECMA-035.HTM)
@@ -234,29 +235,30 @@
 
 are totally valid encodings but not registered at IANA.
 
-   BIG5PLUS
-   EUC-JP-0212   (Encode::lib::Encode::Tcl::Extended)
+  BIG5PLUS
+  EUC-JP-0212   (Encode::lib::Encode::Tcl::Extended)
 
-are a bit proprietary
+are a bit proprietary.
 
 You may probably get some info on CJK encodings at
 
 brief description for most of the mentioned CJK encodings
 
-F<http://www.debian.org.ru/doc/manuals/intro-i18n/ch-codes.html>
+L<http://www.debian.org.ru/doc/manuals/intro-i18n/ch-codes.html>
 
 several years old, but still useful
 
-F<http://www.oreilly.com/people/authors/lunde/cjk_inf.html>
+L<http://www.oreilly.com/people/authors/lunde/cjk_inf.html>
 
 and some in-depth reading for the heroes :-)
-F<http://www.ecma.ch/ecma1/STAND/ECMA-035.HTM> (eq ISO-2022)
+
+L<http://www.ecma.ch/ecma1/STAND/ECMA-035.HTM> (eq ISO-2022)
 
 =head1 See Also
 
 L<Encode>, 
 L<Encode::Byte>, 
-L<Encode::CN>, L<Encode::JP>, L<Encode::KR>, L<Encode::TW>
+L<Encode::CN>, L<Encode::JP>, L<Encode::KR>, L<Encode::TW>,
 L<Encode::EBCDIC>, L<Encode::Symbol>
 
 =cut
--- Encode.pm.bak       Sun Mar 24 04:24:42 2002
+++ Encode.pm   Sun Mar 24 13:43:47 2002
@@ -234,7 +234,7 @@
 and the rest of the system.  Perl strings are sequences of B<characters>.
 
 To find more about character encodings, please consult
-L<Encode::Details> . This document focuses on programming references.
+L<Encode::Details>. This document focuses on programming references.
 
 =head1 PERL ENCODING API
 
@@ -242,9 +242,7 @@
 
 =over 4
 
-=item *
-
-        $bytes  = encode(ENCODING, $string[, CHECK])
+=item $bytes  = encode(ENCODING, $string[, CHECK])
 
 Encodes string from Perl's internal form into I<ENCODING> and returns
 a sequence of octets.  For CHECK see L</"Handling Malformed Data">.
@@ -254,9 +252,7 @@
 
        $octets = encode("utf8", $unicode);
 
-=item *
-
-        $string = decode(ENCODING, $bytes[, CHECK])
+=item $string = decode(ENCODING, $bytes[, CHECK])
 
 Decode sequence of octets assumed to be in I<ENCODING> into Perl's
 internal form and returns the resulting string.  For CHECK see
@@ -266,9 +262,7 @@
 
        $utf8 = decode("latin1", $latin1);
 
-=item *
-
-       from_to($string, FROM_ENCODING, TO_ENCODING[, CHECK])
+=item from_to($string, FROM_ENCODING, TO_ENCODING[, CHECK])
 
 Convert B<in-place> the data between two encodings.  How did the data
 in $string originally get to be in FROM_ENCODING?  Either using
@@ -342,32 +336,28 @@
 
 Multiple return values rather than in-place modifications.
 
-Index into the string could be pos($str) allowing s/\G...//.
+Index into the string could be C<pos($str)> allowing C<s/\G...//>.
 
 =back
 
 =head2 UTF-8 / utf8
 
 The Unicode consortium defines the UTF-8 standard as a way of encoding
-the entire Unicode repertiore as sequences of octets.  This encoding is
-expected to become very widespread. Perl can use this form internaly
+the entire Unicode repertoire as sequences of octets.  This encoding is
+expected to become very widespread. Perl can use this form internally
 to represent strings, so conversions to and from this form are
 particularly efficient (as octets in memory do not have to change,
 just the meta-data that tells Perl how to treat them).
 
 =over 4
 
-=item *
-
-        $bytes = encode_utf8($string);
+=item $bytes = encode_utf8($string);
 
 The characters that comprise string are encoded in Perl's superset of UTF-8
 and the resulting octets returned as a sequence of bytes. All possible
 characters have a UTF-8 representation so this function cannot fail.
 
-=item *
-
-        $string = decode_utf8($bytes [,CHECK]);
+=item $string = decode_utf8($bytes [, CHECK]);
 
 The sequence of octets represented by $bytes is decoded from UTF-8
 into a sequence of logical characters. Not all sequences of octets
@@ -391,16 +381,17 @@
 
   @with_jp = Encode->encodings("Encode/JP.pm");
 
-Note in this case you have to say "Encode/JP.pm instead of Encode::JP.
+Note in this case you have to say C<"Encode/JP.pm"> instead of
+C<"Encode::JP">.
 
-To find which encodings are suppoted by this package in details, 
+To find which encodings are supported by this package in details, 
 see L<Encode::Supported>.
 
 =head2 Defining Aliases
 
   use Encode;
   use Encode::Alias;
-  define_alias( newName => ENCODING);
+  define_alias(newName => ENCODING);
 
 Allows newName to be used as am alias for ENCODING. ENCODING may be
 either the name of an encoding or and encoding object (as above).
@@ -410,7 +401,7 @@
 =head1 Defining Encodings
 
     use Encode qw(define_alias);
-    define_encoding( $object, 'canonicalName' [,alias...]);
+    define_encoding($object, 'canonicalName' [, alias...]);
 
 Causes I<canonicalName> to be associated with I<$object>.  The object
 should provide the interface described in L<Encode::Encoding>
@@ -490,15 +481,13 @@
 
 =over 4
 
-=item * is_utf8(STRING [, CHECK])
+=item is_utf8(STRING [, CHECK])
 
 [INTERNAL] Test whether the UTF-8 flag is turned on in the STRING.
 If CHECK is true, also checks the data in STRING for being well-formed
 UTF-8.  Returns true if successful, false otherwise.
 
-=item *
-
-        _utf8_on(STRING)
+=item _utf8_on(STRING)
 
 [INTERNAL] Turn on the UTF-8 flag in STRING.  The data in STRING is
 B<not> checked for being well-formed UTF-8.  Do not use unless you
@@ -506,9 +495,7 @@
 state of the UTF-8 flag (so please don't test the return value as
 I<not> success or failure), or C<undef> if STRING is not a string.
 
-=item *
-
-        _utf8_off(STRING)
+=item _utf8_off(STRING)
 
 [INTERNAL] Turn off the UTF-8 flag in STRING.  Do not use frivolously.
 Returns the previous state of the UTF-8 flag (so please don't test the

Attachment: pgpVYkeUXEmlr.pgp
Description: PGP signature

<Prev in Thread] Current Thread [Next in Thread>
  • [PATCH Encode 0.97] spell check & pod check, Autrijus Tang <=