diff --git a/doc/03_module_dev.rst b/doc/03_module_dev.rst index 72f035be4d0..c5f965e4b93 100644 --- a/doc/03_module_dev.rst +++ b/doc/03_module_dev.rst @@ -13,3 +13,4 @@ Modules 03_module_dev_04 03_module_dev_05 03_module_dev_06 + report-declaration diff --git a/doc/changelog.rst b/doc/changelog.rst index c85bf64273f..59c4a6bced5 100644 --- a/doc/changelog.rst +++ b/doc/changelog.rst @@ -6,6 +6,9 @@ Changelog `trunk` ------- +- Almost removed ``LocalService()``. For reports, + ``openerp.osv.orm.Model.print_report()`` can be used. For workflows, see + :ref:`orm-workflows`. - Removed support for the ``NET-RPC`` protocol. - Added the :ref:`Long polling ` worker type. - Added :ref:`orm-workflows` to the ORM. diff --git a/doc/form-view-guidelines.rst b/doc/form-view-guidelines.rst new file mode 100644 index 00000000000..ceec973682c --- /dev/null +++ b/doc/form-view-guidelines.rst @@ -0,0 +1,303 @@ +.. _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. + +.. image:: /form-view-guidelines/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. + +.. image:: /form-view-guidelines/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”:: + +