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 files attempt to show the current
43 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.4 (Changes since libxml2dom 0.3.3)
54 --------------------------------------------------------
55
56 * Attempted to introduce generated prefixes for attributes having namespaces
57 but whose names are unprefixed.
58
59 New in libxml2dom 0.3.3 (Changes since libxml2dom 0.3.2)
60 --------------------------------------------------------
61
62 * Removed redundant weakref usage.
63 * Added explicit copyright and licensing information to source files.
64
65 New in libxml2dom 0.3.2 (Changes since libxml2dom 0.3.1)
66 --------------------------------------------------------
67
68 * Improved the xmlns attribute creation controls.
69
70 New in libxml2dom 0.3.1 (Changes since libxml2dom 0.3)
71 ------------------------------------------------------
72
73 * Fixed empty namespace declarations on elements created with namespaceURI
74 set to None. Previously, such declarations were missing.
75 * Fixed attribute creation and introduced stricter controls over the
76 construction of xmlns attributes.
77
78 New in libxml2dom 0.3 (Changes since libxml2dom 0.2.4)
79 ------------------------------------------------------
80
81 * Imposed much stricter tests on strings used with the libxml2dom API.
82 Strings given as arguments to methods and functions must now only contain
83 ASCII characters; any other character data must be provided as Unicode
84 objects. This change fixes various issues with XPath expressions, and
85 quite probably various other things.
86 * Fixed parentNode on Document objects (which caused xml.dom.ext.PrettyPrint
87 to crash).
88 * Added some support for the doctype attribute and related information.
89 * libxml2dom is now licensed under the LGPL - see docs/COPYING.txt for
90 details.
91
92 New in libxml2dom 0.2.4 (Changes since libxml2dom 0.2.3)
93 --------------------------------------------------------
94
95 * Fixed Unicode conversions in the Node's xpath method.
96
97 New in libxml2dom 0.2.3 (Changes since libxml2dom 0.2.2)
98 --------------------------------------------------------
99
100 * Fixed the parse function's docstring.
101 * Added the owner element to obtained attribute nodes.
102 * Fixed Debian package changelog distribution identifiers.
103
104 New in libxml2dom 0.2.2 (Changes since libxml2dom 0.2.1)
105 --------------------------------------------------------
106
107 * Fixed exception raising in parseURI, adding a docstring to explain the
108 current limitations around HTML parsing.
109
110 New in libxml2dom 0.2.1 (Changes since libxml2dom 0.2)
111 ------------------------------------------------------
112
113 * Moved libxml2macro script to the tools directory.
114 * Added getElementsByTagNameNS.
115 * Added a normalize implementation.
116 * Added HTML parsing support.
117 * Added prettyprinting support.
118 * Fixed parseURI.
119 * Introduced better testing for Unicode objects, especially since things
120 like rdflib like to subclass the unicode type, and it might be more
121 convenient to detect such subclasses and convert their values
122 automatically.
123 * Improved some of the API documentation.
124 * Introduced better suppression of warnings, network access, and other
125 potentially intrusive libxml2 features.
126 * Reorganised the documentation, expanding the README.txt file at the
127 expense of the HTML documentation, but removing older, less relevant
128 information.
129 * Added Debian package support.
130
131 New in libxml2dom 0.2 (Changes since libxml2dom 0.1.3)
132 ------------------------------------------------------
133
134 * Adopted libxml2macro code within the libxml2dom classes, removing any
135 dependencies on the libxml2 module - this makes everything much faster
136 and virtually removes any necessity to use libxml2macro.
137 * Improved attribute and document node handling.
138 * Introduced document reference management.
139 * Introduced NodeList wrapper objects.
140
141 New in libxml2dom 0.1.3 (Changes since libxml2dom 0.1.2)
142 --------------------------------------------------------
143
144 * Fixed createElement.
145 * Introduced experimental libxml2macro tools, tests and libraries.
146
147 New in libxml2dom 0.1.2 (Changes since libxml2dom 0.1.1)
148 --------------------------------------------------------
149
150 * Fixed getAttributeNode and getAttributeNodeNS.
151 * Added comment node creation.
152 * Fixed empty namespace usage with elements and attributes.
153 * Introduced usage of the libxml2 file and memory parsing features.
154 * Introduced suppression of DTD retrieval and validation as the default
155 behaviour.
156 * Added experimental XPath method support.
157
158 New in libxml2dom 0.1.1
159 -----------------------
160
161 * Fixed text node creation.
162 * Fixed setAttributeNS.
163 * Added encoding parameters to convenience methods.
164 * Added the missing previousSibling property.
165 * Added release number to the package.
166
167 Release Procedures
168 ------------------
169
170 Update the libxml2dom/__init__.py and libxml2dom/macrolib/__init__.py
171 __version__ attributes.
172 Change the version number and package filename/directory in the documentation.
173 Change code examples in the documentation if appropriate.
174 Update the release notes (see above).
175 Update the package release notes (in the packages directory).
176 Check the setup.py file and ensure that all package directories are mentioned.
177 Check the release information in the PKG-INFO file.
178 Tag, export.
179 Archive, upload.
180 Make packages (see below).
181 Update PyPI, PythonInfo Wiki, Vaults of Parnassus entries.
182
183 Making Packages
184 ---------------
185
186 To make Debian-based packages:
187
188 1. Create new package directories under packages if necessary.
189 2. Make a symbolic link in the distribution's root directory to keep the
190 Debian tools happy:
191
192 ln -s packages/ubuntu-hoary/python2.4-libxml2dom/debian/
193
194 3. Run the package builder:
195
196 dpkg-buildpackage -rfakeroot
197
198 4. Locate and tidy up the packages in the parent directory of the
199 distribution's root directory.