HTML::Tidy::Message(3pm) User Contributed Perl Documentation HTML::Tidy::Message(3pm)NAME
HTML::Tidy::Message - Message object for the Tidy functionality
SYNOPSIS
See HTML::Tidy for all the gory details.
EXPORTS
None. It's all object-based.
METHODS
Almost everything is an accessor.
new( $file, $line, $column, $text )
Create an object. It's not very exciting.
where()
Returns a formatted string that describes where in the file the error has occurred.
For example,
(14:23)
for line 14, column 23.
The terrible thing about this function is that it's both a plain ol' formatting function as in
my $str = where( 14, 23 );
AND it's an object method, as in:
my $str = $error->where();
I don't know what I was thinking when I set it up this way, but it's bad practice.
as_string()
Returns a nicely-formatted string for printing out to stdout or some similar user thing.
file()
Returns the filename of the error, as set by the caller.
type()
Returns the type of the error. This will either be "TIDY_ERROR", or "TIDY_WARNING".
line()
Returns the line number of the error, or 0 if there isn't an applicable line number.
column()
Returns the column number, or 0 if there isn't an applicable column number.
text()
Returns the text of the message. This does not include a type string, like "Info: ".
LICENSE
This code may be distributed under the same terms as Perl itself.
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 2010-02-16 HTML::Tidy::Message(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)