Document the ENCODING option

Fixes https://rt.cpan.org/Public/Bug/Display.html?id=64694
abw · Mar 12, 2013 · dfc61e1 · dfc61e1
1 parent 5550611
commit dfc61e1
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/Changes b/Changes
@@ -19,6 +19,9 @@
 * Applied a patch from Slaven Rezic to silence warnings in the replace
   vmethod.  https://rt.cpan.org/Ticket/Display.html?id=76694
 
+* Applied a patch from Smylers to document the ENCODING option.
+  https://rt.cpan.org/Public/Bug/Display.html?id=64694
+
 #-----------------------------------------------------------------------
 # Version 2.24 - 8th February 2012
 #------------------------------------------------------------------------

diff --git a/lib/Template.pm b/lib/Template.pm
@@ -477,6 +477,10 @@ configuration option.  See L<Template::Manual::Config> for full details.
 
 =head2 Template Style and Parsing Options
 
+=head3 ENCODING
+
+Specifies the character encoding.
+
 =head3 START_TAG, END_TAG
 
 Define tokens that indicate start and end of directives

diff --git a/lib/Template/Manual/Config.pod b/lib/Template/Manual/Config.pod
@@ -19,6 +19,17 @@ Template::Manual::Config - Configuration options
 
 =head1 Template Style and Parsing Options
 
+=head2 ENCODING
+
+The C<ENCODING> option specifies the template files' character encoding:
+
+    my $template = Template->new({ 
+        END_TAG => 'utf8',
+    });
+
+A template which starts with a Unicode byte order mark (BOM) will have its
+encoding detected automatically.
+
 =head2 START_TAG, END_TAG
 
 The C<START_TAG> and C<END_TAG> options are used to specify character