MAN page from Mandrake Other perl-HTML-Parser-2.20-1.i386.rpm

lib::HTML::HeadParser

Section: User Contributed Perl Documentation (3)
Updated: perl 5.004, patch 04
Index

NAME

HTML::HeadParser - Parse <HEAD> section of a HTML document

SYNOPSIS

 require HTML::HeadParser; $p = HTML::HeadParser->new; $p->parse($text) and  print "not finished";

 $p->header('Title')          # to access <title>....</title> $p->header('Content-Base')   # to access <base href="http://..."> $p->header('Foo')            # to access <meta http-equiv="Foo" content="...">

DESCRIPTION

The HTML::HeadParser is a specialized (and lightweight)HTML::Parser that will only parse the <HEAD>...</HEAD>section of an HTML document. The parse() methodwill return a FALSE value as soon as some <BODY> element or bodytext are found, and should not be called again after this.

The HTML::HeadParser keeps a reference to a header object, and theparser will update this header object as the various elements of the<HEAD> section of the HTML document are recognized. The followingheader fields are affected:

Content-Base:: The Content-Base header is initialized from the <basehref=''..."> element.
Title:: The Title header is initialized from the <title>...</title>element.
Isindex:: The Isindex header will be added if there is a <isindex>element in the <head>. The header value is initialized from theprompt attribute if it is present. If not prompt attribute isgiven it will have `?' as the value.
X-Meta-Foo:: All <meta> elements will initialize headers with the prefix``X-Meta-'' on the name. If the <meta> element contains ahttp-equiv attribute, then it will be honored as the header name.

METHODS

The following methods (in addition to those provided by thesuperclass) are available:

$hp = HTML::HeadParser->new( [$header] ): The object constructor. The optional $header argument should be areference to an object that implement the header() and push_header()methods as defined by the HTTP::Headers class. Normally it will beof some class that isa or delegates to the HTTP::Headers class.
If no $header is given HTML::HeadParser will create anHTTP::Header object by itself (initially empty).
$hp->parse( $text ): Parses some HTML text (see HTML::Parser->parse()) but will returnFALSE as soon as parsing should end.
$hp->header;: Returns a reference to the header object.
$hp->header( $key ): Returns a header value. It is just a shorter way to write$hp->header->header($key).

EXAMPLE

 $h = HTTP::Headers->new; $p = HTML::HeadParser->new($h); $p->parse(<<EOT); <title>Stupid example</title> <base href="http://www.sn.no/libwww-perl/"> Normal text starts here. EOT undef $p; print $h->title;   # should print "Stupid example"

COPYRIGHT

This library is free software; you can redistribute it and/ormodify it under the same terms as Perl itself.

AUTHOR

Gisle Aas <aasAATTsn.no>

This document was created byman2html,using the manual pages.