1 Introduction
2 ------------
3
4 See docs/index.html for the libxml2dom documentation.
5
6 Contact, Copyright and Licence Information
7 ------------------------------------------
8
9 The current Web page for libxml2dom at the time of release is:
10
11 http://www.boddie.org.uk/python/libxml2dom.html
12
13 Copyright and licence information can be found in the docs directory - see
14 docs/COPYING.txt and docs/LICENCE.txt for more information.
15
16 Dependencies
17 ------------
18
19 libxml2 Tested with libxml2 2.6.17.
20 Use --with-python=<path to python executable> if building from
21 source. Previous releases of libxml2 in the 2.6 series may work,
22 but releases before 2.6.16 are not recommended.
23 Python Tested with Python 2.4.
24 Python releases from 2.2 onwards should be compatible with
25 libxml2dom. The principal requirement from such releases is the
26 new-style class support which permits the use of properties in
27 the libxml2dom implementation.
28
29 Testing
30 -------
31
32 Some of the tests require libxml2macro.py to be run on the test source code
33 first. Read the docstrings for the various test files before attempting to run
34 any of them. See also docs/NOTES_libxml2macro.txt for more information. Note
35 that such tests are retained for historical purposes and/or curiosity since
36 libxml2macro.py is no longer supported.
37
38 Issues
39 ------
40
41 The presence of xmlns attributes in serialised documents was called into
42 question, and the tests/namespace.py and tests/namespace2.py files attempt to
43 show the current behaviour of libxml2dom.
44
45 Use of importNode seems to cause some kind of memory issue, probably related
46 to nodes being shared across documents. This was observed in libxml2 2.6.0 but
47 appears to be fixed in libxml2 2.6.16.
48
49 Even compared to minidom, importNode may seem very slow (even the
50 libxml2dom.macrolib implementation, too). A way is needed to get libxml2 to do
51 the node copying itself.
52
53 New in libxml2dom 0.3.1 (Changes since libxml2dom 0.3)
54 ------------------------------------------------------
55
56 * Fixed empty namespace declarations on elements created with namespaceURI
57 set to None. Previously, such declarations were missing.
58 * Fixed attribute creation and introduced stricter controls over the
59 construction of xmlns attributes.
60
61 New in libxml2dom 0.3 (Changes since libxml2dom 0.2.4)
62 ------------------------------------------------------
63
64 * Imposed much stricter tests on strings used with the libxml2dom API.
65 Strings given as arguments to methods and functions must now only contain
66 ASCII characters; any other character data must be provided as Unicode
67 objects. This change fixes various issues with XPath expressions, and
68 quite probably various other things.
69 * Fixed parentNode on Document objects (which caused xml.dom.ext.PrettyPrint
70 to crash).
71 * Added some support for the doctype attribute and related information.
72 * libxml2dom is now licensed under the LGPL - see docs/COPYING.txt for
73 details.
74
75 New in libxml2dom 0.2.4 (Changes since libxml2dom 0.2.3)
76 --------------------------------------------------------
77
78 * Fixed Unicode conversions in the Node's xpath method.
79
80 New in libxml2dom 0.2.3 (Changes since libxml2dom 0.2.2)
81 --------------------------------------------------------
82
83 * Fixed the parse function's docstring.
84 * Added the owner element to obtained attribute nodes.
85 * Fixed Debian package changelog distribution identifiers.
86
87 New in libxml2dom 0.2.2 (Changes since libxml2dom 0.2.1)
88 --------------------------------------------------------
89
90 * Fixed exception raising in parseURI, adding a docstring to explain the
91 current limitations around HTML parsing.
92
93 New in libxml2dom 0.2.1 (Changes since libxml2dom 0.2)
94 ------------------------------------------------------
95
96 * Moved libxml2macro script to the tools directory.
97 * Added getElementsByTagNameNS.
98 * Added a normalize implementation.
99 * Added HTML parsing support.
100 * Added prettyprinting support.
101 * Fixed parseURI.
102 * Introduced better testing for Unicode objects, especially since things
103 like rdflib like to subclass the unicode type, and it might be more
104 convenient to detect such subclasses and convert their values
105 automatically.
106 * Improved some of the API documentation.
107 * Introduced better suppression of warnings, network access, and other
108 potentially intrusive libxml2 features.
109 * Reorganised the documentation, expanding the README.txt file at the
110 expense of the HTML documentation, but removing older, less relevant
111 information.
112 * Added Debian package support.
113
114 New in libxml2dom 0.2 (Changes since libxml2dom 0.1.3)
115 ------------------------------------------------------
116
117 * Adopted libxml2macro code within the libxml2dom classes, removing any
118 dependencies on the libxml2 module - this makes everything much faster
119 and virtually removes any necessity to use libxml2macro.
120 * Improved attribute and document node handling.
121 * Introduced document reference management.
122 * Introduced NodeList wrapper objects.
123
124 New in libxml2dom 0.1.3 (Changes since libxml2dom 0.1.2)
125 --------------------------------------------------------
126
127 * Fixed createElement.
128 * Introduced experimental libxml2macro tools, tests and libraries.
129
130 New in libxml2dom 0.1.2 (Changes since libxml2dom 0.1.1)
131 --------------------------------------------------------
132
133 * Fixed getAttributeNode and getAttributeNodeNS.
134 * Added comment node creation.
135 * Fixed empty namespace usage with elements and attributes.
136 * Introduced usage of the libxml2 file and memory parsing features.
137 * Introduced suppression of DTD retrieval and validation as the default
138 behaviour.
139 * Added experimental XPath method support.
140
141 New in libxml2dom 0.1.1
142 -----------------------
143
144 * Fixed text node creation.
145 * Fixed setAttributeNS.
146 * Added encoding parameters to convenience methods.
147 * Added the missing previousSibling property.
148 * Added release number to the package.
149
150 Release Procedures
151 ------------------
152
153 Update the libxml2dom/__init__.py and libxml2dom/macrolib/__init__.py
154 __version__ attributes.
155 Change the version number and package filename/directory in the documentation.
156 Change code examples in the documentation if appropriate.
157 Update the release notes (see above).
158 Update the package release notes (in the packages directory).
159 Check the setup.py file and ensure that all package directories are mentioned.
160 Check the release information in the PKG-INFO file and in the package
161 changelog (and other files).
162 Tag, export.
163 Archive, upload.
164 Make packages (see below).
165 Update PyPI, PythonInfo Wiki, Vaults of Parnassus entries.
166
167 Making Packages
168 ---------------
169
170 To make Debian-based packages:
171
172 1. Create new package directories under packages if necessary.
173 2. Make a symbolic link in the distribution's root directory to keep the
174 Debian tools happy:
175
176 ln -s packages/ubuntu-hoary/python2.4-libxml2dom/debian/
177
178 3. Run the package builder:
179
180 dpkg-buildpackage -rfakeroot
181
182 4. Locate and tidy up the packages in the parent directory of the
183 distribution's root directory.