]> granicus.if.org Git - python/commitdiff
Added "stub" documentation for xml.dom.pulldom for Paul to fill out with
authorFred Drake <fdrake@acm.org>
Wed, 13 Dec 2000 19:34:38 +0000 (19:34 +0000)
committerFred Drake <fdrake@acm.org>
Wed, 13 Dec 2000 19:34:38 +0000 (19:34 +0000)
useful explanations.

Doc/Makefile.deps
Doc/lib/lib.tex
Doc/lib/xmldompulldom.tex [new file with mode: 0644]

index 6a2378cb630bb9b2bf73590edc1b4523bdd0ddff..d3931ae2570eb83c7dd8cdeaf8ea91d5f3e9fea1 100644 (file)
@@ -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 \
index ea6c71b0fdbe7d40f9c7e41bcebf22f7dbd0b45e..c42683b91b5ade363cb7c752c5f983618056c547 100644 (file)
@@ -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 (file)
index 0000000..a88bfc4
--- /dev/null
@@ -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}