home *** CD-ROM | disk | FTP | other *** search
/ Netscape Plug-Ins Developer's Kit / Netscape_Plug-Ins_Developers_Kit.iso / UTILS / WEBLINT / WEBLINT.ZIP / weblint / README < prev    next >
Encoding:
Text File  |  1996-02-13  |  4.2 KB  |  111 lines
  1.  
  2.               Weblint, Version 1.014
  3.  
  4.     Copyright (c) 1994, 1995, 1996 Neil Bowers.  All rights reserved.
  5.                            Khoral Research, Inc.
  6.  
  7.     This program is free software; you can redistribute it and/or modify
  8.     it under the terms of the "Artistic License".  You should have received
  9.     a copy of the Artistic License with this distribution, in the file named
  10.     "Artistic".  If not, I'll be glad to provide one.
  11.  
  12. --------------------------------------------------------------------------
  13.  
  14. Weblint is a syntax and minimal style checker for HTML: a perl script which
  15. picks fluff off html pages, much in the same way traditional lint picks fluff
  16. off C programs.  Files to be checked are passed on the command-line:
  17.  
  18.     % weblint *.html
  19.  
  20. Warnings are generated a la lint -- <filename>(line #): <warning>. E.g.:
  21.  
  22.     home.html(9): malformed heading - open tag is <H1>, but closing is </H2>
  23.  
  24. The following checks are currently performed:
  25.  
  26.     *    basic structure
  27.     *    unknown elements and element attributes.
  28.     *    context checks (where a tag must appear within a certain element).
  29.     *    overlapped elements.
  30.     *    expects to see a TITLE in the HEAD element.
  31.     *    do IMG elements have ALT text?
  32.     *    illegally nested elements.
  33.     *    mis-matched tags (e.g., <H1> ... </H2>)
  34.     *    unclosed elements (e.g., <H1> ... )
  35.     *    catches elements which should only appear once
  36.     *    flags obsolete elements.
  37.     *    odd number of quotes in tag.
  38.     *    order of headings.
  39.     *    potentially unclosed tags.
  40.     *    flags markup embedded in comments --- this can confuse some browsers.
  41.     *    whines if you use `here' as anchor text :-)
  42.     *    tags where attributes are expected (e.g. anchors).
  43.     *    existence of local anchor targets.
  44.     *    flag case of tags (not enabled by default).
  45.     *    expect a <LINK REV=MADE HREF=mailto:...> in HEAD element
  46.     (not enabled by default).
  47.     *    supports HTML 3 elements, such as TABLE, MATH, FIG and the rest.
  48.     *    leading and trailing whitespace in certain container elements (eg A).
  49.     *    optional support for the java APPLET and PARAM elements.
  50.  
  51. All warnings can be enabled or disabled, using a configuration file,
  52. $HOME/.weblintrc.  A sample configuration file, weblintrc, is included
  53. in the distribution.
  54.  
  55. --------------------------------------------------------------------------
  56.  
  57. Installation
  58.  
  59. NOTE:    Certain versions of perl have bugs which are triggered by weblint.
  60.     You shouldn't experience problems if you have 4.036, or 5.001m.
  61.  
  62. A simple Makefile is provided, in which you may want to modify BINDIR
  63. and MANDIR, which specify where the weblint script and manpage should
  64. be installed.
  65.  
  66. Weblint uses the `newgetopt.pl' and `find.pl' libraries, which are part
  67. of the standard perl library, so this will hopefully not cause any problems.
  68. Please let me know if it does.
  69.  
  70. The manpage (weblint.1) should be installed in a directory where it
  71. will be picked up by man (e.g., /usr/local/man/man1 on our machines).
  72. A postscript version of the manpage (weblint.ps) is available at:
  73.     http://ftp.khoral.com/pub/weblint/weblint.ps
  74.  
  75. Weblint is available via anonymous ftp, either as a gzip'd tar file,
  76. or zip'd archive:
  77.     ftp://ftp.khoral.com/pub/weblint/weblint-1.014.tar.gz
  78.     ftp://ftp.khoral.com/pub/weblint/weblint.zip
  79. or you can get it from the weblint home page:
  80.     http://www.khoral.com/staff/neilb/weblint.html
  81.  
  82. The weblint distribution includes a simple regression testsuite.
  83. Run the testsuite with either of the following commands:
  84.  
  85.     % make test
  86.     % ./test.pl
  87.  
  88. If any of the tests fail, please mail the logfile (weblint-test.log) to me.
  89.  
  90. --------------------------------------------------------------------------
  91.  
  92. I hope you find this useful.  Comments, suggestions and bug reports are
  93. welcome, see my email address or home page, given below.  Sample html
  94. helps when tracking down problems.
  95.  
  96. I maintain two email lists:
  97.  
  98.     weblint-announce@khoral.com
  99.         Announcements for new versions of weblint.
  100.  
  101.     weblint-victims@khoral.com
  102.         Discussion related to weblint (such as what features
  103.         should be added), as well as announcements for new
  104.         versions of weblint, and pre-release testing.
  105.  
  106. Email me if you want to be added to either list.
  107.  
  108. Neil Bowers
  109. Khoral Research, Inc.
  110. <neilb@khoral.com>    http://www.khoral.com/staff/neilb/
  111.