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, docs/lgpl-3.0.txt and docs/gpl-3.0.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.5 (Changes since libxml2dom 0.4.4)
69 --------------------------------------------------------
70
71 * Fixed operations involving the standard XML_NAMESPACE value, particularly
72 setAttributeNS.
73 * Introduced deletion of conflicting attributes in setAttributeNS.
74 * Added slightly nicer errors for parsing and serialising.
75
76 New in libxml2dom 0.4.4 (Changes since libxml2dom 0.4.3)
77 --------------------------------------------------------
78
79 * Relicensed under the LGPL version 3 or later (fixing PKG-INFO file).
80 * Improved XMPP support for messages, presence and events.
81 * Added Ubuntu Feisty (7.04) package support.
82
83 New in libxml2dom 0.4.3 (Changes since libxml2dom 0.4.2)
84 --------------------------------------------------------
85
86 * Enforced well-formedness in parse operations unless otherwise requested.
87 * Fixed access to null doctype properties.
88 * Added getElementById, firstChild and lastChild to the Node class.
89 * Added a __hash__ method to the Node class.
90 * Moved document checking into the Node class.
91 * Added an iterator for the NamedNodeMap class.
92 * Expanded the svg and events modules, including a test of SVG events.
93 * Split the debian-stable packages into debian-sarge and debian-etch.
94
95 New in libxml2dom 0.4.2 (Changes since libxml2dom 0.4.1)
96 --------------------------------------------------------
97
98 * Added missing impl attribute to NamedNodeMap, fixing attribute retrieval.
99 * Added documentElement to Document.
100 * Fixed and expanded the events module.
101 * Added lots of functionality to the svg module.
102
103 New in libxml2dom 0.4.1 (Changes since libxml2dom 0.4)
104 ------------------------------------------------------
105
106 * Fixed the absence of CDATA node creation and importing.
107
108 New in libxml2dom 0.4 (Changes since libxml2dom 0.3.6)
109 ------------------------------------------------------
110
111 * Changed the nodeValue property to return None for various node types, as
112 specified in the DOM specification (Level 3).
113 * Fixed various "not supported" exceptions and added tests which can raise
114 "wrong document" exceptions.
115 * Introduced an Implementation class, permitting specialised node creation.
116 * Added SVG-specific document support.
117 * Made parseURI work for HTML documents.
118 * Fixed getElementsByTagName(NS), as reported by Christian Seiler.
119 * Fixed previousSibling, nextSibling and parentNode crashes using
120 suggestions from Christian Seiler.
121 * Reintroduced node comparisons using suggestions from Christian Seiler.
122 * Fixed the absence of the CDATA node type.
123 * Added the textContent property to nodes.
124 * Added a getDOMImplementation function.
125 * Added an experimental events module.
126 * Added an htmlencoding parameter to the parse functions, as requested by
127 Iliyan Peychev.
128
129 New in libxml2dom 0.3.6 (Changes since libxml2dom 0.3.5)
130 --------------------------------------------------------
131
132 * Added cloneNode almost as a synonym for importNode (which, unlike in the
133 DOM specification, is present on all nodes).
134 * Introduced Debian stable package details - suggested by Robert Siemer.
135 * Changed libxml2mod import details to try libxmlmods - suggested by Lucian
136 Wischik.
137
138 New in libxml2dom 0.3.5 (Changes since libxml2dom 0.3.4)
139 --------------------------------------------------------
140
141 * Fixed nodeType for HTML document elements - reported by Robert Siemer.
142 * Fixed string results from XPath expressions - reported by Robert Siemer.
143
144 New in libxml2dom 0.3.4 (Changes since libxml2dom 0.3.3)
145 --------------------------------------------------------
146
147 * Attempted to introduce generated prefixes for attributes having namespaces
148 but whose names are unprefixed.
149 * Added support for xmlns attribute retrieval (getAttributeNS) and detection
150 (hasAttributeNS).
151 * Added the length attribute to NamedNodeMap; renamed the length method on
152 NodeList, adding a length attribute.
153
154 New in libxml2dom 0.3.3 (Changes since libxml2dom 0.3.2)
155 --------------------------------------------------------
156
157 * Removed redundant weakref usage.
158 * Added explicit copyright and licensing information to source files.
159
160 New in libxml2dom 0.3.2 (Changes since libxml2dom 0.3.1)
161 --------------------------------------------------------
162
163 * Improved the xmlns attribute creation controls.
164
165 New in libxml2dom 0.3.1 (Changes since libxml2dom 0.3)
166 ------------------------------------------------------
167
168 * Fixed empty namespace declarations on elements created with namespaceURI
169 set to None. Previously, such declarations were missing.
170 * Fixed attribute creation and introduced stricter controls over the
171 construction of xmlns attributes.
172
173 New in libxml2dom 0.3 (Changes since libxml2dom 0.2.4)
174 ------------------------------------------------------
175
176 * Imposed much stricter tests on strings used with the libxml2dom API.
177 Strings given as arguments to methods and functions must now only contain
178 ASCII characters; any other character data must be provided as Unicode
179 objects. This change fixes various issues with XPath expressions, and
180 quite probably various other things.
181 * Fixed parentNode on Document objects (which caused xml.dom.ext.PrettyPrint
182 to crash).
183 * Added some support for the doctype attribute and related information.
184 * libxml2dom is now licensed under the LGPL - see docs/COPYING.txt for
185 details.
186
187 New in libxml2dom 0.2.4 (Changes since libxml2dom 0.2.3)
188 --------------------------------------------------------
189
190 * Fixed Unicode conversions in the Node's xpath method.
191
192 New in libxml2dom 0.2.3 (Changes since libxml2dom 0.2.2)
193 --------------------------------------------------------
194
195 * Fixed the parse function's docstring.
196 * Added the owner element to obtained attribute nodes.
197 * Fixed Debian package changelog distribution identifiers.
198
199 New in libxml2dom 0.2.2 (Changes since libxml2dom 0.2.1)
200 --------------------------------------------------------
201
202 * Fixed exception raising in parseURI, adding a docstring to explain the
203 current limitations around HTML parsing.
204
205 New in libxml2dom 0.2.1 (Changes since libxml2dom 0.2)
206 ------------------------------------------------------
207
208 * Moved libxml2macro script to the tools directory.
209 * Added getElementsByTagNameNS.
210 * Added a normalize implementation.
211 * Added HTML parsing support.
212 * Added prettyprinting support.
213 * Fixed parseURI.
214 * Introduced better testing for Unicode objects, especially since things
215 like rdflib like to subclass the unicode type, and it might be more
216 convenient to detect such subclasses and convert their values
217 automatically.
218 * Improved some of the API documentation.
219 * Introduced better suppression of warnings, network access, and other
220 potentially intrusive libxml2 features.
221 * Reorganised the documentation, expanding the README.txt file at the
222 expense of the HTML documentation, but removing older, less relevant
223 information.
224 * Added Debian package support.
225
226 New in libxml2dom 0.2 (Changes since libxml2dom 0.1.3)
227 ------------------------------------------------------
228
229 * Adopted libxml2macro code within the libxml2dom classes, removing any
230 dependencies on the libxml2 module - this makes everything much faster
231 and virtually removes any necessity to use libxml2macro.
232 * Improved attribute and document node handling.
233 * Introduced document reference management.
234 * Introduced NodeList wrapper objects.
235
236 New in libxml2dom 0.1.3 (Changes since libxml2dom 0.1.2)
237 --------------------------------------------------------
238
239 * Fixed createElement.
240 * Introduced experimental libxml2macro tools, tests and libraries.
241
242 New in libxml2dom 0.1.2 (Changes since libxml2dom 0.1.1)
243 --------------------------------------------------------
244
245 * Fixed getAttributeNode and getAttributeNodeNS.
246 * Added comment node creation.
247 * Fixed empty namespace usage with elements and attributes.
248 * Introduced usage of the libxml2 file and memory parsing features.
249 * Introduced suppression of DTD retrieval and validation as the default
250 behaviour.
251 * Added experimental XPath method support.
252
253 New in libxml2dom 0.1.1
254 -----------------------
255
256 * Fixed text node creation.
257 * Fixed setAttributeNS.
258 * Added encoding parameters to convenience methods.
259 * Added the missing previousSibling property.
260 * Added release number to the package.
261
262 Release Procedures
263 ------------------
264
265 Update the libxml2dom/__init__.py and libxml2dom/macrolib/__init__.py
266 __version__ attributes.
267 Change the version number and package filename/directory in the documentation.
268 Change code examples in the documentation if appropriate.
269 Update the release notes (see above).
270 Update the package release notes (in the packages directory).
271 Check the setup.py file and ensure that all package directories are mentioned.
272 Check the release information in the PKG-INFO file.
273 Tag, export.
274 Archive, upload.
275 Make packages (see below).
276 Update PyPI, PythonInfo Wiki, Vaults of Parnassus entries.
277
278 Making Packages
279 ---------------
280
281 To make Debian-based packages:
282
283 1. Create new package directories under packages if necessary.
284 2. Make a symbolic link in the distribution's root directory to keep the
285 Debian tools happy; choose one of the following:
286
287 ln -s packages/ubuntu-hoary/python2.4-libxml2dom/debian/
288 ln -s packages/debian-sarge/python2.3-libxml2dom/debian/
289 ln -s packages/debian-etch/python-libxml2dom/debian/
290
291 3. Run the package builder:
292
293 dpkg-buildpackage -rfakeroot
294
295 4. Locate and tidy up the packages in the parent directory of the
296 distribution's root directory.