From 24d6da3eae604cda552267920089b6e10caa52e8 Mon Sep 17 00:00:00 2001 From: Fred Drake Date: Wed, 13 Dec 2000 19:34:38 +0000 Subject: Added "stub" documentation for xml.dom.pulldom for Paul to fill out with useful explanations. --- Doc/Makefile.deps | 1 + Doc/lib/lib.tex | 1 + Doc/lib/xmldompulldom.tex | 61 +++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 63 insertions(+) create mode 100644 Doc/lib/xmldompulldom.tex diff --git a/Doc/Makefile.deps b/Doc/Makefile.deps index 6a2378c..d3931ae 100644 --- a/Doc/Makefile.deps +++ b/Doc/Makefile.deps @@ -172,6 +172,7 @@ LIBFILES= $(MANSTYLES) $(COMMONTEX) \ ../lib/libpyexpat.tex \ ../lib/xmldom.tex \ ../lib/xmldomminidom.tex \ + ../lib/xmldompulldom.tex \ ../lib/xmlsax.tex \ ../lib/xmlsaxhandler.tex \ ../lib/xmlsaxutils.tex \ diff --git a/Doc/lib/lib.tex b/Doc/lib/lib.tex index ea6c71b..c42683b 100644 --- a/Doc/lib/lib.tex +++ b/Doc/lib/lib.tex @@ -236,6 +236,7 @@ and how to embed it in other applications. \input{libpyexpat} \input{xmldom} \input{xmldomminidom} +\input{xmldompulldom} \input{xmlsax} \input{xmlsaxhandler} \input{xmlsaxutils} diff --git a/Doc/lib/xmldompulldom.tex b/Doc/lib/xmldompulldom.tex new file mode 100644 index 0000000..a88bfc4 --- /dev/null +++ b/Doc/lib/xmldompulldom.tex @@ -0,0 +1,61 @@ +\section{\module{xml.dom.pulldom} --- + Support for building partial DOM trees} + +\declaremodule{standard}{xml.dom.pulldom} +\modulesynopsis{Support for building partial DOM trees from SAX events.} +\moduleauthor{Paul Prescod}{paul@prescod.net} + +\versionadded{2.0} + +\module{xml.dom.pulldom} allows building only selected portions of a +Document Object Model representation of a document from SAX events. + + +\begin{classdesc}{PullDOM}{\optional{documentFactory}} + \class{xml.sax.handler.ContentHandler} implementation that ... +\end{classdesc} + + +\begin{classdesc}{DOMEventStream}{stream, parser, bufsize} + ... +\end{classdesc} + + +\begin{classdesc}{SAX2DOM}{\optional{documentFactory}} + \class{xml.sax.handler.ContentHandler} implementation that ... +\end{classdesc} + + +\begin{funcdesc}{parse}{stream_or_string\optional{, + parser\optional{, bufsize}}} + ... +\end{funcdesc} + + +\begin{funcdesc}{parseString}{string\optional{, parser}} + ... +\end{funcdesc} + + +\begin{datadesc}{default_bufsize} + Default value for the \var{busize} parameter to \function{parse()}. + \versionchanged[The value of this variable can be changed before + calling \function{parse()} and the new value will + take effect]{2.1} +\end{datadesc} + + +\subsection{DOMEventStream Objects \label{domeventstream-objects}} + + +\begin{methoddesc}[DOMEventStream]{getEvent}{} + ... +\end{methoddesc} + +\begin{methoddesc}[DOMEventStream]{expandNode}{node} + ... +\end{methoddesc} + +\begin{methoddesc}[DOMEventStream]{reset}{} + ... +\end{methoddesc} -- cgit v0.12