[Python-checkins] CVS: python/dist/src/Doc/lib xmldom.tex,1.16,1.17 xmldomminidom.tex,1.4,1.5

[Fred L. Drake]

Update of /cvsroot/python/python/dist/src/Doc/lib
In directory usw-pr-cvs1:/tmp/cvs-serv22864/lib

Modified Files:
	xmldom.tex xmldomminidom.tex 
Log Message:
Fix up a number of small problems with the DOM documentation.
There's still a lot to do, but it's better now.


Index: xmldom.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/xmldom.tex,v
retrieving revision 1.16
retrieving revision 1.17
diff -C2 -d -r1.16 -r1.17
*** xmldom.tex	2001/10/25 20:42:57	1.16
--- xmldom.tex	2001/10/26 20:09:49	1.17
***************
*** 115,120 ****
  % Should the Node documentation go here?
  
! In addition, \module{xml.dom} contains the \class{Node}, and the DOM
! exceptions.
  
  \subsection{Objects in the DOM \label{dom-objects}}
--- 115,127 ----
  % Should the Node documentation go here?
  
! In addition, \module{xml.dom} contains a base \class{Node} class and
! the DOM exception classes.  The \class{Node} class provided by this
! module does not implement any of the methods or attributes defined by
! the DOM specification; concrete DOM implementations must provide
! those.  The \class{Node} class provided as part of this module does
! provide the constants used for the \member{nodeType} attribute on
! concrete \class{Node} objects; they are located within the class
! rather than at the module level to conform with the DOM
! specifications.
  
  \subsection{Objects in the DOM \label{dom-objects}}
***************
*** 359,363 ****
  the information) is available from a \class{DocumentType} object.  The
  \class{DocumentType} for a document is available from the
! \class{Document} object's \member{doctype} attribute.
  
  \class{DocumentType} is a specialization of \class{Node}, and adds the
--- 366,373 ----
  the information) is available from a \class{DocumentType} object.  The
  \class{DocumentType} for a document is available from the
! \class{Document} object's \member{doctype} attribute; if there is no
! \code{DOCTYPE} declaration for the document, the document's
! \member{doctype} attribute will be set to \code{None} instead of an
! instance of this interface.
  
  \class{DocumentType} is a specialization of \class{Node}, and adds the
***************
*** 382,387 ****
  \begin{memberdesc}[DocumentType]{name}
    The name of the root element as given in the \code{DOCTYPE}
!   declaration, if present.  If the was no \code{DOCTYPE} declaration,
!   this will be \code{None}.
  \end{memberdesc}
  
--- 392,396 ----
  \begin{memberdesc}[DocumentType]{name}
    The name of the root element as given in the \code{DOCTYPE}
!   declaration, if present.
  \end{memberdesc}
  
***************
*** 590,594 ****
  There are also experimental methods that give this class more mapping
  behavior.  You can use them or you can use the standardized
! \method{getAttribute*()}-family methods on the \class{Element} objects.
  
  
--- 599,604 ----
  There are also experimental methods that give this class more mapping
  behavior.  You can use them or you can use the standardized
! \method{getAttribute*()} family of methods on the \class{Element}
! objects.
  
  

Index: xmldomminidom.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/xmldomminidom.tex,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** xmldomminidom.tex	2001/09/02 06:07:36	1.4
--- xmldomminidom.tex	2001/10/26 20:09:49	1.5
***************
*** 181,186 ****
  \item The type \code{DOMString} maps to Python strings.
        \refmodule{xml.dom.minidom} supports either byte or Unicode
!       strings, but will normally produce Unicode strings.  Attributes
!       of type \code{DOMString} may also be \code{None}.
  
  \item \keyword{const} declarations map to variables in their
--- 181,188 ----
  \item The type \code{DOMString} maps to Python strings.
        \refmodule{xml.dom.minidom} supports either byte or Unicode
!       strings, but will normally produce Unicode strings.  Values
!       of type \code{DOMString} may also be \code{None} where allowed
!       to have the IDL \code{null} value by the DOM specification from
!       the W3C.
  
  \item \keyword{const} declarations map to variables in their
***************
*** 194,200 ****
        as \exception{TypeError} and \exception{AttributeError}.
  
! \item \class{NodeList} objects are implemented as Python's built-in
!       list type, so don't support the official API, but are much more
!       ``Pythonic.''
  \end{itemize}
  
--- 196,205 ----
        as \exception{TypeError} and \exception{AttributeError}.
  
! \item \class{NodeList} objects are implemented using Python's built-in
!       list type.  Starting with Python 2.2, these objects provide the
!       interface defined in the DOM specification, but with earlier
!       versions of Python they do not support the official API.  They
!       are, however, much more ``Pythonic'' than the interface defined
!       in the W3C recommendations.
  \end{itemize}
  
***************
*** 204,224 ****
  
  \begin{itemize}
! \item DOMTimeStamp
  
! \item DocumentType (added in Python 2.1)
  
! \item DOMImplementation (added in Python 2.1)
  
! \item CharacterData
  
! \item CDATASection
  
! \item Notation
  
! \item Entity
  
! \item EntityReference
  
! \item DocumentFragment
  \end{itemize}
  
--- 209,229 ----
  
  \begin{itemize}
! \item \class{DOMTimeStamp}
  
! \item \class{DocumentType} (added in Python 2.1)
  
! \item \class{DOMImplementation} (added in Python 2.1)
  
! \item \class{CharacterData}
  
! \item \class{CDATASection}
  
! \item \class{Notation}
  
! \item \class{Entity}
  
! \item \class{EntityReference}
  
! \item \class{DocumentFragment}
  \end{itemize}