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

[Stephan Richter]

Log message for revision 83205:
  Fix meta-data and docs. Get ready for release.
  

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

-=-
Modified: z3c.layer.pagelet/trunk/CHANGES.txt
===================================================================
--- z3c.layer.pagelet/trunk/CHANGES.txt	2008-01-25 02:08:35 UTC (rev 83204)
+++ z3c.layer.pagelet/trunk/CHANGES.txt	2008-01-25 02:28:18 UTC (rev 83205)
@@ -2,21 +2,22 @@
 CHANGES
 =======
 
-1.0.1dev (unreleased)
----------------------
+1.0.1 (2008-01-24)
+------------------
 
-- ...
+- Bug: Update meta data.
 
 
-1.0.0 (2007-01-21)
+1.0.0 (2008-01-21)
 ------------------
 
-- move z3c.layer.pagelet package to it's own top level package
-  form zope.layer to z3c.layer.pagelet
+- Restructure: Move ``z3c.layer.pagelet`` package to it's own top level
+  package form ``zope.layer`` to ``z3c.layer.pagelet``.
 
-- Removed zope.app.form support from pagelet layer.
+- Restructure: Removed ``zope.app.form`` support from pagelet layer.
 
-- moved implementation from z3c.layer to z3c.layer.pagelet
+- Restructure: Moved implementation from ``z3c.layer`` to
+  ``z3c.layer.pagelet``.
 
 
 0.2.3 (2007-11-07)
@@ -31,7 +32,7 @@
 0.2.2 (2007-10-31)
 ------------------
 
-- Fixed package meta-data.
+- Bug: Fixed package meta-data.
 
 - Bug: Fixed test failures due to depency updates.
 

Modified: z3c.layer.pagelet/trunk/setup.py
===================================================================
--- z3c.layer.pagelet/trunk/setup.py	2008-01-25 02:08:35 UTC (rev 83204)
+++ z3c.layer.pagelet/trunk/setup.py	2008-01-25 02:28:18 UTC (rev 83205)
@@ -16,22 +16,28 @@
 
 $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.pagelet',
-    version = '1.0.1dev',
+    version = '1.0.1',
     author='Zope Foundation and Contributors',
-    author_email='zope3-dev at zope.org',
+    author_email='zope-dev at zope.org',
     description = "Pagelet layer setup for Zope3",
     long_description=(
         read('README.txt')
         + '\n\n' +
+        'Detailed Documentation\n'
+        '**********************'
+        + '\n\n' +
+        read('src', 'z3c', 'layer', 'pagelet', 'README.txt')
+        + '\n\n' +
         read('CHANGES.txt')
         ),
     keywords = "z3c pagelet layer zope zope3",
@@ -45,7 +51,7 @@
         'Operating System :: OS Independent',
         'Topic :: Internet :: WWW/HTTP',
         'Framework :: Zope3'],
-    url='http://cheeseshop.python.org/pypi/z3c.layer.pagelet',
+    url='http://pypi.python.org/pypi/z3c.layer.pagelet',
     license='ZPL 2.1',
     packages = find_packages('src'),
     include_package_data = True,

Modified: z3c.layer.pagelet/trunk/src/z3c/layer/pagelet/README.txt
===================================================================
--- z3c.layer.pagelet/trunk/src/z3c/layer/pagelet/README.txt	2008-01-25 02:08:35 UTC (rev 83204)
+++ z3c.layer.pagelet/trunk/src/z3c/layer/pagelet/README.txt	2008-01-25 02:28:18 UTC (rev 83205)
@@ -1,6 +1,6 @@
-======
-README
-======
+==============================
+Pagelet-based Layer for Zope 3
+==============================
 
 This package contains the pagelet layer. This layer supports a correct set of
 component registration and can be used for inheritation in custom skins.
@@ -11,35 +11,35 @@
 Important
 ---------
 
-This layer supports the z3c.pagelet pattern. This means every page e.g. the
-error page is based on the z3c.pagelet concept.
+This layer ia based on the pagelet pattern. This means every page e.g. the
+error page is based on the pagelet concept.
 
 
-IPageletBrowserLayer
---------------------
+``IPageletBrowserLayer`` Layer
+------------------------------
 
 The pagelet 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.
+to ZMI menus like ``zmi_views`` etc. This means there is no menu item
+registred if you use this layer.
 
-This layer is NOT derived from IDefaultBrowserLayer. Therefore it provides
-only a minimal set of the most important public views such as @@absolute_url.
-The following packages are accounted:
+This layer is *NOT* derived from ``IDefaultBrowserLayer`` layer. Therefore it
+provides only a minimal set of the most important public views such as
+``@@absolute_url``.  The following packages are accounted:
 
-- zope.app.http.exception
-- zope.app.publication
-- zope.app.publisher.browser
-- zope.app.traversing
-- zope.app.traversing.browser
+- ``zope.app.http.exception``
+- ``zope.app.publication``
+- ``zope.app.publisher.browser``
+- ``zope.app.traversing``
+- ``zope.app.traversing.browser``
 
 
 Testing
 -------
 
-For testing the IPageletBrowserLayer we use the testing skin defined in the
-tests package which uses the IPageletBrowserLayer 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 ``IPageletBrowserLayer`` layer we use the testing skin defined
+in the tests package which uses the ``IPageletBrowserLayer`` 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:
 
@@ -47,8 +47,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')