[Python-checkins] r51889 - python/trunk/Doc/lib/libetree.tex

[fred.drake]

Author: fred.drake
Date: Fri Sep 15 17:18:04 2006
New Revision: 51889

Modified:
   python/trunk/Doc/lib/libetree.tex
Log:
- fix module name in links in formatted documentation
- minor markup cleanup
(forward-ported from release25-maint revision 51888)


Modified: python/trunk/Doc/lib/libetree.tex
==============================================================================
--- python/trunk/Doc/lib/libetree.tex	(original)
+++ python/trunk/Doc/lib/libetree.tex	Fri Sep 15 17:18:04 2006
@@ -1,45 +1,34 @@
-\section{\module{elementtree} --- The xml.etree.ElementTree Module}
-\declaremodule{standard}{xml.etree.elementtree}
+\section{\module{xml.etree.ElementTree} --- The ElementTree XML API}
+\declaremodule{standard}{xml.etree.ElementTree}
 \moduleauthor{Fredrik Lundh}{fredrik at pythonware.com}
-\modulesynopsis{This module provides implementations
-of the Element and ElementTree types, plus support classes.
+\modulesynopsis{Implementation of the ElementTree API.}
 
-A C version of this API is available as xml.etree.cElementTree.}
 \versionadded{2.5}
 
-
-\subsection{Overview\label{elementtree-overview}}
-
 The Element type is a flexible container object, designed to store
 hierarchical data structures in memory. The type can be described as a
 cross between a list and a dictionary.
 
 Each element has a number of properties associated with it:
-\begin{itemize}
-\item {} 
-a tag which is a string identifying what kind of data
-this element represents (the element type, in other words).
-
-\item {} 
-a number of attributes, stored in a Python dictionary.
-
-\item {} 
-a text string.
-
-\item {} 
-an optional tail string.
-
-\item {} 
-a number of child elements, stored in a Python sequence
 
+\begin{itemize}
+  \item a tag which is a string identifying what kind of data
+        this element represents (the element type, in other words).
+  \item a number of attributes, stored in a Python dictionary.
+  \item a text string.
+  \item an optional tail string.
+  \item a number of child elements, stored in a Python sequence
 \end{itemize}
 
 To create an element instance, use the Element or SubElement factory
 functions.
 
-The ElementTree class can be used to wrap an element
+The \class{ElementTree} class can be used to wrap an element
 structure, and convert it from and to XML.
 
+A C implementation of this API is available as
+\module{xml.etree.cElementTree}.
+
 
 \subsection{Functions\label{elementtree-functions}}