Author: jmorliaguet
Date: Sun Oct 23 12:57:17 2005
New Revision: 28549

Modified:
   z3lab/z3ecm/trunk/src/ecm/cpsskins/example1/README.txt
Log:

- better reST formatting



Modified: z3lab/z3ecm/trunk/src/ecm/cpsskins/example1/README.txt
==============================================================================
--- z3lab/z3ecm/trunk/src/ecm/cpsskins/example1/README.txt      (original)
+++ z3lab/z3ecm/trunk/src/ecm/cpsskins/example1/README.txt      Sun Oct 23 
12:57:17 2005
@@ -1,7 +1,16 @@
 
+.. header:: cpsskins tutorial
+
 Example 1: Hello portlet
 ========================
 
+:Author: Jean-Marc Orliaguet
+:Version: $Revision: 1 $
+:Copyright: 2005 Nuxeo and Contributors.
+
+.. contents::
+
+
 Description
 -----------
 
@@ -19,8 +28,8 @@
 
 You may take a look the `<hello.py>`_ file while going through the steps.
 
-Step 1: defining the portlet's interface (IHelloPortlet)
-........................................................
+Step 1: defining the portlet's interface
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 First you should make the interface of your portlet inherit from the IPortlet
 interface:
@@ -33,6 +42,7 @@
 In cpsskins all portlets have a title. The 'title' field is declared in the
 IPortlet interface as::
 
+
     title = schema.TextLine(
         title=_("Portlet's title"),
         required=False)
@@ -42,8 +52,8 @@
 inherited from IPortlet.
 
 
-Step 2: defining the portlet's factory (HelloPortlet)
-.....................................................
+Step 2: defining the portlet's factory
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Now that you have an interface definition for your portlet you need to create
 a class that implements the interface.
@@ -72,7 +82,7 @@
 
 
 Step 3: create the portlet's display data
-.........................................
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The Hello portlet generates 'Hello world', but it is not the portlet's class
 itself that generates the data.
@@ -110,7 +120,7 @@
 
 
 Step 4: registrering the portlet
-................................
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 You now have all the components ready to be used. They still need to be
 registered in Zope3. This is done in ZCML using cpsskins directives.
@@ -194,7 +204,7 @@
 
 
 Step 5: testing the portlet
-...........................
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 You can now make sure that your portlet works as expected:
 
@@ -204,3 +214,4 @@
 
 c) a portlet displaying 'Hello world' will appear on the page!
 
+.. footer:: copyright 2005 - Nuxeo and Contributors
-- 
http://lists.nuxeo.com/mailman/listinfo/z3lab-checkins

Reply via email to