Locale::Maketext::Simple - Simple interface to Locale::Maketext::Lexicon
This document describes version 0.11 of Locale::Maketext::Simple, released February 6, 2004.
Minimal setup (looks for auto/Foo/*.po and auto/Foo/*.mo):
package Foo; use Locale::Maketext::Simple; # exports 'loc' loc_lang('fr'); # set language to French sub hello { print loc("Hello, [_1]!", "World"); }
More sophisticated example:
package Foo::Bar; use Locale::Maketext::Simple ( Class => 'Foo', # search in auto/Foo/ Style => 'gettext', # %1 instead of [_1] Export => 'maketext', # maketext() instead of loc() Subclass => 'L10N', # Foo::L10N instead of Foo::I18N Decode => 1, # decode entries to unicode-strings ); sub japh { print maketext("Just another %1 hacker", "Perl"); }
This module is a simple wrapper around Locale::Maketext::Lexicon, designed to alleviate the need of creating Language Classes for module authors.
If Locale::Maketext::Lexicon is not present, it implements a minimal localization function by simply interpolating [_1] with the first argument, [_2] with the second, etc. Interpolated function like [quant,_1] are treated as [_1], with the sole exception of [tense,_1,X], which will append ing to _1 when X is present, or appending ed to <_1> otherwise.
[_1]
[_2]
[quant,_1]
[tense,_1,X]
ing
_1
present
ed
All options are passed either via the use statement, or via an explicit import.
use
import
By default, Locale::Maketext::Simple draws its source from the calling package's auto/ directory; you can override this behaviour by explicitly specifying another package as Class.
Class
If your PO and MO files are under a path elsewhere than auto/, you may specify it using the Path option.
auto/
Path
By default, this module uses the maketext style of [_1] and [quant,_1] for interpolation. Alternatively, you can specify the gettext style, which uses %1 and %quant(%1) for interpolation.
maketext
gettext
%1
%quant(%1)
This option is case-insensitive.
By default, this module exports a single function, loc, into its caller's namespace. You can set it to another name, or set it to an empty string to disable exporting.
loc
By default, this module creates an ::I18N subclass under the caller's package (or the package specified by Class), and stores lexicon data in its subclasses. You can assign a name other than I18N via this option.
::I18N
I18N
Thanks to Jos I. Boumans for suggesting this module to be written.
Thanks to Chia-Liang Kao for suggesting Path and loc_lang.
loc_lang
Locale::Maketext, Locale::Maketext::Lexicon
Autrijus Tang <autrijus@autrijus.org>
Copyright 2003, 2004 by Autrijus Tang <autrijus@autrijus.org>.
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
To install CPANPLUS, copy and paste the appropriate command in to your terminal.
cpanm
cpanm CPANPLUS
CPAN shell
perl -MCPAN -e shell install CPANPLUS
For more information on module installation, please visit the detailed CPAN module installation guide.