| HTML::Tidy -HTML validation in a Perl object |
new()messages()clear_messages()tidyp_version()libtidyp_version()HTML::Lint
HTML::Tidy - (X)HTML validation in a Perl object
Version 1.56
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.
Message types TIDY_ERROR, TIDY_WARNING and TIDY_INFO.
Everything else is an object method.
new()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 tidyp.
my $tidy = HTML::Tidy->new( {
output_xhtml => 1,
tidy_mark => 0,
} );
See tidyp -help-config for the list of options supported by tidyp.
The following options are not supported by HTML::Tidy:
messages()Returns the messages accumulated.
clear_messages()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.
$tidy->ignore( type => TIDY_WARNING );
$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.
tidyp_version()
libtidyp_version()Returns the version of the underling tidyp library.
HTML::Tidy requires that tidyp be installed on your system.
You can obtain tidyp through your distribution's package manager
(make sure you install the development package with headers), or from
the tidyp Git repository at http://github.com/petdance/tidyp.
HTML::LintHTML::Tidy is different from HTML::Lint in a number of crucial ways.
HTML::Tidy is mostly a happy wrapper around tidyp.
Test:: counterpartTest::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.
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:
Thanks to Jonathan Rockway and Robert Bachmann for contributions.
Andy Lester, <andy at petdance.com>
Copyright (C) 2005-2013 by Andy Lester
This library is free software. You mean modify or distribute it under the Artistic License v2.0.
| HTML::Tidy -HTML validation in a Perl object |