summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2003-04-17 22:37:50 (GMT)
committerFred Drake <fdrake@acm.org>2003-04-17 22:37:50 (GMT)
commit55ed68004a3a0177c500c266494f4f2fad94b5bc (patch)
treedf1985b47d6cfc468659ae31893d688c5ceb676b
parentb4d53fda5b508713e2e4c90d6900325453fbc2c2 (diff)
downloadcpython-55ed68004a3a0177c500c266494f4f2fad94b5bc.zip
cpython-55ed68004a3a0177c500c266494f4f2fad94b5bc.tar.gz
cpython-55ed68004a3a0177c500c266494f4f2fad94b5bc.tar.bz2
Added documentation for the handle_pi() method, based on SF patch #662464.
Closes SF bug #659188, patch #662464.
-rw-r--r--Doc/lib/libhtmlparser.tex16
1 files changed, 15 insertions, 1 deletions
diff --git a/Doc/lib/libhtmlparser.tex b/Doc/lib/libhtmlparser.tex
index 68c93e0..f7bbf63 100644
--- a/Doc/lib/libhtmlparser.tex
+++ b/Doc/lib/libhtmlparser.tex
@@ -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.
+
+\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 \label{htmlparser-example}}
+\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: