debian man page for log::report::lexicon::potcompact

Log::Report::Lexicon::POTcompact(3pm)			User Contributed Perl Documentation		     Log::Report::Lexicon::POTcompact(3pm)

NAME
       Log::Report::Lexicon::POTcompact - use translations from a POT file

INHERITANCE
	Log::Report::Lexicon::POTcompact
	  is a Exporter

SYNOPSIS
	# using a PO table efficiently
	my $pot = Log::Report::Lexicon::POTcompact
		    ->read('po/nl.po', charset => 'utf-8')
	   or die;

	my $header = $pot->msgid('');
	print $pot->msgstr('msgid', 3);

DESCRIPTION
       This module is translating, based on PO files. PO files are used to store translations in humanly readable format for most of existing
       translation frameworks, like GNU gettext and Perl's Maketext.

       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.

       If you like to change the content of PO files, then use Log::Report::Lexicon::POT.

METHODS
   Constructors
       Log::Report::Lexicon::POTcompact->read(FILENAME, OPTIONS)
	   Read the POT table information from FILENAME, as compact as possible.  Comments, plural-form, and such are lost on purpose: they are
	   not needed for translations.

	    -Option --Default
	     charset  <required>

	   charset => STRING
	     The character-set which is used for the file.  You must specify this explicitly, while it cannot be trustfully detected
	     automatically.

   Attributes
       $obj->filename
	   Returns the name of the source file for this data.

       $obj->index
	   Returns a HASH of all defined PO objects, organized by msgid.  Please try to avoid using this: use msgid() for lookup.

       $obj->nrPlurals

   Managing PO's
       $obj->header(FIELD)
	   The translation of a blank MSGID is used to store a MIME header, which contains meta-data.  The FIELD content is returned.

       $obj->msgid(STRING)
	   Lookup the translations with the STRING.  Returns a SCALAR, when only one translation is known, and an ARRAY wherein there are
	   multiple.  Returns "undef" when the translation is not defined.

       $obj->msgstr(MSGID, [COUNT])
	   Returns the translated string for MSGID.  When not specified, COUNT is 1 (the single form).

SEE ALSO
       This module is part of Log-Report distribution version 0.94, built on August 23, 2011. Website: http://perl.overmeer.net/log-report/

LICENSE
       Copyrights 2007-2011 by Mark Overmeer. For other contributors see ChangeLog.

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.  See
       http://www.perl.com/perl/misc/Artistic.html

perl v5.14.2							    2011-08-23				     Log::Report::Lexicon::POTcompact(3pm)