diff options
author | Fred Drake <fdrake@acm.org> | 2006-09-15 15:18:04 (GMT) |
---|---|---|
committer | Fred Drake <fdrake@acm.org> | 2006-09-15 15:18:04 (GMT) |
commit | a58f1236022ed477a103abf127cdf0df0427dec7 (patch) | |
tree | d3b45df690106a047161240f92454a14494b55fd | |
parent | c9ded90368d65018d3c2966e495edd4188e2e7e4 (diff) | |
download | cpython-a58f1236022ed477a103abf127cdf0df0427dec7.zip cpython-a58f1236022ed477a103abf127cdf0df0427dec7.tar.gz cpython-a58f1236022ed477a103abf127cdf0df0427dec7.tar.bz2 |
- fix module name in links in formatted documentation
- minor markup cleanup
(forward-ported from release25-maint revision 51888)
-rw-r--r-- | Doc/lib/libetree.tex | 39 |
1 files changed, 14 insertions, 25 deletions
diff --git a/Doc/lib/libetree.tex b/Doc/lib/libetree.tex index 32f1424..ffa1943 100644 --- a/Doc/lib/libetree.tex +++ b/Doc/lib/libetree.tex @@ -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@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}} |