[Zope3-checkins] CVS: zopeproducts/xml/dom - README.txt:1.2

[Philipp von Weitershausen]

Update of /cvs-repository/zopeproducts/xml/dom
In directory cvs.zope.org:/tmp/cvs-serv20213

Modified Files:
	README.txt 
Log Message:
Reformatted to STX and added a word about the new adapters.


=== zopeproducts/xml/dom/README.txt 1.1 => 1.2 ===
--- zopeproducts/xml/dom/README.txt:1.1	Fri Jun 20 11:11:38 2003
+++ zopeproducts/xml/dom/README.txt	Sun Jun 22 20:20:36 2003
@@ -1,59 +1,59 @@
 Documentation
-=============
 
-xmldom implements an XML DOM, the DOM standard is the right
-place to find documentation:
+  xml.dom implements an XML DOM. The DOM standard is the right place
+  to find documentation:
 
-  http://www.w3.org/DOM/
+    http://www.w3.org/DOM/
 
-xmldom implements DOM level 2 (in particular Core, and buggily parts
-of Traversal), with some experimental level 3 extensions.
+  xml.dom implements DOM level 2 (in particular Core, and buggily
+  parts of Traversal), with some experimental level 3 extensions.
 
-  http://www.w3.org/DOM/DOMTR#dom2
+    http://www.w3.org/DOM/DOMTR#dom2
 
-  http://www.w3.org/DOM/DOMTR#dom3
+    http://www.w3.org/DOM/DOMTR#dom3
 
-Example
-=======
+  Quick example::
 
-from zopeproducts.xmldom import expatbuilder
-from StringIO import StringIO
+    from zopeproducts.xmldom import expatbuilder
+    from StringIO import StringIO
 
-xml = '<doc>Hello world!</doc>'
-f = StringIO(xml)
+    xml = '<doc>Hello world!</doc>'
+    f = StringIO(xml)
 
-dom = expatbuilder.parse(f)
+    dom = expatbuilder.parse(f)
+
+  xml.dom also comes with (currently two) adapters which make
+  converting XML text to DOM and back quite easy.
 
 Background
-==========
 
-xmldom is derived from the Zope 2 ParsedXML product. It only contains
-that product's DOM implementation and tests, not any of the Zope
-integration (which would be very different in Zope 3 anyway). It has
-been changed to work with Zope 3:
+  xmldom is derived from the Zope 2 ParsedXML product. It only
+  contains that product's DOM implementation and tests, not any of the
+  Zope integration (which would be very different in Zope 3
+  anyway). It has been changed to work with Zope 3 in the following
+  way:
 
-  * now uses ContextWrappers instead of Zope 2 explicit acquisition.
+    * now uses ContextWrappers instead of Zope 2 explicit acquisition.
 
-  * uses Python 2.2 properties instead of custom __getattr__ based
-    access handlers. All kinds of __dict__ workarounds have also been
-    removed.
+    * uses Python 2.2 properties instead of custom __getattr__ based
+      access handlers. All kinds of __dict__ workarounds have also
+      been removed.
 
-  * module names are in lower case.
+    * module names are in lower case.
 
-  * relicensed to ZPL 2.0.
+    * relicensed to ZPL 2.0.
 
-It passes the (extensive) DOM unit tests which are also included. 
+  It passes the (extensive) DOM unit tests which are also included.
 
-Problems
-========
+Known problems
 
-The code is extremely grotty in many places. This is in part due to
-the requirements of XML conformance and the DOM standard in particular
-(which doesn't excel in clean design). It does pass the tests,
-however.
+  The code is extremely grotty in many places. This is in part due to
+  the requirements of XML conformance and the DOM standard in
+  particular (which doesn't excel in clean design). It does pass the
+  tests, however.
 
-Traversal implementation seems to be buggy.
+  Traversal implementation seems to be buggy.
 
-It still exhibits the same fundamental problem as ParsedXML does
-concerning ContextWrappers, for more information see
-tests/test_contextwrapperpain.py.
+  It still exhibits the same fundamental problem as ParsedXML does
+  concerning ContextWrappers, for more information see
+  tests/test_contextwrapperpain.py.