
			  Weblint, Version 1.005

	    Copyright (c) 1994 Neil Bowers.  All rights reserved.
                           Khoral Research, Inc.

    This program is free software; you can redistribute it and/or modify
    it under the terms of the "Artistic License".  You should have received
    a copy of the Artistic License with this distribution, in the file named
    "Artistic".  If not, I'll be glad to provide one.

--------------------------------------------------------------------------

Weblint is a perl script which checks html pages for the World-Wide Web.
Files to be checked are passed on the command-line:

    % weblint *.html

Warnings are generated a la lint -- <filename>(line #): <warning>. E.g.:

    home.html(9): unmatched </H2> (seems to match <H1> on line 8)

The following checks are currently performed:

    *	basic structure
    *	unknown elements and element attributes.
    *	context checks (where a tag must appear within a certain element).
    *	overlapped elements.
    *	expects to see a TITLE in the HEAD element.
    *	do IMG elements have ALT text?
    *	illegally nested elements.
    *	mis-matched tags (e.g., <H1> ... </H2>)
    *	unclosed elements (e.g., <H1> ... )
    *	catches elements which should only appear once
    *	flags obsolete elements.
    *	odd number of quotes in tag.
    *	order of headings.
    *	potentially unclosed tags.
    *	flags markup embedded in comments --- this can confuse some browsers.
    *	whines if you use `here' as anchor text :-)
    *	tags where attributes are expected (e.g. anchors).
    *	existence of local anchor targets.
    *	flag case of tags (not enabled by default).
    *	expect a <LINK REV=MADE HREF=mailto:...> in HEAD element
	(not enabled by default).

All warnings can be enabled or disabled, using a configuration file,
$HOME/.weblintrc.  A sample configuration file, weblintrc, is included
in the distribution.

--------------------------------------------------------------------------

Installation

A simple Makefile is provided, in which you may want to modify BINDIR
and MANDIR, which specify where the weblint script and manpage should
be installed.

Weblint uses the `getopts.pl' and `find.pl' libraries, which are part
of the standard perl library, so this will hopefully not cause any problems.
Please let me know if it does.

The manpage (weblint.1) should be installed in a directory where it
will be picked up by man (e.g., /usr/local/man/man1 on our machines).
A postscript version of the manpage (weblint.ps) is included in this
distribution.

Weblint is available via anonymous ftp from ftp.khoros.unm.edu,
in /pub/perl/www/weblint-1.005.tar.gz, or you can get it from the
weblint home page: http://www.khoros.unm.edu/staff/neilb/weblint.html

--------------------------------------------------------------------------

I hope you find this useful.  Comments, suggestions and bug reports are
welcome, see my email address or home page, given below.  Sample html
helps when tracking down problems.

I maintain an email list, weblint-victims@khoros.unm.edu, which I will
mail announcements to whenever a new version of weblint is released.
Email me if you want to be added to this list.

Neil Bowers
Khoral Research, Inc.
<neilb@khoros.unm.edu>    http://www.khoros.unm.edu/staff/neilb/
