Author: jmorliaguet
Date: Thu Apr 13 15:44:55 2006
New Revision: 2833

Modified:
   cpsskins/branches/jmo-perspectives/doc/portlet-rendering.txt
Log:

- doc update



Modified: cpsskins/branches/jmo-perspectives/doc/portlet-rendering.txt
==============================================================================
--- cpsskins/branches/jmo-perspectives/doc/portlet-rendering.txt        
(original)
+++ cpsskins/branches/jmo-perspectives/doc/portlet-rendering.txt        Thu Apr 
13 15:44:55 2006
@@ -73,7 +73,7 @@
     >>> from cpsskins.standard.ds.menuitems import MenuItems
     >>> from cpsskins.standard.ds.menuitem import MenuItem
 
-We instanciate a Breadcrumbs Portlet:
+Let us instanciate a Breadcrumbs Portlet:
 
     >>> from cpsskins.standard.portlets.breadcrumbs.portlet import Breadcrumbs
     >>> portlet = Breadcrumbs()
@@ -91,7 +91,7 @@
     >>> isinstance(info.data, MenuItems)
     True
 
-let us see what is inside the MenuItems structure:
+let us see what the MenuItems structure now contains:
 
     >>> pprint(info.data())
     [<Menu item ''>]
@@ -118,7 +118,8 @@
     [<Menu item 'Item 1'>]
 
 
-Structured content cannot be rendered directly in a browser.
+But structured content cannot be rendered directly in a browser.
+
 We will see how structured data gets tranformed into HTML with help of
 *widgets*.
 
@@ -142,7 +143,7 @@
 Displaying portlets
 ===================
 
-The data provided by portlets is displayed in Display Elements (e.g. a Box),
+The data provided by portlets is displayed in *Display Elements* (e.g. a Box),
 which represents the fragment of the page in which the portlet will appear.
 
     >>> from zope.interface.verify import verifyClass
@@ -154,7 +155,11 @@
 A same portlet can be displayed in different Display Elements depending on the
 context.
 
-The Box and its content is formatted with a *widget* (a Format Element):
+Provided that the portlet is associated with a given Box, the Box is in turn
+associated with various Format Element (style, effects, ...) whose
+responsibility in the rendering chain is to format elements.
+
+The type of Format that interests us here is the *widget* Format.
 
     >>> from cpsskins.standard.formats.widget import Widget
     >>> from cpsskins.elements.interfaces import IFormat
@@ -162,7 +167,7 @@
     True
 
 The job of the widget is to convert structured data into HTML, or to format the
-HTML markup that it received.
+HTML markup that it receives from the portlet.
 
 A list of widget names can be specified, i.e. if the first widget cannot
 render the data, the next widget will be used, etc. until a suitable widget
@@ -171,10 +176,11 @@
     >>> widget = Widget([u'standard.special_widget', u'standard.plain_html'])
 
 As a last resort the *basic widget view* registered by default for the given
-data type will be used. It will provide minimal formatting.
+data type will be used. It will provide a very minimal formatting but it will
+be able to convert the data structure into HTML.
 
-Note that the widget format describe here does not directly produce any HTML
-output it only specifies which widget view to use. Also it is the object that
+Note that the widget format described here does not directly produce any HTML
+output. It only specifies which widget view to use. Also it is the object that
 the user can interact with.
 
 The portlet is rendered with a widget view (called a 'filter' in the rendering
-- 
http://lists.nuxeo.com/mailman/listinfo/z3lab-checkins

Reply via email to