summaryrefslogtreecommitdiffstats
path: root/Doc/libhtmllib.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1998-03-27 05:27:08 (GMT)
committerFred Drake <fdrake@acm.org>1998-03-27 05:27:08 (GMT)
commit8fe533e6a092f8f8aa8d7b81dd8f38c5057e9682 (patch)
tree3371e13f1ada67e3d7451e38fddcadbe7c098283 /Doc/libhtmllib.tex
parentec56109a0af6d3f705feffc50fc59abab1c0ccea (diff)
downloadcpython-8fe533e6a092f8f8aa8d7b81dd8f38c5057e9682.zip
cpython-8fe533e6a092f8f8aa8d7b81dd8f38c5057e9682.tar.gz
cpython-8fe533e6a092f8f8aa8d7b81dd8f38c5057e9682.tar.bz2
Use the new {methoddesc} and {memberdesc} environments as appropriate.
Diffstat (limited to 'Doc/libhtmllib.tex')
-rw-r--r--Doc/libhtmllib.tex31
1 files changed, 14 insertions, 17 deletions
diff --git a/Doc/libhtmllib.tex b/Doc/libhtmllib.tex
index dff837c..7737845 100644
--- a/Doc/libhtmllib.tex
+++ b/Doc/libhtmllib.tex
@@ -70,53 +70,50 @@ handlers for all HTML 2.0 and many HTML 3.0 and 3.2 elements.
In addition to tag methods, the \class{HTMLParser} class provides some
additional methods and instance variables for use within tag methods.
-\setindexsubitem{(HTMLParser attribute)}
-
-\begin{datadesc}{formatter}
+\begin{memberdesc}{formatter}
This is the formatter instance associated with the parser.
-\end{datadesc}
+\end{memberdesc}
-\begin{datadesc}{nofill}
+\begin{memberdesc}{nofill}
Boolean flag which should be true when whitespace should not be
collapsed, or false when it should be. In general, this should only
be true when character data is to be treated as ``preformatted'' text,
as within a \code{<PRE>} element. The default value is false. This
affects the operation of \method{handle_data()} and \method{save_end()}.
-\end{datadesc}
+\end{memberdesc}
-\setindexsubitem{(HTMLParser method)}
-\begin{funcdesc}{anchor_bgn}{href, name, type}
+\begin{methoddesc}{anchor_bgn}{href, name, type}
This method is called at the start of an anchor region. The arguments
correspond to the attributes of the \code{<A>} tag with the same
names. The default implementation maintains a list of hyperlinks
(defined by the \code{href} attribute) within the document. The list
of hyperlinks is available as the data attribute \code{anchorlist}.
-\end{funcdesc}
+\end{methoddesc}
-\begin{funcdesc}{anchor_end}{}
+\begin{methoddesc}{anchor_end}{}
This method is called at the end of an anchor region. The default
implementation adds a textual footnote marker using an index into the
list of hyperlinks created by \method{anchor_bgn()}.
-\end{funcdesc}
+\end{methoddesc}
-\begin{funcdesc}{handle_image}{source, alt\optional{, ismap\optional{, align\optional{, width\optional{, height}}}}}
+\begin{methoddesc}{handle_image}{source, alt\optional{, ismap\optional{, align\optional{, width\optional{, height}}}}}
This method is called to handle images. The default implementation
simply passes the \var{alt} value to the \method{handle_data()}
method.
-\end{funcdesc}
+\end{methoddesc}
-\begin{funcdesc}{save_bgn}{}
+\begin{methoddesc}{save_bgn}{}
Begins saving character data in a buffer instead of sending it to the
formatter object. Retrieve the stored data via \method{save_end()}.
Use of the \method{save_bgn()} / \method{save_end()} pair may not be
nested.
-\end{funcdesc}
+\end{methoddesc}
-\begin{funcdesc}{save_end}{}
+\begin{methoddesc}{save_end}{}
Ends buffering character data and returns all data saved since the
preceeding call to \method{save_bgn()}. If the \code{nofill} flag is
false, whitespace is collapsed to single spaces. A call to this
method without a preceeding call to \method{save_bgn()} will raise a
\exception{TypeError} exception.
-\end{funcdesc}
+\end{methoddesc}