Locale::Maketext::Simple(3p) Perl Programmers Reference Guide

Locale::Maketext::Simple(3p) Perl Programmers Reference Guide #

Locale::Maketext::Simple(3p) Perl Programmers Reference Guide

NNAAMMEE #

 Locale::Maketext::Simple - Simple interface to Locale::Maketext::Lexicon

VVEERRSSIIOONN #

 This document describes version 0.18 of Locale::Maketext::Simple,
 released Septermber 8, 2006.

SSYYNNOOPPSSIISS #

 Minimal setup (looks for _a_u_t_o_/_F_o_o_/_*_._p_o and _a_u_t_o_/_F_o_o_/_*_._m_o):

     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
         Encoding    => 'locale',    # but encode lexicons in current locale
                                     # (needs Locale::Maketext::Lexicon 0.36)
     );
     sub japh {
         print maketext("Just another %1 hacker", "Perl");
     }

DDEESSCCRRIIPPTTIIOONN #

 This module is a simple wrapper around LLooccaallee::::MMaakkeetteexxtt::::LLeexxiiccoonn,
 designed to alleviate the need of creating _L_a_n_g_u_a_g_e _C_l_a_s_s_e_s for module
 authors.

 The language used is chosen from the loc_lang call. If a lookup is not
 possible, the i-default language will be used. If the lookup is not in
 the i-default language, then the key will be returned.

 If LLooccaallee::::MMaakkeetteexxtt::::LLeexxiiccoonn 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.

OOPPTTIIOONNSS #

 All options are passed either via the "use" statement, or via an explicit
 "import".

CCllaassss By default, LLooccaallee::::MMaakkeetteexxtt::::SSiimmppllee draws its source from the calling package’s _a_u_t_o_/ directory; you can override this behaviour by explicitly specifying another package as “Class”.

PPaatthh If your PO and MO files are under a path elsewhere than “auto/”, you may specify it using the “Path” option.

SSttyyllee 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.

 This option is case-insensitive.

EExxppoorrtt 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.

SSuubbccllaassss 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.

DDeeccooddee If set to a true value, source entries will be converted into utf8-strings (available in Perl 5.6.1 or later). This feature needs the EEnnccooddee or EEnnccooddee::::ccoommppaatt module.

EEnnccooddiinngg Specifies an encoding to store lexicon entries, instead of utf8-strings. If set to “locale”, the encoding from the current locale setting is used. Implies a true value for “Decode”.

AACCKKNNOOWWLLEEDDGGMMEENNTTSS #

 Thanks to Jos I. Boumans for suggesting this module to be written.

 Thanks to Chia-Liang Kao for suggesting "Path" and "loc_lang".

SSEEEE AALLSSOO #

 Locale::Maketext, Locale::Maketext::Lexicon

AAUUTTHHOORRSS #

 Audrey Tang <cpan@audreyt.org>

CCOOPPYYRRIIGGHHTT #

 Copyright 2003, 2004, 2005, 2006 by Audrey Tang <cpan@audreyt.org>.

 This software is released under the MIT license cited below.
 Additionally, when this software is distributed with PPeerrll KKiitt,, VVeerrssiioonn 55,
 you may also redistribute it and/or modify it under the same terms as
 Perl itself.

TThhee “"MMIITT"” LLiicceennssee Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included
 in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS #

OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF #

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN #

DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR #

OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE #

USE OR OTHER DEALINGS IN THE SOFTWARE. #

perl v5.36.3 2016-07-25 Locale::Maketext::Simple(3p)