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