.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 "MKDoc::XML::Decode 3pm"
.TH MKDoc::XML::Decode 3pm "2022-10-13" "perl v5.34.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"
MKDoc::XML::Decode \- Expands XML entities
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use MKDoc::XML::Decode;
\&  my $decode = new MKDoc::XML::Decode qw/xml xhtml numeric/;
\&
\&  # $xml is now "Chris\*(Aq Baloon"
\&  my $xml = MKDoc::XML::Decode\->process ("Chris&apos; Baloon");
.Ve
.SH "SUMMARY"
.IX Header "SUMMARY"
MKDoc::XML::Decode is a very simple module with pluggable entity decoding mechanism.
At the moment there are three modules:
.PP
xml     \- Decodes &apos; &quot; &gt; &lt; and &amp;
xhtml   \- Decodes \s-1XHTML\s0 entities such as &eacute;
numeric \- Decodes numeric entities such as &#65;
.PP
That's it.
.PP
This module and its counterpart MKDoc::XML::Encode are used by MKDoc::XML::Dumper
to XML-encode and XML-decode litterals.
.SH "API"
.IX Header "API"
.ie n .SS "my $decode_object = new MKDoc::XML::Decode (@modules);"
.el .SS "my \f(CW$decode_object\fP = new MKDoc::XML::Decode (@modules);"
.IX Subsection "my $decode_object = new MKDoc::XML::Decode (@modules);"
Constructs a new decode object using the modules specified in \f(CW@modules\fR.
.ie n .SS "my $decoded = $decode_object\->decode ($stuff);"
.el .SS "my \f(CW$decoded\fP = \f(CW$decode_object\fP\->decode ($stuff);"
.IX Subsection "my $decoded = $decode_object->decode ($stuff);"
Decodes \f(CW$stuff\fR and returns it into \f(CW$decoded\fR.
.PP
Any entity which is not recognized will be returned as is but will trigger a warning.
.SH "AUTHOR"
.IX Header "AUTHOR"
Copyright 2003 \- MKDoc Holdings Ltd.
.PP
Author: Jean-Michel Hiver
.PP
This module is free software and is distributed under the same license as Perl
itself. Use it at your own risk.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
MKDoc::XML::Encode