[doc] Completed definition of content_navigation_components.
authorSandrine Ribeau <sandrine.ribeau@logilab.fr>
Tue, 21 Apr 2009 20:13:03 -0700
changeset 1418 71807bfd14c1
parent 1413 ad19d7e6a291
child 1428 e3a2c31ae897
[doc] Completed definition of content_navigation_components.
doc/book/en/B1020-define-views.en.txt
--- a/doc/book/en/B1020-define-views.en.txt	Tue Apr 21 12:08:31 2009 +0200
+++ b/doc/book/en/B1020-define-views.en.txt	Tue Apr 21 20:13:03 2009 -0700
@@ -220,12 +220,19 @@
     of type `Password` and `Bytes`.
 
 *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, siderelations)*
-    Renders all the relations of the entity.
+    Renders all the relations of the entity in the main section of the page.
         
 *render_side_related(self, entity, siderelations)*
-    Renders side related relations.
+    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.
 
 Also, please note that by setting the following attributes in you class,
 you can already customize some of the rendering: