summaryrefslogtreecommitdiffstats
path: root/Doc/lib/xmldompulldom.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2000-12-13 19:34:38 (GMT)
committerFred Drake <fdrake@acm.org>2000-12-13 19:34:38 (GMT)
commit24d6da3eae604cda552267920089b6e10caa52e8 (patch)
tree975b9f08a40723e06b4dea2f5d9c791a440bd887 /Doc/lib/xmldompulldom.tex
parentff87174db1b10f7d630c079481d9ac67f4cb8d5c (diff)
downloadcpython-24d6da3eae604cda552267920089b6e10caa52e8.zip
cpython-24d6da3eae604cda552267920089b6e10caa52e8.tar.gz
cpython-24d6da3eae604cda552267920089b6e10caa52e8.tar.bz2
Added "stub" documentation for xml.dom.pulldom for Paul to fill out with
useful explanations.
Diffstat (limited to 'Doc/lib/xmldompulldom.tex')
-rw-r--r--Doc/lib/xmldompulldom.tex61
1 files changed, 61 insertions, 0 deletions
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}