[Checkins] SVN: Products.CMFDefault/trunk/Products/CMFDefault/browser/ Documentation updated.

Charlie Clark cvs-admin at zope.org
Mon Apr 9 17:15:09 UTC 2012


Log message for revision 125123:
  Documentation updated.
  

Changed:
  U   Products.CMFDefault/trunk/Products/CMFDefault/browser/README.txt
  U   Products.CMFDefault/trunk/Products/CMFDefault/browser/content/TODO.txt
  U   Products.CMFDefault/trunk/Products/CMFDefault/browser/membership/TODO.txt
  U   Products.CMFDefault/trunk/Products/CMFDefault/browser/search/TODO.txt
  U   Products.CMFDefault/trunk/Products/CMFDefault/browser/skins/icons.txt
  U   Products.CMFDefault/trunk/Products/CMFDefault/browser/workflow/TODO.txt

-=-
Modified: Products.CMFDefault/trunk/Products/CMFDefault/browser/README.txt
===================================================================
--- Products.CMFDefault/trunk/Products/CMFDefault/browser/README.txt	2012-04-09 16:51:43 UTC (rev 125122)
+++ Products.CMFDefault/trunk/Products/CMFDefault/browser/README.txt	2012-04-09 17:15:05 UTC (rev 125123)
@@ -1,17 +1,25 @@
-Experimental Browser Views
+Browser Views
+=============
 
-  This sub-package provides Zope 3-style browser views for some CMF content
-  interfaces. These views are not used by the default profile.
+This sub-package provides browser views for all CMF content, generic and
+control scripts and templates. Unlike PythonScripts browser views have no
+restrictions on the Python modules used. As views are not checked each time
+they run, they can be faster the PythonScripts. The "ursa globals" are good a
+example of this.
 
-  The content of this sub-package is experimental and might be refactored
-  without further notice. Documentation and unittests are still missing but
-  the views should work just as well as the corresponding skin methods.
+These views are not used by the default profile.
 
-  See TODO.txt for a detailed list of converted skin methods.
+Documentation is still missing but the most views have unit and functional
+tests and should work just as well as the corresponding skin methods. The
+URLs are mapped using the ActionsTool.
 
-  Using the Browser Views
+See TODO.txt in each folder for a detailed list of converted skin methods.
 
-    In an un-customized CMFDefault site you will notice no difference because
-    the browser views are just different in implementation, not in look and
-    feel. But the browser view machinery bypasses the CMF skin machinery, so
-    you will notice that TTW customizations no longer have any effect.
+Using the Browser Views
+-----------------------
+
+In an un-customized CMFDefault site you will notice almost no difference
+because the browser views are just different in implementation, not in look
+and feel. But the browser view machinery lagrely bypasses the CMF skin
+machinery, so you will notice that TTW customizations no longer have any
+effect. A site's "main_template" can still be customized.

Modified: Products.CMFDefault/trunk/Products/CMFDefault/browser/content/TODO.txt
===================================================================
--- Products.CMFDefault/trunk/Products/CMFDefault/browser/content/TODO.txt	2012-04-09 16:51:43 UTC (rev 125122)
+++ Products.CMFDefault/trunk/Products/CMFDefault/browser/content/TODO.txt	2012-04-09 17:15:05 UTC (rev 125123)
@@ -103,6 +103,3 @@
 
       RSS.py -> rss.View
       RSS_template.pt -> rss.pt
-
-
-  [ ] complete this todo list

Modified: Products.CMFDefault/trunk/Products/CMFDefault/browser/membership/TODO.txt
===================================================================
--- Products.CMFDefault/trunk/Products/CMFDefault/browser/membership/TODO.txt	2012-04-09 16:51:43 UTC (rev 125122)
+++ Products.CMFDefault/trunk/Products/CMFDefault/browser/membership/TODO.txt	2012-04-09 17:15:05 UTC (rev 125123)
@@ -35,11 +35,11 @@
       password_form_template.pt -> formlib based
       change_password.py -> formlib based
 
-  [ ] member roster:
-      
+  [x] member roster:
+
       roster.pt -> members.Roster
                    members_list.pt
-      
+
       members_manage_form.py -> members.Manage
       members_manage_template.pt -> members.pt
       members_add_control.py
@@ -47,5 +47,3 @@
       members_delete_form.py -> members.Manage
       members_delete_template_template.py -> members_delete.pt
 
-
-  [ ] complete this todo list

