Log message for revision 93669:
release preparations.
Changed:
U z3c.schema2xml/trunk/CHANGES.txt
U z3c.schema2xml/trunk/COPYRIGHT.txt
U z3c.schema2xml/trunk/setup.py
U z3c.schema2xml/trunk/src/z3c/schema2xml/README.txt
-=-
Modified: z3c.schema2xml/trunk/CHANGES.txt
===================================================================
--- z3c.schema2xml/trunk/CHANGES.txt 2008-12-05 18:42:26 UTC (rev 93668)
+++ z3c.schema2xml/trunk/CHANGES.txt 2008-12-05 18:46:19 UTC (rev 93669)
@@ -1,6 +1,5 @@
-======================
-z3c.schema2xml changes
-======================
+CHANGES
+*******
1.0 (2008-12-05)
================
Modified: z3c.schema2xml/trunk/COPYRIGHT.txt
===================================================================
--- z3c.schema2xml/trunk/COPYRIGHT.txt 2008-12-05 18:42:26 UTC (rev 93668)
+++ z3c.schema2xml/trunk/COPYRIGHT.txt 2008-12-05 18:46:19 UTC (rev 93669)
@@ -1,4 +1,4 @@
-Copyright (c) 2007 Zope Corporation and Contributors
+Copyright (c) 2007-2008 Zope Corporation and Contributors
All Rights Reserved.
This software is subject to the provisions of the Zope Public License,
Modified: z3c.schema2xml/trunk/setup.py
===================================================================
--- z3c.schema2xml/trunk/setup.py 2008-12-05 18:42:26 UTC (rev 93668)
+++ z3c.schema2xml/trunk/setup.py 2008-12-05 18:46:19 UTC (rev 93669)
@@ -1,11 +1,22 @@
from setuptools import setup, find_packages
import sys, os
+def read(*rnames):
+ return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
+
+long_description = (
+ read('src', 'z3c', 'schema2xml', 'README.txt')
+ + '\n' +
+ read('CHANGES.txt')
+ + '\n' +
+ 'Download\n'
+ '********\n'
+ )
+
setup(name='z3c.schema2xml',
- version='0.11dev',
+ version='1.0dev',
description="Convert schema-described Zope 3 objects to XML and back",
- long_description="""\
-""",
+ long_description=long_description,
classifiers=[],
keywords="",
author="Martijn Faassen, Jan-Wijbrand Kolman",
Modified: z3c.schema2xml/trunk/src/z3c/schema2xml/README.txt
===================================================================
--- z3c.schema2xml/trunk/src/z3c/schema2xml/README.txt 2008-12-05 18:42:26 UTC (rev 93668)
+++ z3c.schema2xml/trunk/src/z3c/schema2xml/README.txt 2008-12-05 18:46:19 UTC (rev 93669)
@@ -1,6 +1,9 @@
Schema To XML
-=============
+*************
+Introduction
+============
+
This package can convert objects described by Zope 3 schema to simple
XML structures. It's also able to convert this XML back into objects.
The export and import processes are completely schema-driven; any
@@ -12,14 +15,10 @@
objects for other purposes, such as XSLT transformations, or even just
to get a full-text representation for index purposes.
-The package lies on ``lxml``. It also relies on ``grok``, which will
-make it somewhat harder to integrate with a normal Zope 3 application
-at present. It is expected this will change as the core grokking
-procedure used by this package (to Grok adapters) makes it into a more
-limited package that does not rely on other aspects of Grok.
+The package lies on ``lxml`` for the serialization to XML.
Serialization
--------------
+=============
Let's first define a simple Zope 3 schema::
@@ -166,7 +165,7 @@
TypeError: ('Could not adapt', <zope.schema._bootstrapfields.Field object at ...>, <InterfaceClass z3c.schema2xml._schema2xml.IXMLGenerator>)
Deserialization
----------------
+===============
Now we want to deserialize XML according to a schema to an object that
provides this schema.
@@ -405,7 +404,7 @@
for the other field types that have a serializer.
Datetime
---------
+========
Datetime objects::
@@ -445,7 +444,7 @@
True
Choice
-------
+======
Choice fields. For now, we only work with Choice fields that have
text values::
@@ -483,7 +482,7 @@
True
Set
----
+===
Set fields are very similar to List fields::