diff -r 87c8d96f6173 -r 2d9e83c34b23 doc/book/en/B1021-views-stdlib.en.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/book/en/B1021-views-stdlib.en.txt Tue Dec 23 13:50:56 2008 -0800 @@ -0,0 +1,65 @@ +.. -*- coding: utf-8 -*- + +Predefined views in the library +------------------------------- + +A certain number of views are used to build the web interface, which apply +to one or more entities. Their identifier is what distinguish them from +each others and the main ones are: + +:primary: + primary view of an entity, this 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. +:secondary: + secondary view of an entity. By default it renders the two first attributes + of the entity as a clickable link redirecting to the primary view. +:oneline: + 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. +:text: + similar to the `oneline` view, but should not contain HTML. +: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. +:textincontext, textoutofcontext: + similar to the `text` view, but called is an entity is considered out or + in context. By default it returns respectively the result of the + methods `.dc_title` and `.dc_long_title` of the entity. +:list: + creates a HTML list (`