# HG changeset patch # User paulb # Date 1074467081 0 # Node ID c7b424ab00a602dfb927e53e715d4a25e5f2c37f # Parent b30eea381304100f30ebe234347672b1ddd6fa05 [project @ 2004-01-18 23:04:41 by paulb] Added documentation and copyright/licensing details. diff -r b30eea381304 -r c7b424ab00a6 docs/COPYING.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/COPYING.txt Sun Jan 18 23:04:41 2004 +0000 @@ -0,0 +1,23 @@ + Copyright (C) 2003, 2004 Paul Boddie . + All Rights Reserved. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL PAUL +BODDIE BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN +ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +Except as contained in this notice, the name of Paul Boddie shall not be used +in advertising or otherwise to promote the sale, use or other dealings in +this Software without prior written authorization from him. diff -r b30eea381304 -r c7b424ab00a6 docs/index.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/index.html Sun Jan 18 23:04:41 2004 +0000 @@ -0,0 +1,64 @@ + + + + XMLTools2 + + + + + +

libxml2dom

+ +

The libxml2dom package provides a traditional DOM wrapper around the +Python bindings for libxml2. In contrast to the libxml2 bindings, libxml2dom +provides an API reminiscent of minidom, pxdom and other Python-based and +Python-related XML toolkits. Performance is disappointing, given the typical +high speed of libxml2 processing, but this is to be expected since large +numbers of Python objects are instantiated at two levels of document tree +representation. However, serialisation of documents is much faster than many +other toolkits because it can make direct use of libxml2.

+ +

Copyright and Licence

+ +

For reasons of consistency, libxml2dom uses the same MIT-style licence as +libxml2. See the file COPYING.txt in the docs +directory within the source code distribution.

+ +

Dependencies and Installation Issues

+ +

The following descriptions identify dependencies and describe appropriate +installation issues with each dependency:

+ +

libxml2 2.6.0

+ +

Building libxml2 from source and configuring the Python bindings can be +done as follows:

cd libxml2-2.6.0
+./configure --with-python=/usr/local/bin/python
+make

+ +

If you are to use an installation of Python installed outside +/usr/local then specify the "prefix" accordingly. Install +(possibly as root) in the usual way:

make install

+ +

Issues

+ +

The patches directory in the source code distribution +contains a patch against libxml2 2.5.7 which resolves an issue exposed by +libxml2dom. Although it is recommended that later releases of libxml2 are +used instead, the source code distribution of libxml2 2.5.7 can be patched as +follows:

patch -p0 < libxml2dom/patches/libxml2/libxml.c.diff

+ +

The command should be run outside/above the libxml2-2.5.7 +directory, and the stated path should be adjusted accordingly.

+ +

Python 2.2

+ +

Python releases from 2.2 onwards should be compatible with libxml2dom. The +principal requirement from such releases is the new-style class support which +permits the use of properties in the libxml2dom implementation, thus +simplifying the code somewhat.

+ + diff -r b30eea381304 -r c7b424ab00a6 docs/styles.css --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/styles.css Sun Jan 18 23:04:41 2004 +0000 @@ -0,0 +1,97 @@ +.Selected { +background-color: silver; +color: black; +font-family: sans-serif; +} + +.Selected A:link { color: black; } +.Selected A:visited { color: black; } +.Selected A:active { color: black; } + +.Unselected { +background-color: gray; +color: black; +font-family: sans-serif; +} + +.Unselected A:link { color: black; } +.Unselected A:visited { color: black; } +.Unselected A:active { color: black; } + +.Main { vertical-align: top; } + +BODY { +background-color: white; +font-size: 12pt; +} + +H1 { +color: navy; +font-family: sans-serif; +font-size: 20pt; +} + +H2 { +color: navy; +font-family: sans-serif; +font-size: 18pt; +} + +H3 { +color: navy; +font-family: sans-serif; +font-size: 16pt; +} + +H4 { +color: navy; +font-family: sans-serif; +font-size: 15pt; +} + +H5 { +color: navy; +font-family: sans-serif; +font-size: 14pt; +} + +UL { +list-style-type: disc; +} + +PRE { +background-color: silver; +color: black; +} + +.MainHeading { +color: black; +background-color: gray; +font-family: sans-serif; +font-size: 14pt; +font-weight: bold; +vertical-align: top; +} + +.SubHeading { +color: black; +background-color: silver; +font-family: sans-serif; +font-size: 14pt; +font-weight: bold; +vertical-align: top; +} + +.CellHeading { +color: black; +background-color: silver; +font-family: sans-serif; +font-size: 12pt; +font-weight: bold; +vertical-align: top; +} + +.CellContent { +font-size: 12pt; +vertical-align: top; +}