Browse files

document that parser expects octets

  • Loading branch information...
1 parent 903da7c commit e2178e911b931ee61be9d512001ddc43d71d3080 @grantm grantm committed Aug 11, 2012
Showing with 13 additions and 0 deletions.
  1. +13 −0 lib/Pod/Simple.pod
@@ -14,6 +14,8 @@ documentation") markup language that is typically used for writing
documentation for Perl and for Perl modules. The Pod format is explained
L<perlpod>; the most common formatter is called C<perldoc>.
+Be sure to read L</ENCODING> if your Pod contains non-ASCII characters.
Pod formatters can use Pod::Simple to parse Pod documents and render them into
plain text, HTML, or any number of other formats. Typically, such formatters
will be subclasses of Pod::Simple, and so they will inherit its methods, like
@@ -322,6 +324,17 @@ Log an error unless C<< $parser->no_whining( TRUE ); >>.
+=head1 ENCODING
+The Pod::Simple parser expects to read B<octets>. The parser will decode the
+octets into Perl's internal character string representation using the value of
+the C<=encoding> declaration in the POD source.
+If the POD source does not include an C<=encoding> declaration, the parser will
+attempt to guess the encoding (selecting one of UTF-8 or Latin-1) by examining
+the first non-ASCII bytes and applying the heuristic described in
=head1 CAVEATS
This is just a beta release -- there are a good number of things still

0 comments on commit e2178e9

Please sign in to comment.