.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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 >0, 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
.\" ========================================================================
.\"
.IX Title "Locale::TextDomain::OO::JavaScript 3"
.TH Locale::TextDomain::OO::JavaScript 3 "2015-02-07" "perl v5.28.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::TextDomain::OO::JavaScript \- How to use the JavaScript part
.PP
$Id: JavaScript.pm 573 2015\-02\-07 20:59:51Z steffenw $
.PP
$HeadURL: svn+ssh://steffenw@svn.code.sf.net/p/perl\-gettext\-oo/code/module/trunk/lib/Locale/TextDomain/OO/JavaScript.pm $
.SH "VERSION"
.IX Header "VERSION"
1.017
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides a high-level interface to JavaScript message translation.
.PP
Creating the Lexicon and the selection of the language are server (Perl) based.
The script gets the lexicon in a global variable
named localeTextDomainOOLexicon.
.PP
Inside of the constructor is a language attribute,
that shoud be filled from server.
.PP
It is possible to filter the lexicon.
For bigger lexicon files filter also by language to split the lexicon.
Load only the lexicon of the current language.
.SS "How to extract?"
.IX Subsection "How to extract?"
Use module Locale::TextDomain::OO::Extract.
This is a base class for all source scanner to create pot files.
Use this base class and give this module the rules
or use one of the already exteded classes.
Locale::TextDomain::OO::Extract::JavaScript::JS
is a extension for Javacript from *.js files and so on.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
Inside of this distribution is a directory named javascript.
Copy this files into your project.
Do the same with javascript files of
Locale::TextDomain::OO::Util::Constants,
Locale::TextDomain::OO::Util::JoinSplitLexiconKeys
and Locale::Utils::PlaceholderNamed.
.PP
This scripts depending on <http://jquery.com/>.
.PP
Watch also the javascript/Example.html how to use.
.PP
.Vb 5
\&    <!\-\- depends on \-\->
\&    <script type="text/javascript" src=".../jquery\-...js"></script>
\&    <script type="text/javascript" src=".../Locale/TextDomain/OO/Util/Constants.js"></script>
\&    <script type="text/javascript" src=".../Locale/TextDomain/OO/Util/JoinSplitLexiconKeys.js"></script>
\&    <script type="text/javascript" src=".../Locale/Utils/PlaceholderNamed.js"></script>
\&
\&    <!\-\- stores the lexicon into var localeTextDomainOOLexicon \-\->
\&    <script type="text/javascript" src=".../localeTextDomainOOLexicon.js"></script>
\&
\&    <!\-\- depends on var localeTextDomainOOLexicon \-\->
\&    <script type="text/javascript" src=".../Locale/TextDomain/OO.js"></script>
\&    <script type="text/javascript" src=".../Locale/TextDomain/OO/Plugin/Expand/Gettext/Loc.js"></script>
\&    <script type="text/javascript" src=".../Locale/TextDomain/OO/Plugin/Expand/Gettext/Loc/DomainAndCategory.js"></script>
\&
\&    <!\-\- initialize \-\->
\&    <script type="text/javascript">
\&        var ltdoo = new localeTextDomainOO({
\&            plugins  : [ \*(AqlocaleTextDomainOOExpandGettextLocDomainAndCategory\*(Aq ],
\&            language : \*(Aq@{[ $language_tag ]}\*(Aq, // from Perl
\&            category : \*(AqLC_MESSAGES\*(Aq, // optional category
\&            domain   : \*(AqMyDomain\*(Aq, // optional domain
\&                filter   : function(translation) { // optional filter
\&                // modifies the translation late
\&                return translation;
\&            },
\&            logger   : function (message, argMap) { // optional logger
\&                console.log(message);
\&                return;
\&            }
\&        });
\&    </script>
.Ve
.PP
This configuration would be use Lexicon \*(L"$language_tag:LC_MESSAGES:MyDomain\*(R".
That lexicon should be filled with data.
.PP
.Vb 11
\&    <!\-\- translations \-\->
\&    <script type="text/javascript">
\&        // extractable, translate
\&        str = ltdoo.loc_(\*(Aqmsgid\*(Aq);
\&        str = ltdoo.loc_x(\*(Aqmsgid\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&        str = ltdoo.loc_p(\*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq);
\&        str = ltdoo.loc_px(\*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&        str = ltdoo.loc_n(\*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count);
\&        str = ltdoo.loc_nx(\*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, {key1 : \*(Aqvalue1\*(Aq});
\&        str = ltdoo.loc_np(\*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count);
\&        str = ltdoo.loc_npx(\*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, {key1 : \*(Aqvalue1\*(Aq});
\&
\&        // extractable, prepare
\&        arr = ltdoo.Nloc_(\*(Aqmsgid\*(Aq);
\&        arr = ltdoo.Nloc_x(\*(Aqmsgid\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&        arr = ltdoo.Nloc_p(\*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq);
\&        arr = ltdoo.Nloc_px(\*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&        arr = ltdoo.Nloc_n(\*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count);
\&        arr = ltdoo.Nloc_nx(\*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, {key1 : \*(Aqvalue1\*(Aq});
\&        arr = ltdoo.Nloc_np(\*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count);
\&        arr = ltdoo.Nloc_npx(\*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, {key1 : \*(Aqvalue1\*(Aq});
\&
\&        // with domain
\&
\&        // extractable, translate
\&        str = ltdoo.loc_d(\*(Aqdomain\*(Aq, \*(Aqmsgid\*(Aq);
\&        str = ltdoo.loc_dx(\*(Aqdomain\*(Aq, \*(Aqmsgid\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&        str = ltdoo.loc_dp(\*(Aqdomain\*(Aq, \*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq);
\&        str = ltdoo.loc_dpx(\*(Aqdomain\*(Aq, \*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&        str = ltdoo.loc_dn(\*(Aqdomain\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count);
\&        str = ltdoo.loc_dnx(\*(Aqdomain\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, {key1 : \*(Aqvalue1\*(Aq});
\&        str = ltdoo.loc_dnp(\*(Aqdomain\*(Aq, \*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count);
\&        str = ltdoo.loc_dnpx(\*(Aqdomain\*(Aq, \*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, {key1 : \*(Aqvalue1\*(Aq});
\&
\&        // extractable, prepare
\&        arr = ltdoo.Nloc_d(\*(Aqdomain\*(Aq, \*(Aqmsgid\*(Aq);
\&        arr = ltdoo.Nloc_dx(\*(Aqdomain\*(Aq, \*(Aqmsgid\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&        arr = ltdoo.Nloc_dp(\*(Aqdomain\*(Aq, \*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq);
\&        arr = ltdoo.Nloc_dpx(\*(Aqdomain\*(Aq, \*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&        arr = ltdoo.Nloc_dn(\*(Aqdomain\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count);
\&        arr = ltdoo.Nloc_dnx(\*(Aqdomain\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, {key1 : \*(Aqvalue1\*(Aq});
\&        arr = ltdoo.Nloc_dnp(\*(Aqdomain\*(Aq, \*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count);
\&        arr = ltdoo.Nloc_dnpx(\*(Aqdomain\*(Aq, \*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, {key1 : \*(Aqvalue1\*(Aq});
\&
\&        // with category
\&
\&        // extractable, translate
\&        str = ltdoo.loc_c(\*(Aqmsgid\*(Aq, \*(Aqcategory\*(Aq);
\&        str = ltdoo.loc_cx(\*(Aqmsgid\*(Aq, \*(Aqcategory\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&        str = ltdoo.loc_cp(\*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqcategory\*(Aq);
\&        str = ltdoo.loc_cpx(\*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqcategory\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&        str = ltdoo.loc_cn(\*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, \*(Aqcategory\*(Aq);
\&        str = ltdoo.loc_cnx(\*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, \*(Aqcategory\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&        str = ltdoo.loc_cnp(\*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, \*(Aqcategory\*(Aq);
\&        str = ltdoo.loc_cnpx(\*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, \*(Aqcategory\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&
\&        // extractable, prepare
\&        arr = ltdoo.Nloc_c(\*(Aqmsgid\*(Aq, \*(Aqcategory\*(Aq);
\&        arr = ltdoo.Nloc_cx(\*(Aqmsgid\*(Aq, \*(Aqcategory\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&        arr = ltdoo.Nloc_cp(\*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqcategory\*(Aq);
\&        arr = ltdoo.Nloc_cpx(\*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqcategory\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&        arr = ltdoo.Nloc_cn(\*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, \*(Aqcategory\*(Aq);
\&        arr = ltdoo.Nloc_cnx(\*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, \*(Aqcategory\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&        arr = ltdoo.Nloc_cnp(\*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, \*(Aqcategory\*(Aq);
\&        arr = ltdoo.Nloc_cnpx(\*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, \*(Aqcategory\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&
\&        // with domain and category
\&
\&        // extractable, translate
\&        str = ltdoo.loc_dc(\*(Aqdomain\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqcategory\*(Aq);
\&        str = ltdoo.loc_dcx(\*(Aqdomain\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqcategory\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&        str = ltdoo.loc_dcp(\*(Aqdomain\*(Aq, \*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqcategory\*(Aq);
\&        str = ltdoo.loc_dcpx(\*(Aqdomain\*(Aq, \*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqcategory\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&        str = ltdoo.loc_dcn(\*(Aqdomain\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, \*(Aqcategory\*(Aq);
\&        str = ltdoo.loc_dcnx(\*(Aqdomain\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, \*(Aqcategory\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&        str = ltdoo.loc_dcnp(\*(Aqdomain\*(Aq, \*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, \*(Aqcategory\*(Aq);
\&        str = ltdoo.loc_dcnpx(\*(Aqdomain\*(Aq, \*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, \*(Aqcategory\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&
\&        // extractable, prepare
\&        arr = ltdoo.Nloc_dc(\*(Aqdomain\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqcategory\*(Aq);
\&        arr = ltdoo.Nloc_dcx(\*(Aqdomain\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqcategory\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&        arr = ltdoo.Nloc_dcp(\*(Aqdomain\*(Aq, \*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqcategory\*(Aq);
\&        arr = ltdoo.Nloc_dcpx(\*(Aqdomain\*(Aq, \*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqcategory\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&        arr = ltdoo.Nloc_dcn(\*(Aqdomain\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, \*(Aqcategory\*(Aq);
\&        arr = ltdoo.Nloc_dcnx(\*(Aqdomain\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, \*(Aqcategory\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&        arr = ltdoo.Nloc_dcnp(\*(Aqdomain\*(Aq, \*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, \*(Aqcategory\*(Aq);
\&        arr = ltdoo.Nloc_dcnpx(\*(Aqdomain\*(Aq, \*(Aqmsgctxt\*(Aq, \*(Aqmsgid\*(Aq, \*(Aqmsgid_plural\*(Aq, count, \*(Aqcategory\*(Aq, {key1 : \*(Aqvalue1\*(Aq});
\&    </script>
.Ve
.SH "SUBROUTINES/METHODS"
.IX Header "SUBROUTINES/METHODS"
see \s-1SYNOPSIS\s0
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
none
.SH "CONFIGURATION AND ENVIRONMENT"
.IX Header "CONFIGURATION AND ENVIRONMENT"
none
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
<http://jquery.com/>
.PP
Locale::TextDomain::OO::Util::Constants
.PP
Locale::TextDomain::OO::Util::JoinSplitLexiconKeys
.PP
Locale::Utils::PlaceholderNamed
.SH "INCOMPATIBILITIES"
.IX Header "INCOMPATIBILITIES"
not known
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
not known
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Locale::TextDoamin::OO
.SH "AUTHOR"
.IX Header "AUTHOR"
Steffen Winkler
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright (c) 2014 \- 2015,
Steffen Winkler
\&\f(CW\*(C`<steffenw at cpan.org>\*(C'\fR.
All rights reserved.
.PP
This module is free software;
you can redistribute it and/or modify it
under the same terms as Perl itself.