fix/enhance baseview doc
authorSylvain Thénault <sylvain.thenault@logilab.fr>
Fri, 24 Jul 2009 13:04:44 +0200
changeset 2474 23e8aa37b2df
parent 2473 490f88fb99b6
child 2475 b6753521129d
fix/enhance baseview doc
doc/book/en/development/webstdlib/baseviews.rst
--- a/doc/book/en/development/webstdlib/baseviews.rst	Fri Jul 24 12:47:47 2009 +0200
+++ b/doc/book/en/development/webstdlib/baseviews.rst	Fri Jul 24 13:04:44 2009 +0200
@@ -12,33 +12,6 @@
 
 HTML views
 ~~~~~~~~~~
-*oneline*
-    This is a hyper linked *text* view. Similar to the `secondary` view,
-    but called when we want the view to stand on a single line, or just
-    get a brief view. By default this view uses the
-    parameter `MAX_LINE_CHAR` to control the result size.
-
-*secondary*
-    This is a combinaison of an icon and a *oneline* view.
-    By default it renders the two first attributes of the entity as a
-    clickable link redirecting to the primary view.
-
-*incontext, outofcontext*
-    Similar to the `secondary` view, but called when an entity is considered
-    as in or out of context. By default it respectively returns the result of
-    `textincontext` and `textoutofcontext` wrapped in a link leading to
-    the primary view of the entity.
-
-List
-`````
-*list*
-    This view displays a list of entities by creating a HTML list (`<ul>`)
-    and call the view `listitem` for each entity of the result set.
-
-*listitem*
-    This view redirects by default to the `outofcontext` view.
-
-
 Special views
 `````````````
 
@@ -54,11 +27,41 @@
     This view is the default view used when nothing needs to be rendered.
     It is always applicable and it does not return anything
 
-Text views
-~~~~~~~~~~
+Entity views
+````````````
+*incontext, outofcontext*
+    Those are used to display a link to an entity, depending if the entity is
+    considered as displayed in or out of context (of another entity).  By default
+    it respectively returns the result of `textincontext` and `textoutofcontext`
+    wrapped in a link leading to the primary view of the entity.
+
+*oneline*
+    This view is used when we can't tell if the entity should be considered as
+    displayed in or out of context.  By default it returns the result of `text`
+    in a link leading to the primary view of the entity.
+
+List
+`````
+*list*
+    This view displays a list of entities by creating a HTML list (`<ul>`)
+    and call the view `listitem` for each entity of the result set.
+
+*listitem*
+    This view redirects by default to the `outofcontext` view.
+
+*adaptedlist*
+    This view displays a list of entities of the same type, in HTML section (`<div>`)
+    and call the view `adaptedlistitem` for each entity of the result set.
+
+*adaptedlistitem*
+    This view redirects by default to the `outofcontext` view.
+
+Text entity views
+~~~~~~~~~~~~~~~~~
 *text*
-    This is the simplest text view for an entity. It displays the
-    title of an entity. It should not contain HTML.
+    This is the simplest text view for an entity. By default it returns the
+    result of the `.dc_title` method, which is cut to fit the
+    `navigation.short-line-size` property if necessary.
 
 *textincontext, textoutofcontext*
     Similar to the `text` view, but called when an entity is considered out or