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