Test::HTML::Lint(3pm) User Contributed Perl Documentation Test::HTML::Lint(3pm)NAME
Test::HTML::Lint - Test::More-style wrapper around HTML::Lint
VERSION
Version 2.20
SYNOPSIS
use Test::HTML::Lint tests => 4;
my $table = build_display_table();
html_ok( $table, 'Built display table properly' );
DESCRIPTION
This module provides a few convenience methods for testing exception based code. It is built with Test::Builder and plays happily with
Test::More and friends.
If you are not already familiar with Test::More now would be the time to go take a look.
EXPORT
"html_ok"
html_ok( [$lint, ] $html, $name )
Checks to see that $html contains valid HTML.
Checks to see if $html contains valid HTML. $html being blank is OK. $html being undef is not.
If you pass an HTML::Lint object, "html_ok()" will use that for its settings.
my $lint = new HTML::Lint( only_types => STRUCTURE );
html_ok( $lint, $content, "Web page passes structural tests only" );
Otherwise, it will use the default rules.
html_ok( $content, "Web page passes ALL tests" );
Note that if you pass in your own HTML::Lint object, "html_ok()" will clear its errors before using it.
BUGS
All bugs and requests are now being handled through GitHub.
https://github.com/petdance/html-lint/issues
DO NOT send bug reports to http://rt.cpan.org/ or http://code.google.com/
TO DO
There needs to be a "html_table_ok()" to check that the HTML is a self-contained, well-formed table, and then a comparable one for
"html_page_ok()".
If you think this module should do something that it doesn't do at the moment please let me know.
ACKNOWLEDGEMENTS
Thanks to chromatic and Michael G Schwern for the excellent Test::Builder, without which this module wouldn't be possible.
Thanks to Adrian Howard for writing Test::Exception, from which most of this module is taken.
COPYRIGHT &; LICENSE
Copyright 2005-2012 Andy Lester.
This program is free software; you can redistribute it and/or modify it under the terms of the Artistic License v2.0.
http://www.opensource.org/licenses/Artistic-2.0
Please note that these modules are not products of or supported by the employers of the various contributors to the code.
AUTHOR
Andy Lester, "andy@petdance.com"
perl v5.14.2 2012-04-06 Test::HTML::Lint(3pm)
Check Out this Related Man Page
HTML::Tidy(3pm) User Contributed Perl Documentation HTML::Tidy(3pm)NAME
HTML::Tidy - (X)HTML validation in a Perl object
VERSION
Version 1.50
SYNOPSIS
use HTML::Tidy;
my $tidy = HTML::Tidy->new( {config_file => 'path/to/config'} );
$tidy->ignore( type => TIDY_WARNING, typed => TIDY_INFO );
$tidy->parse( "foo.html", $contents_of_foo );
for my $message ( $tidy->messages ) {
print $message->as_string;
}
DESCRIPTION
"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".
EXPORTS
Message types "TIDY_ERROR", "TIDY_WARNING" and "TIDY_INFO".
Everything else is an object method.
METHODS
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 libtidy.
my $tidy = HTML::Tidy->new( {
output_xhtml => 1,
tidy_mark => 0,
} );
See <http://tidy.sourceforge.net/docs/quickref.html> or "tidy -help-config" for the list of options supported by libtidy.
The following options are not supported by "HTML::Tidy": quiet
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.
ignore( parm => value [, parm => value ] )
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.
o 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 );
o text => qr/regex/
o 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 ] );
parse( $filename, $str [, $str...] )
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.
clean( $str [, $str...] )
Cleans a string, or list of strings, that make up a single HTML file.
Returns the cleaned string as a single string.
INSTALLING LIBTIDY
HTML::Tidy requires that "libtidy" be installed on your system. You can obtain libtidy through your distribution's package manager (make
sure you install the development package with headers), or from the libtidy website at <http://tidy.sourceforge.net/src/tidy_src.tgz>.
CONVERTING FROM ";HTML::Lint"
HTML::Tidy is different from HTML::Lint in a number of crucial ways.
o It's not pure Perl
"HTML::Tidy" is mostly a happy wrapper around libtidy.
o The real work is done by someone else
Changes to libtidy 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.
o It's no longer bundled with its "Test::" counterpart
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.
BUGS &; FEEDBACK
Please report any bugs or feature requests at the issue tracker on github http://github.com/petdance/html-tidy/issues
<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>.
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc HTML::Tidy
You can also look for information at:
o AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/HTML-Tidy <http://annocpan.org/dist/HTML-Tidy>
o CPAN Ratings
http://cpanratings.perl.org/d/HTML-Tidy <http://cpanratings.perl.org/d/HTML-Tidy>
o HTML::Tidy's issue queue at github
http://github.com/petdance/html-tidy/issues <http://github.com/petdance/html-tidy/issues>
o Search CPAN
http://search.cpan.org/dist/HTML-Tidy <http://search.cpan.org/dist/HTML-Tidy>
o Subversion source code repository
http://github.com/petdance/html-tidy <http://github.com/petdance/html-tidy>
ACKNOWLEDGEMENTS
Thanks to Jonathan Rockway and Robert Bachmann for contributions.
AUTHOR
Andy Lester, "<andy at petdance.com>"
COPYRIGHT &; LICENSE
Copyright (C) 2005-2010 by Andy Lester
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.1 or,
at your option, any later version of Perl 5 you may have available.
perl v5.14.2 2011-11-15 HTML::Tidy(3pm)