.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" 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 "Log::Report::Message 3pm"
.TH Log::Report::Message 3pm "2014-06-24" "perl v5.18.2" "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::Message \- a piece of text to be translated
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& # Objects created by Log::Report\*(Aqs _\|_ functions
\& # Full feature description in the DETAILS section
\&
\& # no interpolation
\& _\|_"Hello, World";
\&
\& # with interpolation
\& _\|_x"age {years}", years => 12;
\&
\& # interpolation for one or many
\& my $nr_files = @files;
\& _\|_nx"one file", "{_count} files", $nr_files;
\& _\|_nx"one file", "{_count} files", \e@files;
\&
\& # interpolation of arrays
\& _\|_x"price\-list: {prices%.2f}", prices => \e@prices, _join => \*(Aq, \*(Aq;
\&
\& # white\-spacing on msgid preserved
\& print _\|_"\etCongratulations,\en";
\& print "\et", _\|_("Congratulations,"), "\en";  # same
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Any use of a translation function exported by Log::Report, like
\&\f(CW\*(C`_\|_()\*(C'\fR (the function is named underscore-underscore) or \f(CW\*(C`_\|_x()\*(C'\fR
(underscore-underscore-x) will result in this object.  It will capture
some environmental information, and delay the translation until it
is needed.
.PP
Creating an object first and translating it later, is slower than
translating it immediately.  However, on the location where the message
is produced, we do not yet know in what language to translate it to:
that depends on the front-end, the log dispatcher.
.SH "METHODS"
.IX Header "METHODS"
.SS "Constructors"
.IX Subsection "Constructors"
.ie n .IP "$obj\->\fBclone\fR(%options, $variables)" 4
.el .IP "\f(CW$obj\fR\->\fBclone\fR(%options, \f(CW$variables\fR)" 4
.IX Item "$obj->clone(%options, $variables)"
Returns a new object which copies info from original, and updates it
with the specified \f(CW%options\fR and \f(CW$variables\fR.  The advantage is that the
cached translations are shared between the objects.
.Sp
example: use of \fIclone()\fR
.Sp
.Vb 5
\& my $s = _\|_x "found {nr} files", nr => 5;
\& my $t = $s\->clone(nr => 3);
\& my $t = $s\->(nr => 3);      # equivalent
\& print $s;     # found 5 files
\& print $t;     # found 3 files
.Ve
.ie n .IP "Log::Report::Message\->\fBfromTemplateToolkit\fR($domain, $msgid, $params)" 4
.el .IP "Log::Report::Message\->\fBfromTemplateToolkit\fR($domain, \f(CW$msgid\fR, \f(CW$params\fR)" 4
.IX Item "Log::Report::Message->fromTemplateToolkit($domain, $msgid, $params)"
See Log::Report::Extract::Template on the details how to integrate
Log::Report translations with Template::Toolkit (version 1 and 2)
.IP "Log::Report::Message\->\fBnew\fR(%options)" 4
.IX Item "Log::Report::Message->new(%options)"
\&\fBEnd-users: do not use this method directly\fR, but use Log::Report::_\|_()
and friends.  The \f(CW%options\fR is a mixed list of object initiation parameters
(all with a leading underscore) and variables to be filled in into the
translated \f(CW\*(C`_msgid\*(C'\fR string.
.Sp
.Vb 10
\& \-Option   \-\-Default
\&  _append    undef
\&  _category  undef
\&  _class     []
\&  _classes   []
\&  _context   undef
\&  _count     undef
\&  _domain    <from "use Log::Report">
\&  _expand    false
\&  _join      $" $LIST_SEPARATOR
\&  _lang      <from locale>
\&  _msgid     undef
\&  _plural    undef
\&  _prepend   undef
\&  _to        <undef>
.Ve
.RS 4
.IP "_append => STRING|MESSAGE" 2
.IX Item "_append => STRING|MESSAGE"
Text as \s-1STRING\s0 or \s-1MESSAGE\s0 object to be displayed after the display
of this message.
.IP "_category => \s-1INTEGER\s0" 2
.IX Item "_category => INTEGER"
The category when the real gettext library is used, for instance
\&\s-1LC_MESSAGES.\s0
.IP "_class => STRING|ARRAY" 2
.IX Item "_class => STRING|ARRAY"
When messages are used for exception based programming, you add
\&\f(CW\*(C`_class\*(C'\fR parameters to the argument list.  Later, with for instance
Log::Report::Dispatcher::Try::wasFatal(class), you can check the
category of the message.
.Sp
One message can be part of multiple classes.  The \s-1STRING\s0 is used as
comma\- and/or blank separated list of class tokens (barewords), the
\&\s-1ARRAY\s0 lists all tokens separately. See \fIclasses()\fR.
.IP "_classes => STRING|ARRAY" 2
.IX Item "_classes => STRING|ARRAY"
Alternative for \f(CW\*(C`_class\*(C'\fR, which cannot be used at the same time.
.IP "_context => WORDS|ARRAY" 2
.IX Item "_context => WORDS|ARRAY"
[1.00] Set keywords which can be used to select alternatives
between translations.  Read the \s-1DETAILS\s0 section in
Log::Report::Translator::Context
.IP "_count => INTEGER|ARRAY|HASH" 2
.IX Item "_count => INTEGER|ARRAY|HASH"
When defined, the \f(CW\*(C`_plural\*(C'\fR need to be defined as well.  When an
\&\s-1ARRAY\s0 is provided, the length of the \s-1ARRAY\s0 is taken.  When a \s-1HASH\s0
is given, the number of keys in the \s-1HASH\s0 is used.
.IP "_domain => \s-1STRING\s0" 2
.IX Item "_domain => STRING"
The text-domain (translation table) to which this \f(CW\*(C`_msgid\*(C'\fR belongs.
.Sp
With this parameter, your can \*(L"borrow\*(R" translations from other textdomains.
Be very careful with this (although there are good use-cases)  The xgettext
msgid extractor may add the used msgid to this namespace as well.  To
avoid that, add a harmless '+':
.Sp
.Vb 1
\&  print _\|_x(+"errors", _domain => \*(Aqglobal\*(Aq);
.Ve
.Sp
The extractor will not take the msgid when it is an expression.  The '+'
has no effect on the string at runtime.
.IP "_expand => \s-1BOOLEAN\s0" 2
.IX Item "_expand => BOOLEAN"
Indicates whether variables are to be filled-in.
.IP "_join => \s-1STRING\s0" 2
.IX Item "_join => STRING"
Which \s-1STRING\s0 to be used then an \s-1ARRAY\s0 is being filled-in.
.IP "_lang => \s-1ISO\s0" 2
.IX Item "_lang => ISO"
[1.00] Override language setting from locale, for instance because that
is not configured correctly (yet).  This does not extend to prepended
or appended translated message object.
.IP "_msgid => \s-1MSGID\s0" 2
.IX Item "_msgid => MSGID"
The message label, which refers to some translation information.
Usually a string which is close the English version of the message.
This will also be used if there is no translation possible/known.
.Sp
Leading white-space \f(CW\*(C`\es\*(C'\fR will be added to \f(CW\*(C`_prepend\*(C'\fR.  Trailing
white-space will be added before \f(CW\*(C`_append\*(C'\fR.
.IP "_plural => \s-1MSGID\s0" 2
.IX Item "_plural => MSGID"
Can be used together with \f(CW\*(C`_count\*(C'\fR.  This plural form of the \f(CW\*(C`_msgid\*(C'\fR
text is used to simplify the work of translators, and as fallback when
no translation is possible: therefore, this can best resemble an
English message.
.Sp
White-space at the beginning and end of the string are stripped off.
The white-space provided by the \f(CW\*(C`_msgid\*(C'\fR will be used.
.IP "_prepend => STRING|MESSAGE" 2
.IX Item "_prepend => STRING|MESSAGE"
Text as \s-1STRING\s0 or \s-1MESSAGE\s0 object to be displayed before the display
of this message.
.IP "_to => \s-1NAME\s0" 2
.IX Item "_to => NAME"
Specify the \s-1NAME\s0 of a dispatcher as destination explicitly. Short
for  \f(CW\*(C`report {to => NAME}, ...\*(C'\fR  See \fIto()\fR
.RE
.RS 4
.RE
.SS "Accessors"
.IX Subsection "Accessors"
.ie n .IP "$obj\->\fBappend\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBappend\fR()" 4
.IX Item "$obj->append()"
Returns the string or Log::Report::Message object which is appended
after this one.  Usually \f(CW\*(C`undef\*(C'\fR.
.ie n .IP "$obj\->\fBclasses\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBclasses\fR()" 4
.IX Item "$obj->classes()"
Returns the \s-1LIST\s0 of classes which are defined for this message; message
group indicators, as often found in exception-based programming.
.ie n .IP "$obj\->\fBcontext\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBcontext\fR()" 4
.IX Item "$obj->context()"
Returns an \s-1HASH\s0 if there is a context defined for this message.
.ie n .IP "$obj\->\fBcount\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBcount\fR()" 4
.IX Item "$obj->count()"
Returns the count, which is used to select the translation
alternatives.
.ie n .IP "$obj\->\fBdomain\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBdomain\fR()" 4
.IX Item "$obj->domain()"
Returns the domain of the first translatable string in the structure.
.ie n .IP "$obj\->\fBmsgid\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBmsgid\fR()" 4
.IX Item "$obj->msgid()"
Returns the msgid which will later be translated.
.ie n .IP "$obj\->\fBprepend\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBprepend\fR()" 4
.IX Item "$obj->prepend()"
Returns the string which is prepended to this one.  Usually \f(CW\*(C`undef\*(C'\fR.
.ie n .IP "$obj\->\fBto\fR( [$name] )" 4
.el .IP "\f(CW$obj\fR\->\fBto\fR( [$name] )" 4
.IX Item "$obj->to( [$name] )"
Returns the \f(CW$name\fR of a dispatcher if explicitly specified with
the '_to' key. Can also be used to set it.  Usually, this will
return undef, because usually all dispatchers get all messages.
.ie n .IP "$obj\->\fBvalueOf\fR($parameter)" 4
.el .IP "\f(CW$obj\fR\->\fBvalueOf\fR($parameter)" 4
.IX Item "$obj->valueOf($parameter)"
Lookup the named \f(CW$parameter\fR for the message.  All pre-defined names
have their own method which should be used with preference.
.Sp
example:
.Sp
When the message was produced with
.Sp
.Vb 9
\&  my @files = qw/one two three/;
\&  my $msg = _\|_xn "found one file: {file}"
\&               , "found {nrfiles} files: {files}"
\&               , scalar @files
\&               , file    => $files[0]
\&               , files   => \e@files
\&               , nrfiles => @files+0
\&               , _class  => \*(AqIO, files\*(Aq
\&               , _join   => \*(Aq, \*(Aq;
.Ve
.Sp
then the values can be takes from the produced message as
.Sp
.Vb 5
\&  my $files = $msg\->valueOf(\*(Aqfiles\*(Aq);  # returns ARRAY reference
\&  print @$files;              # 3
\&  my $count = $msg\->count;    # 3
\&  my @class = $msg\->classes;  # \*(AqIO\*(Aq, \*(Aqfiles\*(Aq
\&  if($msg\->inClass(\*(Aqfiles\*(Aq))  # true
.Ve
.Sp
Simplified, the above example can also be written as:
.Sp
.Vb 6
\&  local $" = \*(Aq, \*(Aq;
\&  my $msg  = _\|_xn "found one file: {files}"
\&                , "found {_count} files: {files}"
\&                , @files      # has scalar context
\&                , files   => \e@files
\&                , _class  => \*(AqIO, files\*(Aq;
.Ve
.SS "Processing"
.IX Subsection "Processing"
.ie n .IP "$obj\->\fBconcat\fR( STRING|$object, [$prepend] )" 4
.el .IP "\f(CW$obj\fR\->\fBconcat\fR( STRING|$object, [$prepend] )" 4
.IX Item "$obj->concat( STRING|$object, [$prepend] )"
This method implements the overloading of concatenation, which is needed
to delay translations even longer.  When \f(CW$prepend\fR is true, the \s-1STRING\s0
or \f(CW$object\fR (other \f(CW\*(C`Log::Report::Message\*(C'\fR) needs to prepended, otherwise
it is appended.
.Sp
example: of concatenation
.Sp
.Vb 2
\& print _\|_"Hello" . \*(Aq \*(Aq . _\|_"World!";
\& print _\|_("Hello")\->concat(\*(Aq \*(Aq)\->concat(_\|_"World!")\->concat("\en");
.Ve
.ie n .IP "$obj\->\fBinClass\fR($class|Regexp)" 4
.el .IP "\f(CW$obj\fR\->\fBinClass\fR($class|Regexp)" 4
.IX Item "$obj->inClass($class|Regexp)"
Returns true if the message is in the specified \f(CW$class\fR (string) or
matches the Regexp.  The trueth value is the (first matching) class.
.ie n .IP "$obj\->\fBtoString\fR( [$locale] )" 4
.el .IP "\f(CW$obj\fR\->\fBtoString\fR( [$locale] )" 4
.IX Item "$obj->toString( [$locale] )"
Translate a message.  If not specified, the default locale is used.
.ie n .IP "$obj\->\fBuntranslated\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBuntranslated\fR()" 4
.IX Item "$obj->untranslated()"
Return the concatenation of the prepend, msgid, and append strings.  Variable
expansions within the msgid is not performed.
.SH "DETAILS"
.IX Header "DETAILS"
.SS "\s-1OPTIONS\s0 and \s-1VARIABLES\s0"
.IX Subsection "OPTIONS and VARIABLES"
The Log::Report functions which define translation request can all
have \s-1OPTIONS. \s0 Some can have \s-1VARIABLES\s0 to be interpolated in the string as
well.  To distinguish between the \s-1OPTIONS\s0 and \s-1VARIABLES \s0(both a list
of key-value pairs), the keys of the \s-1OPTIONS\s0 start with an underscore \f(CW\*(C`_\*(C'\fR.
As result of this, please avoid the use of keys which start with an
underscore in variable names.  On the other hand, you are allowed to
interpolate \s-1OPTION\s0 values in your strings.
.PP
\fIInterpolating\fR
.IX Subsection "Interpolating"
.PP
With the \f(CW\*(C`_\|_x()\*(C'\fR or \f(CW\*(C`_\|_nx()\*(C'\fR, interpolation will take place on the
translated \s-1MSGID\s0 string.  The translation can contain the \s-1VARIABLE\s0
and \s-1OPTION\s0 names between curly brackets.  Text between curly brackets
which is not a known parameter will be left untouched.
.PP
.Vb 1
\& fault _\|_x"cannot open open {filename}", filename => $fn;
\&
\& print _\|_xn"directory {dir} contains one file"
\&          ,"directory {dir} contains {nr_files} files"
\&          , scalar(@files)            # (1) (2)
\&          , nr_files => scalar @files # (3)
\&          , dir      => $dir;
.Ve
.PP
(1) this required third parameter is used to switch between the different
plural forms.  English has only two forms, but some languages have many
more.
.PP
(2) the \*(L"scalar\*(R" keyword is not needed, because the third parameter is
in \s-1SCALAR\s0 context.  You may also pass \f(CW\*(C` \e@files \*(C'\fR there, because ARRAYs
will be converted into their length.  A \s-1HASH\s0 will be converted into the
number of keys in the \s-1HASH.\s0
.PP
(3) the \f(CW\*(C`scalar\*(C'\fR keyword is required here, because it is \s-1LIST\s0 context:
otherwise all filenames will be filled-in as parameters to \f(CW\*(C`_\|_xn()\*(C'\fR.
See below for the available \f(CW\*(C`_count\*(C'\fR valure, to see how the \f(CW\*(C`nr_files\*(C'\fR
parameter can disappear.
.PP
\fIInterpolation of \s-1VARIABLES\s0\fR
.IX Subsection "Interpolation of VARIABLES"
.PP
\&\f(CW\*(C`Log::Report\*(C'\fR uses String::Print to interpolate values in(translated)
messages.  This is a very powerful syntax, and you should certainly read
that manual-page.  Here, we only described additional features, specific
to the usage of \f(CW\*(C`String::Print\*(C'\fR in \f(CW\*(C`Log::Report::Message\*(C'\fR objects.
.PP
There is no way of checking beforehand whether you have provided all
required values, to be interpolated in the translated string.
.PP
For interpolating, the following rules apply:
.IP "\(bu" 4
Simple scalar values are interpolated \*(L"as is\*(R"
.IP "\(bu" 4
References to SCALARs will collect the value on the moment that the
output is made.  The \f(CW\*(C`Log::Report::Message\*(C'\fR object which is created with
the \f(CW\*(C`_\|_xn\*(C'\fR can be seen as a closure.  The translation can be reused.
See example below.
.IP "\(bu" 4
Code references can be used to create the data \*(L"under fly\*(R".  The
\&\f(CW\*(C`Log::Report::Message\*(C'\fR object which is being handled is passed as
only argument.  This is a hash in which all \s-1OPTIONS\s0 and \s-1VARIABLES\s0
can be found.
.IP "\(bu" 4
When the value is an \s-1ARRAY,\s0 all members will be interpolated with \f(CW$"\fR
between the elements.  Alternatively (maybe nicer), you can pass an
interpolation parameter via the \f(CW\*(C`_join\*(C'\fR \s-1OPTION.\s0
.PP
.Vb 2
\& local $" = \*(Aq, \*(Aq;
\& error _\|_x"matching files: {files}", files => \e@files;
\&
\& error _\|_x"matching files: {files}", files => \e@files, _join => \*(Aq, \*(Aq;
.Ve
.PP
\fIInterpolation of \s-1OPTIONS\s0\fR
.IX Subsection "Interpolation of OPTIONS"
.PP
You are permitted the interpolate \s-1OPTION\s0 values in your string.  This may
simplify your coding.  The useful names are:
.IP "_msgid" 4
.IX Item "_msgid"
The \s-1MSGID\s0 as provided with Log::Report::_\|_() and Log::Report::_\|\fI_x()\fR
.IP "_plural, _count" 4
.IX Item "_plural, _count"
The \s-1PLURAL\s0 MSGIDs, respectively the \s-1COUNT\s0 as used with
Log::Report::_\|\fI_n()\fR and Log::Report::_\|\fI_nx()\fR
.IP "_textdomain" 4
.IX Item "_textdomain"
The label of the textdomain in which the translation takes place.
.IP "_class or _classes" 4
.IX Item "_class or _classes"
Are to be used to group reports, and can be queried with \fIinClass()\fR,
\&\fILog::Report::Exception::inClass()\fR, or
\&\fILog::Report::Dispatcher::Try::wasFatal()\fR.
.PP
\fIHandling white-spaces\fR
.IX Subsection "Handling white-spaces"
.PP
In above examples, the msgid and plural form have a trailing new-line.
In general, it is much easier to write
.PP
.Vb 1
\&   print _\|_x"Hello, World!\en";
.Ve
.PP
than
.PP
.Vb 1
\&   print _\|_x("Hello, World!") . "\en";
.Ve
.PP
For the translation tables, however, that trailing new-line is \*(L"over
information\*(R"; it is an layout issue, not a translation issue.
.PP
Therefore, the first form will automatically be translated into the
second.  All leading and trailing white-space (blanks, new-lines, tabs,
\&...) are removed from the msgid befor the look-up, and then added to
the translated string.
.PP
Leading and trailing white-space on the plural form will also be
removed.  However, after translation the spacing of the msgid will
be used.
.PP
\fIAvoiding repetative translations\fR
.IX Subsection "Avoiding repetative translations"
.PP
This way of translating is somewhat expensive, because an object to
handle the \f(CW\*(C`_\|_x()\*(C'\fR is created each time.
.PP
.Vb 3
\& for my $i (1..100_000)
\& {   print _\|_x "Hello World {i}\en", i => $i;
\& }
.Ve
.PP
The suggestion that Locale::TextDomain makes to improve performance,
is to get the translation outside the loop, which only works without
interpolation:
.PP
.Vb 6
\& use Locale::TextDomain;
\& my $i = 42;
\& my $s = _\|_x("Hello World {i}\en", i => $i);
\& foreach $i (1..100_000)
\& {   print $s;
\& }
.Ve
.PP
Oops, not what you mean because the first value of \f(CW$i\fR is captured
in the initial message object.  With Log::Report, you can do it (except
when you use contexts)
.PP
.Vb 6
\& use Log::Report;
\& my $i;
\& my $s = _\|_x("Hello World {i}\en", i => \e$i);
\& foreach $i (1..100_000)
\& {   print $s;
\& }
.Ve
.PP
Mind you not to write: \f(CW\*(C`for my $i\*(C'\fR in above case!!!!
.PP
You can also write an incomplete translation:
.PP
.Vb 5
\& use Log::Report;
\& my $s = _\|_x "Hello World {i}\en";
\& foreach my $i (1..100_000)
\& {   print $s\->(i => $i);
\& }
.Ve
.PP
In either case, the translation will be looked-up only once.
.SH "OVERLOADING"
.IX Header "OVERLOADING"
.ie n .IP "overload: \fBas \fB$function\fB\fR" 4
.el .IP "overload: \fBas \f(CB$function\fB\fR" 4
.IX Item "overload: as $function"
When the object is used to call as \f(CW$function\fR, a new object is
created with the data from the original one but updated with the
new parameters.  Implemented in \f(CW\*(C`clone()\*(C'\fR.
.IP "overload: \fBconcatenation\fR" 4
.IX Item "overload: concatenation"
An (accidental) use of concatenation (a dot where a comma should be
used) would immediately stringify the object.  This is avoided by
overloading that operation.
.IP "overload: \fBstringification\fR" 4
.IX Item "overload: stringification"
When the object is used in string context, it will get translated.
Implemented as \fItoString()\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of Log-Report distribution version 1.05,
built on June 24, 2014. Website: \fIhttp://perl.overmeer.net/log\-report/\fR
.SH "LICENSE"
.IX Header "LICENSE"
Copyrights 2007\-2014 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