Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Contact Us
Online Help
Domain Status
Man Pages

Virtual Servers

Topology Map

Server Agreement
Year 2038

USA Flag



Man Pages

Manual Reference Pages  -  HTML::TREE (3)

.ds Aq ’


HTML::Tree - build and scan parse-trees of HTML



This document describes version 5.03 of HTML::Tree, released September 22, 2012 as part of HTML-Tree.


    use HTML::TreeBuilder;
    my $tree = HTML::TreeBuilder->new();

        # Then do something with the tree, using HTML::Element
        # methods -- for example:


        # Finally:



HTML-Tree is a suite of Perl modules for making parse trees out of HTML source. It consists of mainly two modules, whose documentation you should refer to: HTML::TreeBuilder and HTML::Element.

HTML::TreeBuilder is the module that builds the parse trees. (It uses HTML::Parser to do the work of breaking the HTML up into tokens.)

The tree that TreeBuilder builds for you is made up of objects of the class HTML::Element.

If you find that you do not properly understand the documentation for HTML::TreeBuilder and HTML::Element, it may be because you are unfamiliar with tree-shaped data structures, or with object-oriented modules in general. Sean Burke has written some articles for The Perl Journal ( that seek to provide that background. The full text of those articles is contained in this distribution, as:
HTML::Tree::AboutObjects User’s View of Object-Oriented Modules from TPJ17.
HTML::Tree::AboutTrees Trees from TPJ18
HTML::Tree::Scanning Scanning HTML from TPJ19
Readers already familiar with object-oriented modules and tree-shaped data structures should read just the last article. Readers without that background should read the first, then the second, and then the third.


All these methods simply redirect to the corresponding method in HTML::TreeBuilder. It’s more efficient to use HTML::TreeBuilder directly, and skip loading HTML::Tree at all.


Redirects to new in HTML::TreeBuilder.


Redirects to new_from_file in HTML::TreeBuilder.


Redirects to new_from_content in HTML::TreeBuilder.


Redirects to new_from_url in HTML::TreeBuilder.


You can find documentation for this module with the perldoc command.

    perldoc HTML::Tree

    You can also look for information at:

o AnnoCPAN: Annotated CPAN documentation


o CPAN Ratings


o RT: CPAN’s request tracker


o Search CPAN


o Stack Overflow


If you have a question about how to use HTML-Tree, Stack Overflow is the place to ask it. Make sure you tag it both perl and html-tree.


HTML::TreeBuilder, HTML::Element, HTML::Tagset, HTML::Parser, HTML::DOMbo

The book Perl & LWP by Sean M. Burke published by O’Reilly and Associates, 2002. ISBN: 0-596-00178-9

It has several chapters to do with HTML processing in general, and HTML-Tree specifically. There’s more info at:


HTML-Tree is now maintained using Git. The main public repository is <>.

The best way to send a patch is to make a pull request there.


Thanks to Gisle Aas, Sean Burke and Andy Lester for their original work.

Thanks to Chicago Perl Mongers ( for their patches submitted to HTML::Tree as part of the Phalanx project (

Thanks to the following people for additional patches and documentation: Terrence Brannon, Gordon Lack, Chris Madsen and Ricardo Signes.


Current maintainers:
o Christopher J. Madsen <perl AT>
o Jeff Fearn <jfearn AT>
Original HTML-Tree author:
o Gisle Aas
Former maintainers:
o Sean M. Burke
o Andy Lester
o Pete Krawczyk <petek AT>
You can follow or contribute to HTML-Tree’s development at <>.


Copyright 1995-1998 Gisle Aas, 1999-2004 Sean M. Burke, 2005 Andy Lester, 2006 Pete Krawczyk, 2010 Jeff Fearn, 2012 Christopher J. Madsen. (Except the articles contained in HTML::Tree::AboutObjects, HTML::Tree::AboutTrees, and HTML::Tree::Scanning, which are all copyright 2000 The Perl Journal.)

Except for those three TPJ articles, the whole HTML-Tree distribution, of which this file is a part, is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

Those three TPJ articles may be distributed under the same terms as Perl itself.

The programs in this library are distributed in the hope that they will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.

Search for    or go to Top of page |  Section 3 |  Main Index

perl v5.20.3 HTML::TREE (3) 2016-04-03

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.