Added more information on the differences between the htmllib and HTMLParser

freddrake · freddrake · commit 25211f572408 · 2001-07-05T16:34:36.000Z
modules.
diff --git a/Doc/lib/libhtmllib.tex b/Doc/lib/libhtmllib.tex
@@ -70,6 +70,12 @@ \section{\module{htmllib} ---
 
 
 \begin{seealso}
+  \seemodule{HTMLParser}{Alternate HTML parser that offers a slightly
+                         lower-level view of the input, but is
+                         designed to work with XHTML, and does not
+                         implement some of the SGML syntax not used in
+                         ``HTML as deployed'' and which isn't legal
+                         for XHTML.}
   \seemodule{htmlentitydefs}{Definition of replacement text for HTML
                              2.0 entities.}
   \seemodule{sgmllib}{Base class for \class{HTMLParser}.}
diff --git a/Doc/lib/libhtmlparser.tex b/Doc/lib/libhtmlparser.tex
@@ -6,7 +6,9 @@ \section{\module{HTMLParser} ---
 
 This module defines a class \class{HTMLParser} which serves as the
 basis for parsing text files formatted in HTML\index{HTML} (HyperText
-Mark-up Language) and XHTML.\index{XHTML}
+Mark-up Language) and XHTML.\index{XHTML}  Unlike the parser in
+\refmodule{htmllib}, this parser is not based on the SGML parser in
+\refmodule{sgmllib}.
 
 
 \begin{classdesc}{HTMLParser}{}
@@ -15,6 +17,10 @@ \section{\module{HTMLParser} ---
 An HTMLParser instance is fed HTML data and calls handler functions
 when tags begin and end.  The \class{HTMLParser} class is meant to be
 overridden by the user to provide a desired behavior.
+
+Unlike the parser in \refmodule{htmllib}, this parser does not check
+that end tags match start tags or call the end-tag handler for
+elements which are closed implicitly by closing an outer element.
 \end{classdesc}
 
 
diff --git a/Doc/lib/libsgmllib.tex b/Doc/lib/libsgmllib.tex
@@ -10,8 +10,9 @@ \section{\module{sgmllib} ---
 basis for parsing text files formatted in SGML (Standard Generalized
 Mark-up Language).  In fact, it does not provide a full SGML parser
 --- it only parses SGML insofar as it is used by HTML, and the module
-only exists as a base for the \refmodule{htmllib}\refstmodindex{htmllib}
-module.
+only exists as a base for the \refmodule{htmllib} module.  Another
+HTML parser which supports XHTML and offers a somewhat different
+interface is available in the \refmodule{HTMLParser} module.
 
 
 \begin{classdesc}{SGMLParser}{}
