--- a/doc/book/en/development/webstdlib/primary.rst Mon Apr 12 16:57:11 2010 +0200
+++ b/doc/book/en/development/webstdlib/primary.rst Mon Apr 12 19:36:51 2010 +0200
@@ -1,83 +1,45 @@
.. _primary:
-The default 'primary' view (:mod:`cubicweb.web.views.primary`)
+The Primary View (:mod:`cubicweb.web.views.primary`)
---------------------------------------------------------------
-The primary view of an entity is the view called by default when a single
-entity is in the result set and needs to be displayed.
-
-This view is supposed to render a maximum of informations about the entity.
+The primary view of an entity is the view called by default when a
+single entity is in the result set and needs to be displayed.
-Beware when overriding this top level `cell_call` in a primary because
-you will loose a bunch of functionnality that automatically comes with
-it : `in-context` boxes, related boxes, some navigation, some
-displaying of the metadata, etc. It might be interresting to
-understand the implementation fo the `cell_call` to override specifics
-bits of it.
+This view is supposed to render a maximum of informations about the
+entity.
Rendering methods and attributes for ``PrimaryView``
----------------------------------------------------
-By default, *CubicWeb* provides a primary view for every available
+By default, *CubicWeb* provides a primary view that fits every available
entity type. This is the first view you might be interested in
-modifying.
-
-Let's have a quick look at the EntityView ``PrimaryView`` as well as
-its rendering method
-
-.. sourcecode:: python
+modifying. It is also one of the richest and most complex.
- class PrimaryView(EntityView):
- """the full view of an non final entity"""
- __regid__ = 'primary'
- title = _('primary')
- show_attr_label = True
- show_rel_label = True
- skip_none = True
- rsection = uicfg.primaryview_section
- display_ctrl = uicfg.primaryview_display_ctrl
- main_related_section = True
+The basic layout of a primary view is as follows. This layout is
+actually set up by the `render_entity` method.
- ...
-
- def cell_call(self, row, col):
- self.row = row
- self.maxrelated = self._cw.property_value('navigation.related-limit')
- entity = self.complete_entity(row, col)
- self.render_entity(entity)
+.. aafig::
- def render_entity(self, entity):
- self.render_entity_title(entity)
- self.render_entity_metadata(entity)
- # entity's attributes and relations, excluding meta data
- # if the entity isn't meta itself
- boxes = self._prepare_side_boxes(entity)
- if boxes or hasattr(self, 'render_side_related'):
- self.w(u'<table width="100%"><tr><td style="width: 75%">')
- self.render_entity_summary(entity)
- self.w(u'<div class="mainInfo">')
- self.content_navigation_components('navcontenttop')
- self.render_entity_attributes(entity)
- if self.main_related_section:
- self.render_entity_relations(entity)
- self.w(u'</div>')
- # side boxes
- if boxes or hasattr(self, 'render_side_related'):
- self.w(u'</td><td>')
- self.w(u'<div class="primaryRight">')
- if hasattr(self, 'render_side_related'):
- warn('render_side_related is deprecated')
- self.render_side_related(entity, [])
- self.render_side_boxes(boxes)
- self.w(u'</div>')
- self.w(u'</td></tr></table>')
- self.content_navigation_components('navcontentbottom')
+ +------------------------------------+
+ |"content navigation (top)" |
+ +------------------------------------+
+ |"title, toolbox" |
+ +------------------------------------+
+ |"metadata" |
+ +----------------------+-------------+
+ |"attributes" |"side boxes" |
+ | | |
+ | | |
+ +----------------------+ |
+ |"relations" | |
+ | | |
+ | | |
+ +----------------------+-------------+
+ |"content navigation (bottom)" |
+ +------------------------------------+
- ...
-
-``cell_call`` is executed for each entity of a result set.
-
-The methods you want to modify while customizing a ``PrimaryView`` are:
+The methods you may want to modify while customizing a ``PrimaryView`` are:
*render_entity_title(self, entity)*
Renders the entity title based on the assumption that the method
@@ -92,23 +54,24 @@
attribute of type `Password` and `Bytes`. The skip_none class
attribute controls the display of None valued attributes.
-*content_navigation_components(self, context)*
- This method is applicable only for entity type implementing the interface
- `IPrevNext`. This interface is for entities which can be linked to a previous
- and/or next entity. This methods will render the navigation links between
- entities of this type, either at the top or at the bottom of the page
- given the context (navcontent{top|bottom}).
-
*render_entity_relations(self, entity)*
Renders all the relations of the entity in the main section of the page.
*render_side_boxes(self, entity, boxes)*
- Renders all the relations of the entity in a side box. This is equivalent
- to *render_entity_relations* in addition to render the relations
- in a box.
+ Renders relations of the entity in a side box.
+
+The placement of relations in the relations section or in side boxes
+can be controlled through the uicfg mechanism.
-Also, please note that by setting the following attributes in your class,
-you can already customize some of the rendering:
+*content_navigation_components(self, context)*
+ This method is applicable only for entity type implementing the interface
+ `IPrevNext`. This interface is for entities which can be linked to a previous
+ and/or next entity. This method will render the navigation links between
+ entities of this type, either at the top or at the bottom of the page
+ given the context (navcontent{top|bottom}).
+
+Also, please note that by setting the following attributes in your
+subclass, you can already customize some of the rendering:
*show_attr_label*
Renders the attribute label next to the attribute value if set to True.
@@ -126,8 +89,109 @@
A good practice is for you to identify the content of your entity type for which
the default rendering does not answer your need so that you can focus on the specific
-method (from the list above) that needs to be modified. We do not recommand you to
-overwrite ``render_entity`` as you might potentially loose the benefits of the side
-boxes handling.
+method (from the list above) that needs to be modified. We do not advise you to
+overwrite ``render_entity`` unless you want a completely different layout.
+
+Also, a lot of customisation can be achieved using the
+`primaryview_section` and `primaryview_display_ctrl` relation tags of
+the uicfg module.
+
+Primary view configuration
+``````````````````````````
+
+If you want to customize the primary view of an entity, overriding the primary
+view class may not be necessary. For simple adjustments (attributes or relations
+display locations and styles), a much simpler way is to use uicfg.
+
+Attributes/relations display location
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In the primary view, there are 3 sections where attributes and relations can be
+displayed (represented in pink in the image below):
+
+* attributes
+* relations
+* sideboxes
+
+.. image:: ../../images/primaryview_template.png
+
+
+**Attributes** can only be displayed in the attributes section (default
+ behavior). They can also be hidden.
+
+For instance, to hide the ``title`` attribute of the ``Blog`` entity:
+
+.. sourcecode:: python
+
+ from cubicweb.web import uicfg
+ uicfg.primaryview_section.tag_attribute(('Blog', 'title'), 'hidden')
+
+
+**Relations** can be either displayed in one of the three sections or hidden.
+
+For relations, there are two methods:
+
+* ``tag_object_of`` for modifying the primary view of the object
+* ``tag_subject_of`` for modifying the primary view of the subject
+
+These two methods take two arguments:
+
+* a triplet ``(subject, relation_name, object)``, where subject or object can be replaced with ``'*'``
+* the section name or ``hidden``
+
+.. sourcecode:: python
-.. XXX talk about uicfg.rdisplay
+ # hide every relation ``entry_of`` in the ``Blog`` primary view
+ uicfg.primaryview_section.tag_object_of(('*', 'entry_of', 'Blog'), 'hidden')
+
+ # display ``entry_of`` relations in the ``relations`` section in the ``BlogEntry`` primary view
+ uicfg.primaryview_section.tag_subject_of(('BlogEntry', 'entry_of', '*'),
+ 'relations')
+
+
+Display content
+^^^^^^^^^^^^^^^
+
+You can use ``primaryview_display_ctrl`` to customize the display of attributes
+or relations. Values of ``primaryview_display_ctrl`` are dictionaries.
+
+
+Common keys for attributes and relations are:
+* ``vid``: specifies the regid of the view for displaying the attribute or the relation.
+
+ If ``vid`` is not specified, the default value depends on the section:
+ * ``attributes`` section: 'reledit' view
+ * ``relations`` section: 'autolimited' view
+ * ``sideboxes`` section: 'sidebox' view
+
+* ``order``: int used to control order within a section. When not specified,
+ automatically set according to order in which tags are added.
+
+
+Keys for relations only:
+
+* ``label``: label for the relations section or side box
+
+* ``showlabel``: boolean telling whether the label is displayed
+
+* ``limit``: boolean telling if the results should be limited. If so, a link to all results is displayed
+
+* ``filter``: callback taking the related result set as argument and returning it filtered
+
+.. sourcecode:: python
+
+ # in ``CWUser`` primary view, display ``created_by`` relations in relations section
+ uicfg.primaryview_section.tag_object_of(('*', 'created_by', 'CWUser'), 'relations')
+
+ # displays this relation as a list, sets the label, limits the number of results and filters on comments
+ uicfg.primaryview_display_ctrl.tag_object_of(
+ ('*', 'created_by', 'CWUser'),
+ {'vid': 'list', 'label': _('latest comment(s):'), 'limit': True,
+ 'filter': lambda rset: rset.filtered_rset(lambda x: x.e_schema == 'Comment')})
+
+.. Warning:: with the ``primaryview_display_ctrl`` rtag, the subject or the
+ object of the relation is ignored for respectively ``tag_object_of`` or
+ ``tag_subject_of``. To avoid warnings during execution, they should be set to
+ ``'*'``.
+
+