- From: Olivier Thereaux via cvs-syncmail <cvsmail@w3.org>
- Date: Fri, 26 Aug 2005 06:36:34 +0000
- To: www-validator-cvs@w3.org
Update of /sources/public/perl/modules/W3C/LogValidator/lib/W3C In directory hutz:/tmp/cvs-serv8202 Modified Files: LogValidator.pm Log Message: refreshed general pod documentation for the main module of logvalidator, adding references to articles Index: LogValidator.pm =================================================================== RCS file: /sources/public/perl/modules/W3C/LogValidator/lib/W3C/LogValidator.pm,v retrieving revision 1.16 retrieving revision 1.17 diff -u -d -r1.16 -r1.17 --- LogValidator.pm 26 Aug 2005 03:58:51 -0000 1.16 +++ LogValidator.pm 26 Aug 2005 06:36:31 -0000 1.17 @@ -396,26 +396,33 @@ Checks quality/validity of most popular content on a Web server +=head1 DESCRIPTION + +C<W3C::LogValidator> is the main module for the W3C Log Validator, a combination of Web Server log analysis and statistics tool and Web Content quality checker. + +The C<W3C::LogValidator> can batch-process a number of documents through a number of quality focus checks, such as HTML or CSS validation, or checking for broken links. It can take a number of different inputs, ranging from a simple list of URIs to log files from various Web servers. And since it orders the result depending on the number of times a document appears in the file or logs, it is, in practice, a useful way to spot the most popular documents that need work. + +the perl script logprocess.pl, bundled in the W3C::LogValidator distribution, is a simple way to use the features of C<W3C::LogValidator>. Developers can also use C<W3C::LogValidator> can be used as a perl module to build applications. + +The homepage for the Log Validator is at: http://www.w3.org/QA/Tools/LogValidator/ + =head1 SYNOPSIS -Generic, basic use of the C<W3C::LogValidator> module. Parse configuration file and process relevant logs. +The simple way to use is to edit the sample configuration file (samples/logprocess.conf) and to run the bundled logprocess.pl script with this configuration file, a la: + + logprocess.pl -f /path/to/logprocess.conf + +The basic task of the C<W3C::LogValidator> module is to parse a configuration file and process relevant logs, passed through a configuration file argument: use W3C::LogValidator; my $logprocessor = W3C::LogValidator->new("sample.conf"); $logprocessor->process; -Alternatively (use default config and process logs) +Alternatively, it will use default a default config and try to process Web server logs in "well known locations": my $logprocessor = W3C::LogValidator->new; $logprocessor->process; - -=head1 DESCRIPTION - -C<W3C::LogValidator> is the main module for the W3C Log Validator, a combination of Web Server log analysis and statistics tool and Web Content quality checker. - -As an easy alternative to using this module, the perl script logprocess.pl is bundled in the W3C::LogValidator distribution. - =head1 API =head2 Constructor @@ -525,8 +532,31 @@ =head1 SEE ALSO -perl(1). -Up-to-date information on this tool at http://www.w3.org/QA/Tools/LogValidator/ +Up-to-date information on the Log Validator at: + + http://www.w3.org/QA/Tools/LogValidator/ + +=head2 Articles and Tutorials + +Several articles have been written within the W3C Quality Assurance Interest Group on the topic of improving the quality of Web sites, notably by using a step-by-step approach and relying upon the Log Validator to help find the areas to fix in priority. + +=over 2 + +=item My Web site is standard! And yours? + +Available at http://www.w3.org/QA/2002/04/Web-Quality + +=item Web Standards Switch + +or I<how to improve your Web site easily>. + +Available in several languages at: http://www.w3.org/QA/2003/03/web-kit + +=item Making your website valid: a step by step guide. + +Available at http://www.w3.org/QA/2002/09/Step-by-step + +=back =cut
Received on Friday, 26 August 2005 06:36:36 UTC