[Checkins] SVN: z3c.layer.ready2go/trunk/ Fix up meta data and docs. Get ready for release.

Stephan Richter srichter at cosmos.phy.tufts.edu
Thu Jan 24 21:54:15 EST 2008


Log message for revision 83208:
  Fix up meta data and docs. Get ready for release.
  

Changed:
  U   z3c.layer.ready2go/trunk/CHANGES.txt
  U   z3c.layer.ready2go/trunk/setup.py
  U   z3c.layer.ready2go/trunk/src/z3c/layer/ready2go/README.txt

-=-
Modified: z3c.layer.ready2go/trunk/CHANGES.txt
===================================================================
--- z3c.layer.ready2go/trunk/CHANGES.txt	2008-01-25 02:30:03 UTC (rev 83207)
+++ z3c.layer.ready2go/trunk/CHANGES.txt	2008-01-25 02:54:14 UTC (rev 83208)
@@ -2,13 +2,13 @@
 CHANGES
 =======
 
-Version 0.5.1dev (unreleased)
------------------------------
+Version 0.5.1 (2008-01-24)
+--------------------------
 
-- ...
+- Bug: Fix meta-data.
 
 
-Version 0.5.0 (2007-01-21)
+Version 0.5.0 (2008-01-21)
 --------------------------
 
 - Initial Release

