HTML::Tidy - HTML validation in a Perl object
Version 5.00_01
use HTML::Tidy; my $tidy = HTML::Tidy->new( {config_file => 'path/to/config'} ); $tidy->ignore( type => TIDY_WARNING, type => TIDY_INFO ); $tidy->parse( "foo.html", $contents_of_foo ); for my $message ( $tidy->messages ) { print $message->as_string; }
HTML::Tidy is an HTML checker in a handy dandy object. It's meant as a replacement for HTML::Lint. If you're currently an HTML::Lint user looking to migrate, see the section "Converting from HTML::Lint".
HTML::Tidy
Message types TIDY_ERROR, TIDY_WARNING and TIDY_INFO.
TIDY_ERROR
TIDY_WARNING
TIDY_INFO
Everything else is an object method.
Create an HTML::Tidy object.
my $tidy = HTML::Tidy->new();
Optionally you can give a hashref of configuration parms.
my $tidy = HTML::Tidy->new( {config_file => 'path/to/tidy.cfg'} );
This configuration file will be read and used when you clean or parse an HTML file.
You can also pass options directly to tidy.
my $tidy = HTML::Tidy->new( { output_xhtml => 1, tidy_mark => 0, } );
See tidy -help-config for the list of options supported by tidy.
tidy -help-config
The following options are not supported by HTML::Tidy:
quiet
Returns the messages accumulated.
Clears the list of messages, in case you want to print and clear, print and clear. If you don't clear the messages, then each time you call parse() you'll be accumulating more in the list.
Specify types of messages to ignore. Note that the ignore flags must be set before calling parse(). You can call ignore() as many times as necessary to set up all your restrictions; the options will stack up.
parse()
ignore()
type => TIDY_INFO|TIDY_WARNING|TIDY_ERROR
Specifies the type of messages you want to ignore, either info or warnings or errors. If you wanted, you could call ignore on all three and get no messages at all.
$tidy->ignore( type => TIDY_WARNING );
text => qr/regex/
text => [ qr/regex1/, qr/regex2/, ... ]
Checks the text of the message against the specified regex or regexes, and ignores the message if there's a match. The value for the text parm may be either a regex, or a reference to a list of regexes.
$tidy->ignore( text => qr/DOCTYPE/ ); $tidy->ignore( text => [ qr/unsupported/, qr/proprietary/i ] );
Parses a string, or list of strings, that make up a single HTML file.
The $filename parm is only used as an identifier for your use. The file is not actually read and opened.
Returns true if all went OK, or false if there was some problem calling tidy, or parsing tidy's output.
Cleans a string, or list of strings, that make up a single HTML file.
Returns the cleaned string as a single string.
Returns the version of the underling tidy library.
HTML::Tidy requires that the html-tidy be installed on your system. You can probably obtain html-tidy through your distribution's package manager (make sure you install the development package with headers). You can also check the html-tidy home page is http://www.html-tidy.org/.
html-tidy
HTML::Lint
HTML::Tidy is different from HTML::Lint in a number of crucial ways.
It's not pure Perl
HTML::Tidy is mostly a happy wrapper around the html-tidy library.
The real work is done by someone else
Changes to tidy may come down the pipe that I don't have control over. That's the price we pay for having it do a darn good job.
It's no longer bundled with its Test:: counterpart
Test::
HTML::Lint came bundled with Test::HTML::Lint, but Test::HTML::Tidy is a separate distribution. This saves the people who don't want the Test:: framework from pulling it in, and all its prerequisite modules.
Test::HTML::Lint
Please report any bugs or feature requests at the issue tracker on github http://github.com/petdance/html-tidy/issues. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
Please do NOT use http://rt.cpan.org.
You can find documentation for this module with the perldoc command.
perldoc HTML::Tidy
You can also look for information at:
HTML::Tidy's issue queue at github
http://github.com/petdance/html-tidy/issues
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/HTML-Tidy
CPAN Ratings
http://cpanratings.perl.org/d/HTML-Tidy
search.cpan.org
http://search.cpan.org/dist/HTML-Tidy
Git source code repository
http://github.com/petdance/html-tidy
Thanks to Rufus Cable, Jonathan Rockway, and Robert Bachmann for contributions.
Andy Lester, <andy at petdance.com>
<andy at petdance.com>
Copyright (C) 2005-2018 by Andy Lester
This library is free software. You may modify or distribute it under the Artistic License v2.0.
To install HTML::Tidy, copy and paste the appropriate command in to your terminal.
cpanm
cpanm HTML::Tidy
CPAN shell
perl -MCPAN -e shell install HTML::Tidy
For more information on module installation, please visit the detailed CPAN module installation guide.