.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Template::Multilingual::Parser 3pm"
.TH Template::Multilingual::Parser 3pm "2009-01-18" "perl v5.10.0" "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::Multilingual::Parser \- Multilingual template parser
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& use Template;
\& use Template::Multilingual::Parser;
\&
\& my $parser = Template::Multilingual::Parser\->new();
\& my $template = Template\->new(PARSER => $parser);
\& $template\->process(\*(Aqexample.ttml\*(Aq, { language => \*(Aqen\*(Aq});
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This subclass of Template Toolkit's \f(CW\*(C`Template::Parser\*(C'\fR parses multilingual
templates: templates that contain text in several languages.
.PP
.Vb 4
\&
\& Hello!
\& Bonjour !
\&
.Ve
.PP
Use this module directly if you have subclassed \f(CW\*(C`Template\*(C'\fR, otherwise you
may find it easier to use \f(CW\*(C`Template::Multilingual\*(C'\fR.
.PP
Language codes can be any string that matches \f(CW\*(C`\ew+\*(C'\fR, but we suggest
sticking to \s-1ISO\-639\s0 which provides 2\-letter codes for common languages
and 3\-letter codes for many others.
.SH "METHODS"
.IX Header "METHODS"
.SS "new(\e%params)"
.IX Subsection "new(%params)"
The \fInew()\fR constructor creates and returns a reference to a new
parser object. A reference to a hash may be supplied as a
parameter to provide configuration values.
.PP
Parser objects are typically provided as the \f(CW\*(C`PARSER\*(C'\fR option
to the \f(CW\*(C`Template\*(C'\fR constructor.
.PP
Configuration values are all valid \f(CW\*(C`Template::Parser\*(C'\fR superclass
options, and one specific to this class:
.IP "\s-1LANGUAGE_VAR\s0" 4
.IX Item "LANGUAGE_VAR"
The \s-1LANGUAGE_VAR\s0 option can be used to set the name of the template
variable which contains the current language. Defaults to
\&\fIlanguage\fR.
.Sp
.Vb 3
\& my $parser = Template::Multilingual::Parser\->new({
\& LANGUAGE_VAR => \*(Aqglobal.language\*(Aq,
\& });
.Ve
.Sp
You will need to set this variable with the current language value
at request time, usually in your \f(CW\*(C`Template\*(C'\fR subclass' \f(CW\*(C`process()\*(C'\fR
method.
.SS "parse($text)"
.IX Subsection "parse($text)"
\&\fIparse()\fR is called by the Template Toolkit. It parses multilingual
sections from the input text and translates them to Template Toolkit
directives. The result is then passed to the \f(CW\*(C`Template::Parser\*(C'\fR superclass.
.SS "sections"
.IX Subsection "sections"
Returns a reference to an array of tokenized sections. Each section is a
reference to hash with either a \f(CW\*(C`nolang\*(C'\fR key or a \f(CW\*(C`lang\*(C'\fR key.
.PP
A \f(CW\*(C`nolang\*(C'\fR key denotes text outside of any multilingual sections. The value
is the text itself.
.PP
A \f(CW\*(C`lang\*(C'\fR key denotes text inside a multilingual section. The value is a
reference to a hash, whose keys are language codes and values the corresponding
text. For example, the following multilingual template:
.PP
.Vb 1
\& foo bonjourHello bar
.Ve
.PP
will parse to the following sections:
.PP
.Vb 4
\& [ { nolang => \*(Aqfoo \*(Aq },
\& { lang => { fr => \*(Aqbonjour\*(Aq, en => \*(Aqhello\*(Aq } },
\& { nolang => \*(Aq bar\*(Aq },
\& ]
.Ve
.SH "LANGUAGE SUBTAG HANDLING"
.IX Header "LANGUAGE SUBTAG HANDLING"
This module supports language subtags to express variants, e.g. \*(L"en_US\*(R" or \*(L"en-US\*(R".
Here are the rules used for language matching:
.IP "\(bu" 4
Exact match: the current language is found in the template
.Sp
.Vb 3
\& language template output
\& fr foobar foo
\& fr_CA foobar bar
.Ve
.IP "\(bu" 4
Fallback to the primary language
.Sp
.Vb 2
\& language template output
\& fr_CA foobar foo
.Ve
.IP "\(bu" 4
Fallback to first (in alphabetical order) other variant of the primary language
.Sp
.Vb 3
\& language template output
\& fr foobar bar
\& fr_CA foobar bar
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Eric Cholet, \f(CW\*(C`\*(C'\fR
.SH "BUGS"
.IX Header "BUGS"
Multilingual text sections cannot be used inside \s-1TT\s0 directives.
The following is illegal and will trigger a \s-1TT\s0 syntax error:
.PP
.Vb 1
\& [% title = "BonjourHello" %]
.Ve
.PP
Use this instead:
.PP
.Vb 1
\& [% title = BLOCK %]BonjourHello[% END %]
.Ve
.PP
The \s-1TAG_STYLE\s0, \s-1START_TAG\s0 and \s-1END_TAG\s0 directives are supported, but the
\&\s-1TAGS\s0 directive is not.
.PP
Please report any bugs or feature requests to
\&\f(CW\*(C`bug\-template\-multilingual@rt.cpan.org\*(C'\fR, or through the web interface at
.
I will be notified, and then you'll automatically be notified of progress on
your bug as I make changes.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Template::Multilingual
.PP
\&\s-1ISO\s0 639\-2 Codes for the Representation of Names of Languages:
http://www.loc.gov/standards/iso639\-2/langcodes.html
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2009 Eric Cholet, All Rights Reserved.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.