Modified: z3c.layer.ready2go/trunk/setup.py
===================================================================
--- z3c.layer.ready2go/trunk/setup.py	2008-01-25 02:30:03 UTC (rev 83207)
+++ z3c.layer.ready2go/trunk/setup.py	2008-01-25 02:54:14 UTC (rev 83208)
@@ -16,20 +16,27 @@
 $Id:$
 """
 import os
+import xml.sax.saxutils
 from setuptools import setup, find_packages
 
 def read(*rnames):
-    return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
+    text = open(os.path.join(os.path.dirname(__file__), *rnames)).read()
+    return xml.sax.saxutils.escape(text)
 
 setup (
     name='z3c.layer.ready2go',
-    version='0.5.1dev',
+    version='0.5.1',
     author = "Stephan Richter, Roger Ineichen and the Zope Community",
-    author_email = "zope3-dev at zope.org",
+    author_email = "zope-dev at zope.org",
     description = "A ready to go layer for Zope3",
     long_description=(
         read('README.txt')
         + '\n\n' +
+        'Detailed Documentation\n'
+        '**********************'
+        + '\n\n' +
+        read('src', 'z3c', 'layer', 'ready2go', 'README.txt')
+        + '\n\n' +
         read('CHANGES.txt')
         ),
     license = "ZPL 2.1",
@@ -44,7 +51,7 @@
         'Operating System :: OS Independent',
         'Topic :: Internet :: WWW/HTTP',
         'Framework :: Zope3'],
-    url = 'http://cheeseshop.python.org/pypi/z3c.layer.ready2go',
+    url = 'http://pypi.python.org/pypi/z3c.layer.ready2go',
     packages = find_packages('src'),
     include_package_data = True,
     package_dir = {'':'src'},
@@ -73,6 +80,5 @@
         'z3c.form',
         'z3c.formui',
         ],
-    dependency_links = ['http://download.zope.org/distribution'],
     zip_safe = False,
-)
\ No newline at end of file
+)

Modified: z3c.layer.ready2go/trunk/src/z3c/layer/ready2go/README.txt
===================================================================
--- z3c.layer.ready2go/trunk/src/z3c/layer/ready2go/README.txt	2008-01-25 02:30:03 UTC (rev 83207)
+++ z3c.layer.ready2go/trunk/src/z3c/layer/ready2go/README.txt	2008-01-25 02:54:14 UTC (rev 83208)
@@ -1,35 +1,35 @@
-======
-README
-======
+===========================
+Ready-2-Go Layer for Zope 3
+===========================
 
-This package contains the ready2go layer. This layer supports a correct set of
+This package contains the `ready2go` layer. This layer supports a correct set of
 component registration and can be used for inheritation in custom skins.
 
 Important
 ---------
 
-This layer supports the z3c.pagelet and the z3c.form pattern. This means every 
-page e.g. the error page is based on the z3c.pagelet concept. By default we use 
-the Div based layout for z3c forms.
+This layer supports the ``z3c.pagelet`` and the ``z3c.form`` pattern. This
+means every page e.g. the error page is based on the ``z3c.pagelet``
+concept. By default we use the ``<div>``-based layout for z3c forms.
 
 
-IReady2GoBrowserLayer
----------------------
+``IReady2GoBrowserLayer`` Layer
+-------------------------------
 
-The ready2go layer is useful for build custom presentation skins without access
-to ZMI menus like zmi_views etc. This means there is no menu item registred if
-you use this layer.
+The `ready2go` layer is useful for build custom presentation skins without
+access to ZMI menus like ``zmi_views`` etc. This means there is no menu item
+registred if you use this layer.
 
-For more information about what this layer offers, see z3c.layer.pagelet
+For more information about what this layer offers, see ``z3c.layer.pagelet``.
 
 
 Testing
 -------
 
-For testing the IReady2GoBrowserLayer we use the testing skin defined in the
-tests package which uses the IReady2GoBrowserLayer as the only base layer.
-This means, that our testing skin provides only the views defined in the
-minimal package and it's testing views defined in tests.
+For testing the ``IReady2GoBrowserLayer`` layer we use the testing skin
+defined in the tests package which uses the ``IReady2GoBrowserLayer`` layer as
+the only base layer.  This means, that our testing skin provides only the
+views defined in the minimal package and it's testing views defined in tests.
 
 Login as manager first:
 
@@ -37,8 +37,8 @@
   >>> manager = Browser()
   >>> manager.addHeader('Authorization', 'Basic mgr:mgrpw')
 
-Check if we can access the page.html view which is registred in the
-ftesting.zcml file with our skin:
+Check if we can access the ``page.html`` view which is registred in the
+``ftesting.zcml`` file with our skin:
 
   >>> manager = Browser()
   >>> manager.addHeader('Authorization', 'Basic mgr:mgrpw')
@@ -51,8 +51,8 @@
 Pagelet support
 ---------------
 
-Check if we can access the test page given from the z3c.layer.pagelet 
-ftesting.zcml configuration.
+Check if we can access the test page given from the ``z3c.layer.pagelet``
+``ftesting.zcml`` configuration.
 
   >>> print manager.contents
   <!DOCTYPE...
@@ -186,8 +186,8 @@
 Form and form layout support
 ----------------------------
 
-This layer offers also form macros given from z3c.formui. Let's create a simple
-form:
+This layer offers also form macros given from ``z3c.formui``. Let's create a
+simple form:
 
   >>> from z3c.form import testing
   >>> testing.setupFormDefaults()
@@ -212,7 +212,7 @@
   >>> from zope.schema.fieldproperty import FieldProperty
   >>> class Person(object):
   ...     zope.interface.implements(IPerson)
-  ... 
+  ...
   ...     name = FieldProperty(IPerson['name'])
   ...     age = FieldProperty(IPerson['age'])
   ...
@@ -256,7 +256,7 @@
   >>> root = getRootFolder()
   >>> addForm = PersonAddForm(root, divRequest)
 
-Since we have not specified a template yet, we have to do this now. We use our 
+Since we have not specified a template yet, we have to do this now. We use our
 div based form template:
 
   >>> import os
@@ -276,8 +276,8 @@
   ...     (zope.interface.Interface, IDivFormLayer),
   ...     IContentTemplate)
 
-And let's define a layout template which simply calls the render method. For a 
-more adavanced content/layout render concept see z3c.pagelet.
+And let's define a layout template which simply calls the render method. For a
+more adavanced content/layout render concept see ``z3c.pagelet``.
 
   >>> import tempfile
   >>> temp_dir = tempfile.mkdtemp()



More information about the Checkins mailing list