.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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 "Badger::Codec::HTML 3pm"
.TH Badger::Codec::HTML 3pm "2023-08-28" "perl v5.36.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"
Badger::Codec::HTML \- encode and decode reserved characters in HTML
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Badger::Codec::HTML;
\&    
\&    # class methods
\&    my $enc = Badger::Codec::HTML\->encode("http://foo.com/bar.html");
\&    my $dec = $codec\->decode($enc);
\&    
\&    # object methods
\&    my $codec = Badger::Codec::HTML\->new();
\&    my $enc   = $codec\->encode("http://foo.com/bar.html");
\&    my $dec   = $codec\->decode($enc);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module implements a subclass of Badger::Codec for encoding and
decoding \s-1HTML.\s0  It is based on code extracted from Lincoln Stein's
\&\s-1CGI\s0.pm module.
.PP
The \fBencode()\fR method encodes \s-1HTML\s0 by converting any reserved characters
to the correct \s-1HTML\s0 entities.
.PP
The \fBdecode()\fR method reverses this process.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "encode($html, $charset)"
.el .SS "encode($html, \f(CW$charset\fP)"
.IX Subsection "encode($html, $charset)"
Encodes the \s-1HTML\s0 text passed as the first argument.
.PP
.Vb 1
\&    $encoded = Badger::Codec::HTML\->encode($html);
.Ve
.PP
The optional second argument can be used to indicate the character set
in use.  If this is set to \f(CW\*(C`ISO\-8859\-1\*(C'\fR \f(CW\*(C`WINDOWS\-1252\*(C'\fR then the
encoded data will undergo some additional processing in order to work
around some known bugs in Microsoft's web browsers.  See \fBfix_windows()\fR.
.SS "decode($html)"
.IX Subsection "decode($html)"
Decodes the encoded \s-1HTML\s0 text passed as the first argument.
.PP
.Vb 1
\&    $html = Badger::Codec::HTML\->decode($encoded);
.Ve
.SS "fix_windows($text)"
.IX Subsection "fix_windows($text)"
This method is used internally to repair the damage caused by bugs in 
certain inferior browsers.
.SH "AUTHOR"
.IX Header "AUTHOR"
Andy Wardley <http://wardley.org/>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2005\-2009 Andy Wardley. All rights reserved.
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
This code is derived from Lincoln D. Stein's \s-1CGI\s0 module.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Badger::Codec