Author: jmorliaguet
Date: Wed Oct 26 00:39:30 2005
New Revision: 28640

Added:
   z3lab/z3ecm/trunk/src/ecm/cpsskins/example2/context-menu.png   (contents, 
props changed)
   z3lab/z3ecm/trunk/src/ecm/cpsskins/example2/edit-form.png   (contents, props 
changed)
   z3lab/z3ecm/trunk/src/ecm/cpsskins/example2/example2.png   (contents, props 
changed)
   z3lab/z3ecm/trunk/src/ecm/cpsskins/example2/field-hint.png   (contents, 
props changed)
Modified:
   z3lab/z3ecm/trunk/src/ecm/cpsskins/example2/README.txt
Log:

- saving work (added screenshots)



Modified: z3lab/z3ecm/trunk/src/ecm/cpsskins/example2/README.txt
==============================================================================
--- z3lab/z3ecm/trunk/src/ecm/cpsskins/example2/README.txt      (original)
+++ z3lab/z3ecm/trunk/src/ecm/cpsskins/example2/README.txt      Wed Oct 26 
00:39:30 2005
@@ -8,42 +8,46 @@
 :Version: $Revision: 1 $
 :Copyright: 2005 Nuxeo and Contributors.
 
+Prerequisites
+-------------
+
+You have read the 'example1' section of this tutorial.
+
 Description
 -----------
 
-The Text portlet displays some text specified by the user.
+The Text portlet is very similar to the Hello portlet. It only differs by the
+fact that instead of displaying the canonical 'Hello world' it can be used to
+display any portion of text or HTML.
 
-Prerequisites
--------------
+The text is entered by the user via the portlet edit form. The form can be
+opened by right-clicking on the portlet in page authoring mode and by selecting
+the 'Edit' menu item:
 
-You have read the 'example1' section of this tutorial.
+.. figure:: context-menu.png
 
+   fig. 1: The contextual menu on a portlet
 
-Steps in developing the Text portlet
--------------------------------------
 
-You may take a look the `<text.py>`_ file while going through the steps.
+Here is what the Text portlet edit form looks like:
 
+.. figure:: edit-form.png
 
-Step 1: defining the portlet's interface
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+   fig. 2: portlet edit form
 
-The Text portlet is very similar to the Hello portlet. It only differs by the
-fact that instead of displaying the canonical 'Hello world' it can be used to
-display any portion of text or HTML entered by the user.
 
-Portlets can be edited using an edit form. This is being done by
-right-clicking on the portlet in page authoring mode and by selecting the
-'Edit' menu item.
 
-The edit form looks like this::
+Steps in developing the Text portlet
+-------------------------------------
 
-.. edit-form.png
+You may take a look the `<text.py>`_ file while going through the steps.
 
-   The Text portlet's edit form.
 
+Step 1: defining the portlet's interface
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Here is a description of the steps needed to create such a form.
+Here is a description of the steps required to design the portlet's form with
+the text input area.
 
 Create an 'ITextPortlet' interface inheriting from IPortlet, and extend it
 with a Text schema field::
@@ -61,11 +65,11 @@
     ...         required=False)
 
 
-The 'text' field will refer to the text entered by the user. In the edit form
-it will be presented as a text input area, but remember that the schema field
-only defines the type of data not its presentation. However CPSSkins uses some
-of the information that you will specify to create a visual representation of
-the fields.
+The 'text' field will refer to the text displayed by the portlet. In the edit
+form it will be presented as a text input area, but remember that the schema
+field only defines the type of data not its presentation.
+However CPSSkins uses the information declared in the interface definition
+to create a visual representation of the fields.
 
 Here are the most common field options:
 
@@ -82,6 +86,10 @@
 [?] sign next to the field title, the user will see a hint window pop up
 containing the description (here: "Please enter some text.").
 
+.. figure:: field-hint.png
+
+   the title and the description view in the edit form
+
 required
 ~~~~~~~~
 If you set this option to True, the user will be asked to fill in a field 
value.
@@ -92,3 +100,47 @@
 zope/schema/README.txt in the Zope3 distribution.
 
 
+Step 2: defining the portlet's factory
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+TODO
+
+
+Step 3: creating the portlet's markup
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+TODO
+
+
+Step 4: registrering the portlet
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+TODO
+
+
+Step 5: testing the portlet
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can now make sure that your portlet works as expected:
+
+a) open the theme editor ('Page authoring' mode)
+
+b) drag the portlet with the '2' icon onto the canvas
+
+c) a portlet displaying 'Please enter some text' will appear on the page.
+
+d) right-click on the portlet and select the 'Edit' item.
+
+e) write some text or some HTML markup in the text field.
+
+f) click on "SAVE" and close the edit form.
+
+g) the canvas page will get reloaded and the text you have just entered will
+   be displayed on the canvas.
+
+
+.. figure:: example2.png
+
+   fig.4: The Text portlet displayed on the page canvas.
+
+.. footer:: copyright 2005 - Nuxeo and Contributors

Added: z3lab/z3ecm/trunk/src/ecm/cpsskins/example2/context-menu.png
==============================================================================
Binary file. No diff available.

Added: z3lab/z3ecm/trunk/src/ecm/cpsskins/example2/edit-form.png
==============================================================================
Binary file. No diff available.

Added: z3lab/z3ecm/trunk/src/ecm/cpsskins/example2/example2.png
==============================================================================
Binary file. No diff available.

Added: z3lab/z3ecm/trunk/src/ecm/cpsskins/example2/field-hint.png
==============================================================================
Binary file. No diff available.
-- 
http://lists.nuxeo.com/mailman/listinfo/z3lab-checkins

Reply via email to