.\" Automatically generated by Pod::Man 2.28 (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 "Xacobeo::I18n 3pm"
.TH Xacobeo::I18n 3pm "2014-08-16" "perl v5.20.0" "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"
Xacobeo::I18n \- Utilities for internationalization (i18n).
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&        # Initialize the i18n framework (done once)
\&        use FindBin;
\&        use Xacobeo::I18n;
\&        Xacobeo::I18n\->init("$FindBin::Bin/../share/locale/");
\&        
\&        
\&        # Import the i18n utilities (used everywhere where i18n is needed)
\&        use Xacobeo::I18n;
\&        print _\|_("Hello world"), "\en";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This package provides utilities that perform i18n. This module relies on
gettext.
.PP
The initialization of the i18n framework should be performed only once,
preferably as soon as possible. Once the framework is initialized any module
requiring to translate a string can include this module.
.PP
This module exports automatically the shortcut functions used for translating
messages. This is done in order to make the translation transparent.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
The following functions are available:
.SS "_\|_"
.IX Subsection "__"
Translates a single string through gettext.
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$string\fR
.Sp
The string to translate.
.SS "_\|_x"
.IX Subsection "__x"
Translates a string that uses place holders for variable substitution.
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$string\fR
.Sp
The string to translate.
.IP "\(bu" 4
\&\f(CW%values\fR
.Sp
A series of key/value pairs that will be replacing the place holders.
.SS "_\|_n"
.IX Subsection "__n"
Translates a string in either singular or plural.
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$singular\fR
.Sp
The string in its singular form (one item).
.IP "\(bu" 4
\&\f(CW$plural\fR
.Sp
The string in its plural form (more than one item).
.IP "\(bu" 4
\&\f(CW$count\fR
.Sp
The number of items.
.IP "\(bu" 4
\&\f(CW%values\fR
.Sp
A series of key/value pairs that will be replacing the place holders.
.SS "_\|_nx"
.IX Subsection "__nx"
Translates a string in either singular or plural with variable substitution.
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$singular\fR
.Sp
The string in its singular form (one item).
.IP "\(bu" 4
\&\f(CW$plural\fR
.Sp
The string in its plural form (more than one item).
.IP "\(bu" 4
\&\f(CW$count\fR
.Sp
The number of items.
.SS "_\|_xn"
.IX Subsection "__xn"
Same as \*(L"_\|_nx\*(R".
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$singular\fR
.Sp
The string in its singular form (one item).
.IP "\(bu" 4
\&\f(CW$plural\fR
.Sp
The string in its plural form (more than one item).
.IP "\(bu" 4
\&\f(CW$count\fR
.Sp
The number of items.
.SS "domain"
.IX Subsection "domain"
Returns the translation domain.
.SS "init"
.IX Subsection "init"
Initializes the i18n framework (gettext). Must be called in the fashion:
.PP
.Vb 1
\&        Xacobeo::I18n\->init($folder);
.Ve
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$folder\fR
.Sp
The folder where to find the translation files. For instance for the translation
\&\fI/usr/share/locale/fr/LC_MESSAGES/xacobeo.mo\fR the folder \fI/usr/share/locale\fR
has to be provided.
.SH "AUTHORS"
.IX Header "AUTHORS"
Emmanuel Rodriguez <potyl@cpan.org>.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2008,2009 by Emmanuel Rodriguez.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.8 or,
at your option, any later version of Perl 5 you may have available.