.\" 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::Norm::Markup 3"
.TH Locale::Maketext::Utils::Phrase::Norm::Markup 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 "Normalization"
.IX Header "Normalization"
Turn markup related characters into bracket notation.
.SS "Rationale"
.IX Subsection "Rationale"
Allowing markup characters in the phrase is problematic for a number of reasons, including:
.IP "\(bu" 4
Markup only makes sense in one context.
.IP "\(bu" 4
Their presence could unpredictably break markup or other syntax.
.IP "\(bu" 4
Translators are likely to unwittingly change/break markup unless you take extra precautions (e.g. more <ph> handling of text/html ctype in \s-1XLIFF,\s0 yikes!).
.IP "\(bu" 4
Markup could also make the translatable part harder for them to translate.
.IP "\(bu" 4
Allowing markup encourages using your phrase as a template/branding/theming system which is a really terrible idea.
.IP "\(bu" 4
if we don’t use them, even in \fIchr()\fR it is less problem prone since bracket notation allows to do things correctly in each context
.PP
So we detect and modify them.
.SH "IF YOU USE THIS FILTER ALSO USE …"
.IX Header "IF YOU USE THIS FILTER ALSO USE …"
… \s-1THIS FILTER \s0Locale::Maketext::Utils::Phrase::Norm::Ampersand.
.PP
This is not enforced anywhere since we want to assume the coder knows what they are doing.
.SH "possible violations"
.IX Header "possible violations"
.IP "Contains markup related characters" 4
.IX Item "Contains markup related characters"
Turns <>'" into appropriate bracket notation.
.Sp
& is handled in its own driver.
.SH "possible warnings"
.IX Header "possible warnings"
.IP "consider if, instead of using straight double quotes, using “” is the right thing here (i.e. instead of bracket notation)" 4
.IX Item "consider if, instead of using straight double quotes, using “” is the right thing here (i.e. instead of bracket notation)"
This is issued when " is encountered.
.IP "consider if, instead of using a straight apostrophe, using ‘’ for single quoting and ’ for an apostrophe is the right thing here (i.e. instead of bracket notation)" 4
.IX Item "consider if, instead of using a straight apostrophe, using ‘’ for single quoting and ’ for an apostrophe is the right thing here (i.e. instead of bracket notation)"
This is issued when ' is encountered.