1 Introduction
2 ------------
3
4 See docs/index.html for the libxml2dom documentation.
5
6 Compatibility Warnings
7 ----------------------
8
9 From libxml2dom 0.4, nodeValue now returns different results in some cases.
10 Previously, it was possible to get the textual contents of an element using
11 the nodeValue property, although this is incompatible with the DOM
12 specifications. Instead, you should now use the textContent property to get
13 such data.
14
15 Contact, Copyright and Licence Information
16 ------------------------------------------
17
18 The current Web page for libxml2dom at the time of release is:
19
20 http://www.boddie.org.uk/python/libxml2dom.html
21
22 Copyright and licence information can be found in the docs directory - see
23 docs/COPYING.txt and docs/LICENCE.txt for more information.
24
25 Dependencies
26 ------------
27
28 libxml2 Tested with libxml2 2.6.17.
29 Use --with-python=<path to python executable> if building from
30 source. Previous releases of libxml2 in the 2.6 series may work,
31 but releases before 2.6.16 are not recommended.
32
33 For Windows users, see also the packages for libxml2, available
34 from the following site:
35
36 http://users.skynet.be/sbi/libxml-python/
37
38 Python Tested with Python 2.4.
39 Python releases from 2.2 onwards should be compatible with
40 libxml2dom. The principal requirement from such releases is the
41 new-style class support which permits the use of properties in
42 the libxml2dom implementation.
43
44 Testing
45 -------
46
47 Some of the tests require libxml2macro.py to be run on the test source code
48 first. Read the docstrings for the various test files before attempting to run
49 any of them. See also docs/NOTES_libxml2macro.txt for more information. Note
50 that such tests are retained for historical purposes and/or curiosity since
51 libxml2macro.py is no longer supported.
52
53 Issues
54 ------
55
56 The presence of xmlns attributes in serialised documents was called into
57 question, and the tests/namespace*.py files attempt to show the current
58 behaviour of libxml2dom.
59
60 Use of importNode seems to cause some kind of memory issue, probably related
61 to nodes being shared across documents. This was observed in libxml2 2.6.0 but
62 appears to be fixed in libxml2 2.6.16.
63
64 Even compared to minidom, importNode may seem very slow (even the
65 libxml2dom.macrolib implementation, too). A way is needed to get libxml2 to do
66 the node copying itself.
67
68 New in libxml2dom 0.4.3 (Changes since libxml2dom 0.4.2)
69 --------------------------------------------------------
70
71 * Added getElementById to the Node class.
72 * Added a __hash__ method to the Node class.
73 * Expanded the svg and events modules, including a test of SVG events.
74
75 New in libxml2dom 0.4.2 (Changes since libxml2dom 0.4.1)
76 --------------------------------------------------------
77
78 * Added missing impl attribute to NamedNodeMap, fixing attribute retrieval.
79 * Added documentElement to Document.
80 * Fixed and expanded the events module.
81 * Added lots of functionality to the svg module.
82
83 New in libxml2dom 0.4.1 (Changes since libxml2dom 0.4)
84 ------------------------------------------------------
85
86 * Fixed the absence of CDATA node creation and importing.
87
88 New in libxml2dom 0.4 (Changes since libxml2dom 0.3.6)
89 ------------------------------------------------------
90
91 * Changed the nodeValue property to return None for various node types, as
92 specified in the DOM specification (Level 3).
93 * Fixed various "not supported" exceptions and added tests which can raise
94 "wrong document" exceptions.
95 * Introduced an Implementation class, permitting specialised node creation.
96 * Added SVG-specific document support.
97 * Made parseURI work for HTML documents.
98 * Fixed getElementsByTagName(NS), as reported by Christian Seiler.
99 * Fixed previousSibling, nextSibling and parentNode crashes using
100 suggestions from Christian Seiler.
101 * Reintroduced node comparisons using suggestions from Christian Seiler.
102 * Fixed the absence of the CDATA node type.
103 * Added the textContent property to nodes.
104 * Added a getDOMImplementation function.
105 * Added an experimental events module.
106 * Added an htmlencoding parameter to the parse functions, as requested by
107 Iliyan Peychev.
108
109 New in libxml2dom 0.3.6 (Changes since libxml2dom 0.3.5)
110 --------------------------------------------------------
111
112 * Added cloneNode almost as a synonym for importNode (which, unlike in the
113 DOM specification, is present on all nodes).
114 * Introduced Debian stable package details - suggested by Robert Siemer.
115 * Changed libxml2mod import details to try libxmlmods - suggested by Lucian
116 Wischik.
117
118 New in libxml2dom 0.3.5 (Changes since libxml2dom 0.3.4)
119 --------------------------------------------------------
120
121 * Fixed nodeType for HTML document elements - reported by Robert Siemer.
122 * Fixed string results from XPath expressions - reported by Robert Siemer.
123
124 New in libxml2dom 0.3.4 (Changes since libxml2dom 0.3.3)
125 --------------------------------------------------------
126
127 * Attempted to introduce generated prefixes for attributes having namespaces
128 but whose names are unprefixed.
129 * Added support for xmlns attribute retrieval (getAttributeNS) and detection
130 (hasAttributeNS).
131 * Added the length attribute to NamedNodeMap; renamed the length method on
132 NodeList, adding a length attribute.
133
134 New in libxml2dom 0.3.3 (Changes since libxml2dom 0.3.2)
135 --------------------------------------------------------
136
137 * Removed redundant weakref usage.
138 * Added explicit copyright and licensing information to source files.
139
140 New in libxml2dom 0.3.2 (Changes since libxml2dom 0.3.1)
141 --------------------------------------------------------
142
143 * Improved the xmlns attribute creation controls.
144
145 New in libxml2dom 0.3.1 (Changes since libxml2dom 0.3)
146 ------------------------------------------------------
147
148 * Fixed empty namespace declarations on elements created with namespaceURI
149 set to None. Previously, such declarations were missing.
150 * Fixed attribute creation and introduced stricter controls over the
151 construction of xmlns attributes.
152
153 New in libxml2dom 0.3 (Changes since libxml2dom 0.2.4)
154 ------------------------------------------------------
155
156 * Imposed much stricter tests on strings used with the libxml2dom API.
157 Strings given as arguments to methods and functions must now only contain
158 ASCII characters; any other character data must be provided as Unicode
159 objects. This change fixes various issues with XPath expressions, and
160 quite probably various other things.
161 * Fixed parentNode on Document objects (which caused xml.dom.ext.PrettyPrint
162 to crash).
163 * Added some support for the doctype attribute and related information.
164 * libxml2dom is now licensed under the LGPL - see docs/COPYING.txt for
165 details.
166
167 New in libxml2dom 0.2.4 (Changes since libxml2dom 0.2.3)
168 --------------------------------------------------------
169
170 * Fixed Unicode conversions in the Node's xpath method.
171
172 New in libxml2dom 0.2.3 (Changes since libxml2dom 0.2.2)
173 --------------------------------------------------------
174
175 * Fixed the parse function's docstring.
176 * Added the owner element to obtained attribute nodes.
177 * Fixed Debian package changelog distribution identifiers.
178
179 New in libxml2dom 0.2.2 (Changes since libxml2dom 0.2.1)
180 --------------------------------------------------------
181
182 * Fixed exception raising in parseURI, adding a docstring to explain the
183 current limitations around HTML parsing.
184
185 New in libxml2dom 0.2.1 (Changes since libxml2dom 0.2)
186 ------------------------------------------------------
187
188 * Moved libxml2macro script to the tools directory.
189 * Added getElementsByTagNameNS.
190 * Added a normalize implementation.
191 * Added HTML parsing support.
192 * Added prettyprinting support.
193 * Fixed parseURI.
194 * Introduced better testing for Unicode objects, especially since things
195 like rdflib like to subclass the unicode type, and it might be more
196 convenient to detect such subclasses and convert their values
197 automatically.
198 * Improved some of the API documentation.
199 * Introduced better suppression of warnings, network access, and other
200 potentially intrusive libxml2 features.
201 * Reorganised the documentation, expanding the README.txt file at the
202 expense of the HTML documentation, but removing older, less relevant
203 information.
204 * Added Debian package support.
205
206 New in libxml2dom 0.2 (Changes since libxml2dom 0.1.3)
207 ------------------------------------------------------
208
209 * Adopted libxml2macro code within the libxml2dom classes, removing any
210 dependencies on the libxml2 module - this makes everything much faster
211 and virtually removes any necessity to use libxml2macro.
212 * Improved attribute and document node handling.
213 * Introduced document reference management.
214 * Introduced NodeList wrapper objects.
215
216 New in libxml2dom 0.1.3 (Changes since libxml2dom 0.1.2)
217 --------------------------------------------------------
218
219 * Fixed createElement.
220 * Introduced experimental libxml2macro tools, tests and libraries.
221
222 New in libxml2dom 0.1.2 (Changes since libxml2dom 0.1.1)
223 --------------------------------------------------------
224
225 * Fixed getAttributeNode and getAttributeNodeNS.
226 * Added comment node creation.
227 * Fixed empty namespace usage with elements and attributes.
228 * Introduced usage of the libxml2 file and memory parsing features.
229 * Introduced suppression of DTD retrieval and validation as the default
230 behaviour.
231 * Added experimental XPath method support.
232
233 New in libxml2dom 0.1.1
234 -----------------------
235
236 * Fixed text node creation.
237 * Fixed setAttributeNS.
238 * Added encoding parameters to convenience methods.
239 * Added the missing previousSibling property.
240 * Added release number to the package.
241
242 Release Procedures
243 ------------------
244
245 Update the libxml2dom/__init__.py and libxml2dom/macrolib/__init__.py
246 __version__ attributes.
247 Change the version number and package filename/directory in the documentation.
248 Change code examples in the documentation if appropriate.
249 Update the release notes (see above).
250 Update the package release notes (in the packages directory).
251 Check the setup.py file and ensure that all package directories are mentioned.
252 Check the release information in the PKG-INFO file.
253 Tag, export.
254 Archive, upload.
255 Make packages (see below).
256 Update PyPI, PythonInfo Wiki, Vaults of Parnassus entries.
257
258 Making Packages
259 ---------------
260
261 To make Debian-based packages:
262
263 1. Create new package directories under packages if necessary.
264 2. Make a symbolic link in the distribution's root directory to keep the
265 Debian tools happy; choose one of the following:
266
267 ln -s packages/ubuntu-hoary/python2.4-libxml2dom/debian/
268 ln -s packages/debian-stable/python2.3-libxml2dom/debian/
269
270 3. Run the package builder:
271
272 dpkg-buildpackage -rfakeroot
273
274 4. Locate and tidy up the packages in the parent directory of the
275 distribution's root directory.