.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Template::Provider::Encoding 3pm"
.TH Template::Provider::Encoding 3pm "2018-01-28" "perl v5.26.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Template::Provider::Encoding \- Explicitly declare encodings of your templates
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&  use Template::Provider::Encoding;
\&  use Template::Stash::ForceUTF8;
\&  use Template;
\&
\&  my $tt = Template\->new(
\&      LOAD_TEMPLATES => [ Template::Provider::Encoding\->new ],
\&      STASH => Template::Stash::ForceUTF8\->new,
\&  );
\&
\&  # Everything should be Unicode
\&  # (but you can pass UTF\-8 bytes as well, thanks to Template::Stash::ForceUTF8)
\&  my $author = "\ex{5bae}\ex{5ddd}";
\&
\&  # this will emit Unicode flagged string to STDOUT. You might
\&  # probably want to binmode(STDOUT, ":encoding($enccoding)")
\&  # before process() call
\&  $tt\->process($template, { author => $author });
\&
\&  # in your templates
\&  [% USE encoding \*(Aqutf\-8\*(Aq \-%]
\&  My name is [% author %]. { ... whatever UTF\-8 bytes }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Template::Provider::Encoding is a Template Provider subclass to decode
template using its declaration. You have to declare encoding of the
template in the head (1st line) of template using (fake) encoding \s-1TT\s0
plugin. Otherwise the template is handled as utf\-8.
.PP
.Vb 2
\&  [% USE encoding \*(Aqutf\-8\*(Aq %]
\&  Here comes utf\-8 strings with [% variable %].
.Ve
.SH "DIFFERNCE WITH OTHER WAYS"
.IX Header "DIFFERNCE WITH OTHER WAYS"
.SS "\s-1UNICODE\s0 option and \s-1BOM\s0"
.IX Subsection "UNICODE option and BOM"
Recent \s-1TT\s0 allows \f(CW\*(C`UNICODE\*(C'\fR option to Template::Provider and by adding
it Provider scans \s-1BOM\s0 (byte-order mark) to detect \s-1UTF\-8/UTF\-16\s0 encoded
template files. This module does basically the same thing in a
different way, but \s-1IMHO\s0 adding \s-1BOM\s0 to template files is a little
painful especially for non-programmers.
.SS "Template::Provider::Encode"
.IX Subsection "Template::Provider::Encode"
Template::Provider::Encode provides a very similar way to detect
Template file encodings and output the template into various
encodings.
.PP
This module doesn't touch output encoding of the template and instead
it emits valid Unicode flagged string. I think the output encoding
conversion should be done by other piece of code, especially in the
framework.
.PP
This module doesn't require you to specify encoding in the code, nor
doesn't \fIguess\fR encodings. Instead it forces you to put \f(CW\*(C`[% USE
encoding \*(Aqfoo\-bar\*(Aq %]\*(C'\fR in the top of template files, which is
explicit and, I think, is a good convention.
.SH "AUTHOR"
.IX Header "AUTHOR"
Tatsuhiko Miyagawa <miyagawa@bulknews.net>
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Template::Stash::ForceUTF8, Template::Provider::Encode