Author: jmorliaguet
Date: Tue Dec 13 01:47:39 2005
New Revision: 2024

Modified:
   cpsskins/branches/jmo-perspectives/io/README.txt
Log:

- more consistent model for classifying resources



Modified: cpsskins/branches/jmo-perspectives/io/README.txt
==============================================================================
--- cpsskins/branches/jmo-perspectives/io/README.txt    (original)
+++ cpsskins/branches/jmo-perspectives/io/README.txt    Tue Dec 13 01:47:39 2005
@@ -11,21 +11,25 @@
 combination of element, resource and content types.
 
 
-Types
-=====
+Classification of resources
+===========================
 
-There are three main types:
+Resources are classified according to their "element type", "resource type"
+and "content type".
 
-Element type
-------------
 
-Element types define a first-level categorization of resources:
+1) Element types
+----------------
+
+Element types provide a first-level categorization of resources.
 
 - portlet
 
+- display
+
 - format
 
-- theme, themepage, pageblock, cell, slot
+- canvas
 
 - perspective
 
@@ -37,69 +41,66 @@
 The element name of a given resource is obtained from the "IElementType"
 interface:
 
-  element_type = queryType(resource, IElementType)
-  name = element_type.getTaggedValue('name')
+    >>> element_type = queryType(resource, IElementType)
+    >>> name = element_type.getTaggedValue('name')
 
 or:
 
-  name = resource.elementname
+    >>> name = resource.elementname
 
 
-Resource type
--------------
+2) Resource types
+-----------------
 
-Resource types are a second-level categorization of resources:
+Resource types provide a second-level categorization of resources.
 
 - displays: box, area, boxgroup
 
 - formats: widget, style, effect, layout, ...
 
-The resource type is identical to the element type for resources that have no
-second-level type of categorization (portlet, perpective, theme, engine, ...)
-
 The resource name of a given resource is obtained from the "IResourceType"
 interface:
 
-  resource_type = queryType(resource, IResourceType)
-  name = resource_type.getTaggedValue('name')
+    >>> resource_type = queryType(resource, IResourceType)
+    >>> name = resource_type.getTaggedValue('name')
 
 or:
 
-  name = resource.resourcename
+    >>> name = resource.resourcename
 
 
-Content type
-------------
+3) Content types
+----------------
 
-Content types are unique factory names. They contain a provider and a factory
-name.
+Content types provide a third-level categorization of resources.
+Typically they are third-party resources.
 
 - cpsskins.actions, cpsskins.breadcrumbs, ...
 
-- cpsskins.vertical_menu, cpsskins.plain_html
-
-Content type names are unique for a given resource type.
+The content type is identical to the resource type for resources that have no
+third-level type of categorization (i.e. perpective, theme, ...)
 
 
 The content name of a given resource is obtained from the "IContentType"
 interface:
 
-  content_type = queryType(resource, IContentType)
-  name = content_type.getTaggedValue('name')
+    >>> content_type = queryType(resource, IContentType)
+    >>> name = content_type.getTaggedValue('name')
 
 or:
 
-  name = resource.contentname
+    >>> name = resource.contentname
 
 
-URI
----
+Combinations
+------------
 
-To identify resources a URI (Uniform Resource Identifier) is used
+URI
+~~~
 
+To identify resources a URI (Uniform Resource Identifier) is used.
 A URI consists of a prefix and a suffix separated by a '.' character.
-
-The prefix is the resource name described above.
+The prefix is the *resource name* described above.
 The suffix identifies the resource inside the namespace.
 
 For instance a portlet will be identified as:
@@ -107,3 +108,18 @@
   portlet.123456
 
 
+elementname + resourcename
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Example:
+
+  format.style, format.widget
+
+
+elementname + contentname
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Example:
+
+  portlet.cpsskins.actions, canvas.slot
+
-- 
http://lists.nuxeo.com/mailman/listinfo/z3lab-checkins

Reply via email to