Added documentation for the handle_pi() method, based on SF patch #662464.

Closes SF bug #659188, patch #662464.
This commit is contained in:
Fred Drake 2003-04-17 22:36:52 +00:00
parent 816653fccb
commit 30b6e8230b
1 changed files with 15 additions and 1 deletions

View File

@ -123,8 +123,22 @@ inside the \code{<!}...\code{>} markup.It is intended to be overridden
by a derived class; the base class implementation does nothing.
\end{methoddesc}
\begin{methoddesc}{handle_pi}{data}
Method called when a processing instruction is encountered. The
\var{data} parameter will contain the entire processing instruction.
For example, for the processing instruction \code{<?proc color='red'>},
this method would be called as \code{handle_pi("proc color='red'")}. It
is intended to be overridden by a derived class; the base class
implementation does nothing.
\subsection{Example HTML Parser \label{htmlparser-example}}
\note{The \class{HTMLParser} class uses the SGML syntactic rules for
processing instruction. An XHTML processing instruction using the
trailing \character{?} will cause the \character{?} to be included in
\var{data}.}
\end{methoddesc}
\subsection{Example HTML Parser Application \label{htmlparser-example}}
As a basic example, below is a very basic HTML parser that uses the
\class{HTMLParser} class to print out tags as they are encountered: