.\" 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 "Log::Report::Lexicon::POTcompact 3pm"
.TH Log::Report::Lexicon::POTcompact 3pm "2018-04-16" "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"
Log::Report::Lexicon::POTcompact \- use translations from a POT file
.SH "INHERITANCE"
.IX Header "INHERITANCE"
.Vb 2
\& Log::Report::Lexicon::POTcompact
\&   is a Log::Report::Lexicon::Table
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& # using a PO table efficiently
\& my $pot = Log::Report::Lexicon::POTcompact\->read(\*(Aqpo/nl.po\*(Aq)
\&    or die;
\&
\& my $header = $pot\->msgid(\*(Aq\*(Aq);
\& print $pot\->msgstr(\*(Aqmsgid\*(Aq, 3);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module is translating, based on \s-1PO\s0 files. \s-1PO\s0 files are used to store
translations in humanly readable format for most of existing translation
frameworks, like \s-1GNU\s0 gettext and Perl's Maketext.
.PP
Internally, this module tries to be as efficient as possible: high
speed and low memory foot-print.  You will not be able to sub-class
this class cleanly.
.PP
If you like to change the content of \s-1PO\s0 files, then use
Log::Report::Lexicon::POT.
.PP
Extends \*(L"\s-1DESCRIPTION\*(R"\s0 in Log::Report::Lexicon::Table.
.SH "METHODS"
.IX Header "METHODS"
Extends \*(L"\s-1METHODS\*(R"\s0 in Log::Report::Lexicon::Table.
.SS "Constructors"
.IX Subsection "Constructors"
Extends \*(L"Constructors\*(R" in Log::Report::Lexicon::Table.
.IP "Log::Report::Lexicon::POTcompact\->\fBnew\fR(%options)" 4
.IX Item "Log::Report::Lexicon::POTcompact->new(%options)"
Inherited, see \*(L"Constructors\*(R" in Log::Report::Lexicon::Table
.ie n .IP "Log::Report::Lexicon::POTcompact\->\fBread\fR($filename, %options)" 4
.el .IP "Log::Report::Lexicon::POTcompact\->\fBread\fR($filename, \f(CW%options\fR)" 4
.IX Item "Log::Report::Lexicon::POTcompact->read($filename, %options)"
Read the \s-1POT\s0 table information from \f(CW$filename\fR, as compact as possible.
Comments, plural-form, and such are lost on purpose: they are not
needed for translations.
.Sp
.Vb 2
\& \-Option \-\-Default
\&  charset  undef
.Ve
.RS 4
.IP "charset => \s-1STRING\s0" 2
.IX Item "charset => STRING"
When the charset is not specified, it will be taken from the content-type
field in the po-file header.
.RE
.RS 4
.RE
.SS "Attributes"
.IX Subsection "Attributes"
Extends \*(L"Attributes\*(R" in Log::Report::Lexicon::Table.
.ie n .IP "$obj\->\fBfilename\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBfilename\fR()" 4
.IX Item "$obj->filename()"
Returns the name of the source file for this data.
.ie n .IP "$obj\->\fBoriginalCharset\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBoriginalCharset\fR()" 4
.IX Item "$obj->originalCharset()"
[1.09] Returns the character-set of the strings found in the file.  They will
get translated into utf8 before being used in Perl.
.SS "Managing \s-1PO\s0's"
.IX Subsection "Managing PO's"
Extends \*(L"Managing \s-1PO\s0's\*(R" in Log::Report::Lexicon::Table.
.PP
\fITranslation\fR
.IX Subsection "Translation"
.PP
Extends \*(L"Translation\*(R" in Log::Report::Lexicon::Table.
.ie n .IP "$obj\->\fBmsgid\fR( \s-1STRING,\s0 [$msgctxt] )" 4
.el .IP "\f(CW$obj\fR\->\fBmsgid\fR( \s-1STRING,\s0 [$msgctxt] )" 4
.IX Item "$obj->msgid( STRING, [$msgctxt] )"
Lookup the translations with the \s-1STRING.\s0  Returns a \s-1SCALAR,\s0 when only
one translation is known, and an \s-1ARRAY\s0 wherein there are multiple.
Returns \f(CW\*(C`undef\*(C'\fR when the translation is not defined.
.ie n .IP "$obj\->\fBmsgstr\fR( $msgid, [$count, [$msgctxt] )" 4
.el .IP "\f(CW$obj\fR\->\fBmsgstr\fR( \f(CW$msgid\fR, [$count, [$msgctxt] )" 4
.IX Item "$obj->msgstr( $msgid, [$count, [$msgctxt] )"
Returns the translated string for \f(CW$msgid\fR.  When not specified, \f(CW$count\fR is 1
(the single form).
.PP
\fIAdministration\fR
.IX Subsection "Administration"
.PP
Extends \*(L"Administration\*(R" in Log::Report::Lexicon::Table.
.ie n .IP "$obj\->\fBadd\fR($po)" 4
.el .IP "\f(CW$obj\fR\->\fBadd\fR($po)" 4
.IX Item "$obj->add($po)"
Inherited, see \*(L"Administration\*(R" in Log::Report::Lexicon::Table
.ie n .IP "$obj\->\fBheader\fR($field)" 4
.el .IP "\f(CW$obj\fR\->\fBheader\fR($field)" 4
.IX Item "$obj->header($field)"
Inherited, see \*(L"Administration\*(R" in Log::Report::Lexicon::Table
.ie n .IP "$obj\->\fBnrPlurals\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBnrPlurals\fR()" 4
.IX Item "$obj->nrPlurals()"
Inherited, see \*(L"Administration\*(R" in Log::Report::Lexicon::Table
.ie n .IP "$obj\->\fBpluralIndex\fR($count)" 4
.el .IP "\f(CW$obj\fR\->\fBpluralIndex\fR($count)" 4
.IX Item "$obj->pluralIndex($count)"
Inherited, see \*(L"Administration\*(R" in Log::Report::Lexicon::Table
.ie n .IP "$obj\->\fBsetupPluralAlgorithm\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBsetupPluralAlgorithm\fR()" 4
.IX Item "$obj->setupPluralAlgorithm()"
Inherited, see \*(L"Administration\*(R" in Log::Report::Lexicon::Table
.ie n .IP "$obj\->\fBtranslations\fR( [$active] )" 4
.el .IP "\f(CW$obj\fR\->\fBtranslations\fR( [$active] )" 4
.IX Item "$obj->translations( [$active] )"
Inherited, see \*(L"Administration\*(R" in Log::Report::Lexicon::Table
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
.IP "Error: only acceptable parameter is '\s-1ACTIVE\s0'" 4
.IX Item "Error: only acceptable parameter is 'ACTIVE'"
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of Log-Report-Lexicon distribution version 1.11,
built on March 22, 2018. Website: \fIhttp://perl.overmeer.net/CPAN/\fR
.SH "LICENSE"
.IX Header "LICENSE"
Copyrights 2007\-2018 by [Mark Overmeer <markov@cpan.org>]. 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://dev.perl.org/licenses/\fR