diff --git a/doc/form-view-guidelines.rst b/doc/form-view-guidelines.rst new file mode 100644 index 00000000000..f00fb005039 --- /dev/null +++ b/doc/form-view-guidelines.rst @@ -0,0 +1,299 @@ +.. _form-view-guidelines: + +Form Views Guidelines +===================== + +Authors: Aline Preillon, Raphael Collet + + +This document presents functional and technical guidelines for +creating/organizing form views in OpenERP version 7.0. For each item, both the +functional and technical aspects are explained. The goal of the new style of +forms is to make OpenERP easier to use, and to guide users through the system. + +Business Views +-------------- + +Business views are targeted at regular users, not advanced users. Examples +are: Opportunities, Products, Partners, Tasks, Projects, etc. + +oppreadonly.png + +In general, a business view is composed of + +1. a status bar on top (with technical or business flow), +2. a sheet in the middle (the form itself), +3. a bottom part with History and Comments. + +Technically, the new form views are structured as follows in XML:: + +
+
... content of the status bar ...
+ ... content of the sheet ... +
... content of the bottom part ...
+
+ +The Status Bar +'''''''''''''' + +The purpose of the status bar is to show the status of the record and the +action buttons, which were formerly at the bottom of form views. + +status.png + +The Buttons +........... + +The order of buttons follows the business flow. For instance, in a sale order, +the logical steps are: + +1. Send the quotation +2. Confirm the quotation +3. Create the final invoice +4. Send the goods + +Highlighted buttons (in red) emphasize the logical next step, to help the user. +It is usually the first active button. On the other end, cancel buttons must +remain grey (normal). For instance, in Invoice, the button “Refund” must never +be red. + +Technically, buttons are highlighted by adding the class “oe_highlight”:: + +