Modified: Products.CMFDefault/trunk/Products/CMFDefault/browser/search/TODO.txt
===================================================================
--- Products.CMFDefault/trunk/Products/CMFDefault/browser/search/TODO.txt	2012-04-09 16:51:43 UTC (rev 125122)
+++ Products.CMFDefault/trunk/Products/CMFDefault/browser/search/TODO.txt	2012-04-09 17:15:05 UTC (rev 125123)
@@ -1,7 +1,7 @@
 Search Views
 ------------
+  [x] search:
 
-search.py
-search_form.py
-search_form_template.pt
-search_results_template.pt
+      search.py, search_form.py  -> search.py.Search
+      search_form_template.pt -> search.pt
+      search_results_template.pt -> results.pt

Modified: Products.CMFDefault/trunk/Products/CMFDefault/browser/skins/icons.txt
===================================================================
--- Products.CMFDefault/trunk/Products/CMFDefault/browser/skins/icons.txt	2012-04-09 16:51:43 UTC (rev 125122)
+++ Products.CMFDefault/trunk/Products/CMFDefault/browser/skins/icons.txt	2012-04-09 17:15:05 UTC (rev 125123)
@@ -1,30 +1,45 @@
 Introduction
-------------
+============
 
-The icons.css view currently runs on every request and depending on the status of the user delivers different results rather than just one of two sets - with action icons enabled; with them disabled. Apart from straight performance issues this also means caching may fail.
+The icons.css view currently runs on every request and depending on the
+status of the user delivers different results rather than just one of two
+sets - with action icons enabled; with them disabled. Apart from straight
+performance issues this also means caching may fail.
 
 Possible improvements
-=====================
+---------------------
 
-    * icon discovery independent of user status
+* icon discovery independent of user status
 
-    * local serialisation of the two sets using either an adapter or, preferably a local utility
+* local serialisation of the two sets using either an adapter or,
+preferably a local utility
 
-    * sprites
+* sprites
 
 Independent icon discovery
-==========================
+--------------------------
+
 An adapter for ActionsTool to provide listUnfilteredActions()
 
 Local serialisation
-===================
+-------------------
 
-Any form of serialisation probably needs to be triggered by IActionInfoModified() events.
+Any form of serialisation probably needs to be triggered by
+IActionInfoModified() events.
 
 Sprites
-=======
-Conversion of icons to sprite sets would significantly improve load times with action icons enabled as it would reduce the number of requests significantly. However, there is currently no easy integration of sprites with ActionInfo items. Implementing sprite management might be useful but is possibly out of scope for CMFDefault. A demonstration using a proxy which can work with icon expression objects and prepared sprite sets
+-------
 
+Conversion of icons to sprite sets would significantly improve load times
+with action icons enabled as it would reduce the number of requests
+significantly. However, there is currently no easy integration of sprites
+with ActionInfo items. Implementing sprite management might be useful but is
+possibly out of scope for CMFDefault. A demonstration using a proxy which can
+work with icon expression objects and prepared sprite sets
+
 Integration
-============
-The icons.css is currently only used by main_template to render user actions. It is difficult to add support for it elsewhere such as folder views without adding Zope 3 style skins.
+-----------
+
+The icons.css is currently only used by main_template to render user actions.
+It is difficult to add support for it elsewhere such as folder views without
+adding Zope 3 style skins.

Modified: Products.CMFDefault/trunk/Products/CMFDefault/browser/workflow/TODO.txt
===================================================================
--- Products.CMFDefault/trunk/Products/CMFDefault/browser/workflow/TODO.txt	2012-04-09 16:51:43 UTC (rev 125122)
+++ Products.CMFDefault/trunk/Products/CMFDefault/browser/workflow/TODO.txt	2012-04-09 17:15:05 UTC (rev 125123)
@@ -1,8 +1,8 @@
 Workflow Views
---------------
+==============
 
 Do Workflow
-===========
+-----------
 
  [X] IWorkflowAware @@submit.html
      content_status_modify.py -> workflow.Submit
@@ -15,7 +15,6 @@
  [X] IWorkflowAware @@publish.html
      content_publish_form.pt -> publish.pt
 
-
  [X] IWorkflowAware @@reject.html
      content_reject_form.pt -> reject.pt
 
@@ -25,11 +24,12 @@
  [X] IWorkflowAware @@show.html
      content_show_form.pt -> show.pt
 
- [ ] rejectItems.py
- [ ] review.pt
+ [x] IWorkflowAware@@reject.html
+ [x] review.pt -> reject.pt
 
 View Workflow History
-=====================
+---------------------
+
  [X] IWorkflowAware @@history.html
  content_status_history.pt -> history.View
                               history.pt



More information about the checkins mailing list