.\" Automatically generated by Pod::Man 2.27 (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
.\" ========================================================================
.\"
.IX Title "Locale::Maketext::Utils::Phrase::cPanel 3"
.TH Locale::Maketext::Utils::Phrase::cPanel 3 "2014-11-18" "perl v5.16.3" "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::Maketext::Utils::Phrase::cPanel \- cPanel recipe to Normalize and perform lint\-like analysis of phrases
.SH "VERSION"
.IX Header "VERSION"
This document describes Locale::Maketext::Utils::Phrase::cPanel version 0.1
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Locale::Maketext::Utils::Phrase::cPanel;
\&
\&    my $norm = Locale::Maketext::Utils::Phrase::cPanel\->new_source() || die;
\&
\&    my $result = $norm\->normalize(\*(AqThis office has worked [quant,_1,day,days,zero days] without an “accident”.\*(Aq);
\&
\&    # process $result
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Exactly like Locale::Maketext::Utils::Phrase::Norm except the default filters are what cPanel requires.
.SH "DEFAULT cPanel RECIPE FILTERS"
.IX Header "DEFAULT cPanel RECIPE FILTERS"
Currently the same as the base class’s \*(L"\s-1DEFAULT FILTERS\*(R"\s0 in Locale::Maketext::Utils::Phrase::Norm.
.PP
If that ever changes it will be reflected here.
.SS "Legacy related methods"
.IX Subsection "Legacy related methods"
\fI\fInew_legacy_source()\fI\fR
.IX Subsection "new_legacy_source()"
.PP
Just like base \fInew_source()\fR except it skips the markup filters since legacy values can contain \s-1HTML.\s0
.PP
\fI\fInew_legacy_target()\fI\fR
.IX Subsection "new_legacy_target()"
.PP
Just like base \fInew_target()\fR except it skips the markup filters since legacy values can contain \s-1HTML.\s0
.SH "Internal Object"
.IX Header "Internal Object"
When a filter needs an object (e.g. Compiles) this module uses a Locale::Maketext::Utils::Mock object that knows about cPanel specific bracket notation methods instead of a Cpanel::Locale object for a number of reasons:
.IP "1 Availability" 4
.IX Item "1 Availability"
Things outside of cPanel code (i.e. systems without access to Cpanel::) will have access to the same code that is used on cPanel servers.
.Sp
For example: cplint, build servers, \s-1QA\s0 servers, translators, my laptop, etc
.IP "2 Consistency." 4
.IX Item "2 Consistency."
Every consumer (including /ULC code, cplint, build servers, \s-1QA\s0 servers, translators, my laptop, etc) will get the exact same results.
.IP "3 Sanity check." 4
.IX Item "3 Sanity check."
Adding new bracket notation needs done thoughtfully and completely. Requiring it be discussed/vetted and then added upstream (i.e. here) helps ensure that that happens.
.RS 4
.IP "\(bu" 4
Does it really belong as bracket notation?
.Sp
There is a good chance there is already a way to do what you want or that it belongs elsewhere.
.IP "\(bu" 4
If so, is it cPanel specific or should it be in L::M::U ?
.IP "\(bu" 4
In addition to tests and it’s Javascript counterpart:
.RS 4
.IP "\(bu" 4
It needs documented in the correct places.
.Sp
If its not in L::M::U (i.e. it’s \s-1POD\s0) then it needs added to our internal and/or public documentation.
.IP "\(bu" 4
\&\s-1XLIFF\s0 needs to know about it.
.Sp
That is true whether it is in L::M::U or C::L.
.IP "\(bu" 4
The security team will want to review it and add it to their list.
.Sp
That is true whether it is in L::M::U or C::L.
.RE
.RS 4
.RE
.RE
.RS 4
.Sp
If all of that is satisifed then we add it here and update our \s-1RPM\s0 and we know we have a solid, well thought out, and well executed new bracket notation method.
.Sp
All of those benefits in a process that takes a matter of hours from start to finish. If 24 hours seems too long of a delay compare that to the effort required to undo/deprecate/backcompat a poorly planned/implemented thing!
.RE
.SH "AUTHOR"
.IX Header "AUTHOR"
Daniel Muey  \f(CW\*(C`<http://drmuey.com/cpan_contact.pl>\*(C'\fR
.SH "LICENCE AND COPYRIGHT"
.IX Header "LICENCE AND COPYRIGHT"
Copyright (c) 2012 cPanel, Inc. \f(CW\*(C`<copyright@cpanel.net>>\*(C'\fR. All rights reserved.
.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.10.1 or, at your option,
any later version of Perl 5 you may have available.
.SH "DISCLAIMER OF WARRANTY"
.IX Header "DISCLAIMER OF WARRANTY"
\&\s-1BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE \*(L"AS IS\*(R" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.\s0
.PP
\&\s-1IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE SOFTWARE \s0(\s-1INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE\s0), \s-1EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.\s0