.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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 "Log::Report::Translator 3pm"
.TH Log::Report::Translator 3pm "2016-10-30" "perl v5.24.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"
Log::Report::Translator \- base implementation for translating messages
.SH "INHERITANCE"
.IX Header "INHERITANCE"
.Vb 3
\& Log::Report::Translator is extended by
\&   Log::Report::Translator::Gettext
\&   Log::Report::Translator::POT
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& # internal infrastructure
\& my $msg = Log::Report::Message\->new(_msgid => "Hello World\en");
\& print Log::Report::Translator\->new(...)\->translate($msg);
\&
\& # normal use
\& textdomain \*(Aqmy\-domain\*(Aq
\&   , translator => Log::Report::Translator\->new;  # default
\& print _\|_"Hello World\en";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A module (or distribution) has a certain way of translating messages,
usually \f(CW\*(C`gettext\*(C'\fR.  The translator is based on some \f(CW\*(C`textdomain\*(C'\fR
for the message, which can be specified as option per text element,
but usually is package scoped.
.PP
This base class does not translate at all: it will use the \s-1MSGID
\&\s0(and \s-1MSGID_PLURAL\s0 if available).  It's a nice fallback if the
language packs are not installed.
.SH "METHODS"
.IX Header "METHODS"
.SS "Constructors"
.IX Subsection "Constructors"
.IP "Log::Report::Translator\->\fBnew\fR(%options)" 4
.IX Item "Log::Report::Translator->new(%options)"
.Vb 3
\& \-Option  \-\-Default
\&  charset   <from locale>
\&  lexicons  <see text>
.Ve
.RS 4
.IP "charset => \s-1STRING\s0" 2
.IX Item "charset => STRING"
When the locale contains a codeset in its name, then that will be
used.  Otherwise, the default is \f(CW\*(C`utf\-8\*(C'\fR.
.IP "lexicons => DIRECTORY|ARRAY\-of\-DIRECTORYs" 2
.IX Item "lexicons => DIRECTORY|ARRAY-of-DIRECTORYs"
The \s-1DIRECTORY\s0 where the translations can be found.  See
Log::Report::Lexicon::Index for the expected structure of such
\&\s-1DIRECTORY.\s0
.Sp
The default is based on the location of the module which instantiates
this translator.  The filename of the module is stripped from its \f(CW\*(C`.pm\*(C'\fR
extension, and used as directory name.  Within that directory, there
must be a directory named \f(CW\*(C`messages\*(C'\fR, which will be the root directory
of a Log::Report::Lexicon::Index.
.RE
.RS 4
.Sp
example: default lexicon directory
.Sp
.Vb 3
\& # file xxx/perl5.8.8/My/Module.pm
\& use Log::Report \*(Aqmy\-domain\*(Aq
\&   , translator => Log::Report::Translator::POT\->new;
\&
\& # lexicon now in xxx/perl5.8.8/My/Module/messages/
.Ve
.RE
.SS "Accessors"
.IX Subsection "Accessors"
.ie n .IP "$obj\->\fBcharset\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBcharset\fR()" 4
.IX Item "$obj->charset()"
Returns the default charset, which can be overrule by the locale.
.ie n .IP "$obj\->\fBlexicons\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBlexicons\fR()" 4
.IX Item "$obj->lexicons()"
Returns a list of Log::Report::Lexicon::Index objects, where the
translation files may be located.
.SS "Translating"
.IX Subsection "Translating"
.ie n .IP "$obj\->\fBload\fR($domain, $locale)" 4
.el .IP "\f(CW$obj\fR\->\fBload\fR($domain, \f(CW$locale\fR)" 4
.IX Item "$obj->load($domain, $locale)"
Load the translation information in the text \f(CW$domain\fR for the indicated \f(CW$locale\fR.
Multiple calls to \fIload()\fR should not cost significant performance: the
data must be cached.
.ie n .IP "$obj\->\fBtranslate\fR( $message, [$language, $ctxt] )" 4
.el .IP "\f(CW$obj\fR\->\fBtranslate\fR( \f(CW$message\fR, [$language, \f(CW$ctxt\fR] )" 4
.IX Item "$obj->translate( $message, [$language, $ctxt] )"
Returns the translation of the \f(CW$message\fR, a \f(CW\*(C`Log::Report::Message\*(C'\fR object,
based on the current locale.
.Sp
Translators are permitted to peek into the internal \s-1HASH\s0 of the
message object, for performance reasons.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of Log-Report distribution version 1.18,
built on October 21, 2016. Website: \fIhttp://perl.overmeer.net/log\-report/\fR
.SH "LICENSE"
.IX Header "LICENSE"
Copyrights 2007\-2016 by [Mark Overmeer]. For other contributors see ChangeLog.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See \fIhttp://www.perl.com/perl/misc/Artistic.html\fR