| Current Path : /proc/2/root/usr/local/share/man/man3/ |
| Current File : //proc/2/root/usr/local/share/man/man3/Locale::MakePhrase::BackingStore::Directory.3pm |
.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
.\"
.\" 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" ''
'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.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\" ========================================================================
.\"
.IX Title "Locale::MakePhrase::BackingStore::Directory 3"
.TH Locale::MakePhrase::BackingStore::Directory 3 "2006-03-17" "perl v5.10.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"
Locale::MakePhrase::BackingStore::Directory \- Retrieve translations
from files located in a specified directory.
.SH "DESCRTIPION"
.IX Header "DESCRTIPION"
This backing store is capable of loading language rules, from files
located in the specified directory. All files ending with the
extension \fB.mpt\fR will try to be loaded.
.PP
Files need to be named according to language/dialect. For example:
.PP
.Vb 3
\& en.mpt
\& en_au.mpt
\& cn.mpt
.Ve
.PP
Thus, the filename is used to defined the \fIlanguage\fR component of
the language rule object.
.PP
The files must be formatted as shown in the \fBen.mpt\-example\fR and
\&\fBcn.mpt\-example\fR files (which can be located in the same directories
that these modules are are installed in). The important points to
note are that the file is broken into groups containing:
.IP "\fBkey\fR" 2
.IX Item "key"
.PD 0
.IP "\fBexpression\fR" 2
.IX Item "expression"
.IP "\fBpriority\fR" 2
.IX Item "priority"
.IP "\fBtranslation\fR" 2
.IX Item "translation"
.PD
Where expression & priority are optional. However, if you specify the
priority and/or expression, make sure the translation key is the last
entry in the group \- this is necessary, as we dont know when the
the block is finished.
.SH "API"
.IX Header "API"
The following methods are implemented:
.ie n .SS "$self new([...])"
.el .SS "\f(CW$self\fP new([...])"
.IX Subsection "$self new([...])"
We support loading text/translations (from the translation files) which
may be encoded using any character encoding. Since we need to know
something about the files we are trying to load, we expect this object
to be constructed with the following options:
.ie n .IP """directory""" 2
.el .IP "\f(CWdirectory\fR" 2
.IX Item "directory"
The full path to the directory containing the translation files. eg:
.Sp
.Vb 1
\& /usr/local/myapp/translations
.Ve
.Sp
Default: none; you must specify a directory
.ie n .IP """extension""" 2
.el .IP "\f(CWextension\fR" 2
.IX Item "extension"
You can specify a different file extension to use, rather than using
\&\fB.mpt\fR.
.Sp
Default: use \fB.mpt\fR as the extension
.ie n .IP """encoding""" 2
.el .IP "\f(CWencoding\fR" 2
.IX Item "encoding"
We can load translations from any enocding supported by the Encode
module. Upon load, this module will convert the translations from
the specified encoding, into the interal encoding of \s-1UTF\-8\s0.
.Sp
Default: load \s-1UTF\-8\s0 text translations.
.ie n .IP """reload""" 2
.el .IP "\f(CWreload\fR" 2
.IX Item "reload"
This module will dynamically reload its known translations, if the
files get updated. You can set this option to avoid reloading the
file if it changes.
.Sp
Default: reload language files if changed
.SS "\e@rule_objs get_rules($context,$key,\e@languages)"
.IX Subsection "@rule_objs get_rules($context,$key,@languages)"
Retrieve the translations (that have been previously loaded), using
the selected languages. This implementation will reload the
appropiate language file if it changes (unless it has been told not
to).
.SH "NOTES"
.IX Header "NOTES"
.SS "file extension"
.IX Subsection "file extension"
If you find that the filename extension \fB.mpt\fR is unsuitable, you can
change it by setting the variable:
.PP
\&\f(CW$Locale::MakePhrase::BackingStore::Directory::language_file_extension\fR
.PP
to the extension that you prefer, or simply set it in your constructor.
.SS "line-ending"
.IX Subsection "line-ending"
We automatically handle the Unix/MS\-DOS line-ending difference.
.SS "multi-line"
.IX Subsection "multi-line"
Strings can be spanned over multiple lines, if the end of the line is
backslash-escaped.
Copyright 2K16 - 2K18 Indonesian Hacker Rulez
;?>)