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 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 Use of importNode seems to cause some kind of memory issue, probably related
42 to nodes being shared across documents. This was observed in libxml2 2.6.0 but
43 appears to be fixed in libxml2 2.6.16.
44
45 Even compared to minidom, importNode may seem very slow (even the
46 libxml2dom.macrolib implementation, too). A way is needed to get libxml2 to do
47 the node copying itself.
48
49 New in libxml2dom 0.2.3 (Changes since libxml2dom 0.2.2)
50 --------------------------------------------------------
51
52 * Fixed the parse function's docstring.
53 * Added the owner element to obtained attribute nodes.
54 * Fixed Debian package changelog distribution identifiers.
55
56 New in libxml2dom 0.2.2 (Changes since libxml2dom 0.2.1)
57 --------------------------------------------------------
58
59 * Fixed exception raising in parseURI, adding a docstring to explain the
60 current limitations around HTML parsing.
61
62 New in libxml2dom 0.2.1 (Changes since libxml2dom 0.2)
63 ------------------------------------------------------
64
65 * Moved libxml2macro script to the tools directory.
66 * Added getElementsByTagNameNS.
67 * Added a normalize implementation.
68 * Added HTML parsing support.
69 * Added prettyprinting support.
70 * Fixed parseURI.
71 * Introduced better testing for Unicode objects, especially since things
72 like rdflib like to subclass the unicode type, and it might be more
73 convenient to detect such subclasses and convert their values
74 automatically.
75 * Improved some of the API documentation.
76 * Introduced better suppression of warnings, network access, and other
77 potentially intrusive libxml2 features.
78 * Reorganised the documentation, expanding the README.txt file at the
79 expense of the HTML documentation, but removing older, less relevant
80 information.
81 * Added Debian package support.
82
83 New in libxml2dom 0.2 (Changes since libxml2dom 0.1.3)
84 ------------------------------------------------------
85
86 * Adopted libxml2macro code within the libxml2dom classes, removing any
87 dependencies on the libxml2 module - this makes everything much faster
88 and virtually removes any necessity to use libxml2macro.
89 * Improved attribute and document node handling.
90 * Introduced document reference management.
91 * Introduced NodeList wrapper objects.
92
93 New in libxml2dom 0.1.3 (Changes since libxml2dom 0.1.2)
94 --------------------------------------------------------
95
96 * Fixed createElement.
97 * Introduced experimental libxml2macro tools, tests and libraries.
98
99 New in libxml2dom 0.1.2 (Changes since libxml2dom 0.1.1)
100 --------------------------------------------------------
101
102 * Fixed getAttributeNode and getAttributeNodeNS.
103 * Added comment node creation.
104 * Fixed empty namespace usage with elements and attributes.
105 * Introduced usage of the libxml2 file and memory parsing features.
106 * Introduced suppression of DTD retrieval and validation as the default
107 behaviour.
108 * Added experimental XPath method support.
109
110 New in libxml2dom 0.1.1
111 -----------------------
112
113 * Fixed text node creation.
114 * Fixed setAttributeNS.
115 * Added encoding parameters to convenience methods.
116 * Added the missing previousSibling property.
117 * Added release number to the package.
118
119 Release Procedures
120 ------------------
121
122 Update the libxml2dom/__init__.py and libxml2dom/macrolib/__init__.py
123 __version__ attributes.
124 Change the version number and package filename/directory in the documentation.
125 Change code examples in the documentation if appropriate.
126 Update the release notes (see above).
127 Update the package release notes (in the packages directory).
128 Check the setup.py file and ensure that all package directories are mentioned.
129 Check the release information in the PKG-INFO file and in the package
130 changelog (and other files).
131 Tag, export.
132 Archive, upload.
133 Make packages (see below).
134 Update PyPI, PythonInfo Wiki, Vaults of Parnassus entries.
135
136 Making Packages
137 ---------------
138
139 To make Debian-based packages:
140
141 1. Create new package directories under packages if necessary.
142 2. Make a symbolic link in the distribution's root directory to keep the
143 Debian tools happy:
144
145 ln -s packages/ubuntu-hoary/python2.4-libxml2dom/debian/
146
147 3. Run the package builder:
148
149 dpkg-buildpackage -rfakeroot
150
151 4. Locate and tidy up the packages in the parent directory of the
152 distribution's root directory.