.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
. ds C` ""
. ds C' ""
'br\}
.el\{\
. 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 "HTML::HeadParser 3"
.TH HTML::HeadParser 3 2024-09-02 "perl v5.40.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
HTML::HeadParser \- Parse section of a HTML document
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\& require HTML::HeadParser;
\& $p = HTML::HeadParser\->new;
\& $p\->parse($text) and print "not finished";
\&
\& $p\->header(\*(AqTitle\*(Aq) # to access ....
\& $p\->header(\*(AqContent\-Base\*(Aq) # to access
\& $p\->header(\*(AqFoo\*(Aq) # to access
\& $p\->header(\*(AqX\-Meta\-Author\*(Aq) # to access
\& $p\->header(\*(AqX\-Meta\-Charset\*(Aq) # to access
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \f(CW\*(C`HTML::HeadParser\*(C'\fR is a specialized (and lightweight)
\&\f(CW\*(C`HTML::Parser\*(C'\fR that will only parse the ...
section of an HTML document. The \fBparse()\fR method
will return a FALSE value as soon as some element or body
text are found, and should not be called again after this.
.PP
Note that the \f(CW\*(C`HTML::HeadParser\*(C'\fR might get confused if raw undecoded
UTF\-8 is passed to the \fBparse()\fR method. Make sure the strings are
properly decoded before passing them on.
.PP
The \f(CW\*(C`HTML::HeadParser\*(C'\fR keeps a reference to a header object, and the
parser will update this header object as the various elements of the
section of the HTML document are recognized. The following
header fields are affected:
.IP Content-Base: 4
.IX Item "Content-Base:"
The \fIContent-Base\fR header is initialized from the element.
.IP Title: 4
.IX Item "Title:"
The \fITitle\fR header is initialized from the ...
element.
.IP Isindex: 4
.IX Item "Isindex:"
The \fIIsindex\fR header will be added if there is a
element in the . The header value is initialized from the
\&\fIprompt\fR attribute if it is present. If no \fIprompt\fR attribute is
given it will have '?' as the value.
.IP X\-Meta-Foo: 4
.IX Item "X-Meta-Foo:"
All elements containing a \f(CW\*(C`name\*(C'\fR attribute will result in
headers using the prefix \f(CW\*(C`X\-Meta\-\*(C'\fR appended with the value of the
\&\f(CW\*(C`name\*(C'\fR attribute as the name of the header, and the value of the
\&\f(CW\*(C`content\*(C'\fR attribute as the pushed header value.
.Sp
elements containing a \f(CW\*(C`http\-equiv\*(C'\fR attribute will result
in headers as in above, but without the \f(CW\*(C`X\-Meta\-\*(C'\fR prefix in the
header name.
.Sp
elements containing a \f(CW\*(C`charset\*(C'\fR attribute will result in
an \f(CW\*(C`X\-Meta\-Charset\*(C'\fR header, using the value of the \f(CW\*(C`charset\*(C'\fR
attribute as the pushed header value.
.Sp
The ':' character can't be represented in header field names, so
if the meta element contains this char it's substituted with '\-'
before forming the field name.
.SH METHODS
.IX Header "METHODS"
The following methods (in addition to those provided by the
superclass) are available:
.ie n .IP "$hp = HTML::HeadParser\->new" 4
.el .IP "\f(CW$hp\fR = HTML::HeadParser\->new" 4
.IX Item "$hp = HTML::HeadParser->new"
.PD 0
.ie n .IP "$hp = HTML::HeadParser\->new( $header )" 4
.el .IP "\f(CW$hp\fR = HTML::HeadParser\->new( \f(CW$header\fR )" 4
.IX Item "$hp = HTML::HeadParser->new( $header )"
.PD
The object constructor. The optional \f(CW$header\fR argument should be a
reference to an object that implement the \fBheader()\fR and \fBpush_header()\fR
methods as defined by the \f(CW\*(C`HTTP::Headers\*(C'\fR class. Normally it will be
of some class that is a or delegates to the \f(CW\*(C`HTTP::Headers\*(C'\fR class.
.Sp
If no \f(CW$header\fR is given \f(CW\*(C`HTML::HeadParser\*(C'\fR will create an
\&\f(CW\*(C`HTTP::Headers\*(C'\fR object by itself (initially empty).
.ie n .IP $hp\->header; 4
.el .IP \f(CW$hp\fR\->header; 4
.IX Item "$hp->header;"
Returns a reference to the header object.
.ie n .IP "$hp\->header( $key )" 4
.el .IP "\f(CW$hp\fR\->header( \f(CW$key\fR )" 4
.IX Item "$hp->header( $key )"
Returns a header value. It is just a shorter way to write
\&\f(CW\*(C`$hp\->header\->header($key)\*(C'\fR.
.SH EXAMPLE
.IX Header "EXAMPLE"
.Vb 9
\& $h = HTTP::Headers\->new;
\& $p = HTML::HeadParser\->new($h);
\& $p\->parse(<Stupid example
\&
\& Normal text starts here.
\& EOT
\& undef $p;
\& print $h\->title; # should print "Stupid example"
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
HTML::Parser, HTTP::Headers
.PP
The \f(CW\*(C`HTTP::Headers\*(C'\fR class is distributed as part of the
\&\fIlibwww-perl\fR package. If you don't have that distribution installed
you need to provide the \f(CW$header\fR argument to the \f(CW\*(C`HTML::HeadParser\*(C'\fR
constructor with your own object that implements the documented
protocol.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 1996\-2001 Gisle Aas. All rights reserved.
.PP
This library is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.