From 442dec24966acaaaf1460f981227c44e65f1fe7f Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Mon, 25 Aug 2014 13:48:34 +0200 Subject: [PATCH] [ADD] reinstate form guidelines --- doc/guides.rst | 1 + doc/guides/forms.rst | 327 +++++++++++++++++++++++++++++ doc/guides/forms/header.png | Bin 0 -> 4099 bytes doc/guides/forms/header2.png | Bin 0 -> 7379 bytes doc/guides/forms/header3.png | Bin 0 -> 8661 bytes doc/guides/forms/nosheet.png | Bin 0 -> 13630 bytes doc/guides/forms/oppreadonly.png | Bin 0 -> 51033 bytes doc/guides/forms/placeholder.png | Bin 0 -> 5422 bytes doc/guides/forms/screenshot-00.png | Bin 0 -> 15903 bytes doc/guides/forms/screenshot-01.png | Bin 0 -> 2936 bytes doc/guides/forms/screenshot-02.png | Bin 0 -> 20109 bytes doc/guides/forms/screenshot-03.png | Bin 0 -> 3805 bytes doc/guides/forms/screenshot-04.png | Bin 0 -> 2876 bytes doc/guides/forms/sheet.png | Bin 0 -> 25000 bytes doc/guides/forms/status.png | Bin 0 -> 8995 bytes doc/guides/forms/status1.png | Bin 0 -> 4373 bytes doc/guides/forms/status2.png | Bin 0 -> 4419 bytes doc/guides/forms/wizard-popup.png | Bin 0 -> 12028 bytes doc/reference/views.rst | 2 + 19 files changed, 330 insertions(+) create mode 100644 doc/guides/forms.rst create mode 100644 doc/guides/forms/header.png create mode 100644 doc/guides/forms/header2.png create mode 100644 doc/guides/forms/header3.png create mode 100644 doc/guides/forms/nosheet.png create mode 100644 doc/guides/forms/oppreadonly.png create mode 100644 doc/guides/forms/placeholder.png create mode 100644 doc/guides/forms/screenshot-00.png create mode 100644 doc/guides/forms/screenshot-01.png create mode 100644 doc/guides/forms/screenshot-02.png create mode 100644 doc/guides/forms/screenshot-03.png create mode 100644 doc/guides/forms/screenshot-04.png create mode 100644 doc/guides/forms/sheet.png create mode 100644 doc/guides/forms/status.png create mode 100644 doc/guides/forms/status1.png create mode 100644 doc/guides/forms/status2.png create mode 100644 doc/guides/forms/wizard-popup.png diff --git a/doc/guides.rst b/doc/guides.rst index 6e89eff9631..00fea8dd946 100644 --- a/doc/guides.rst +++ b/doc/guides.rst @@ -5,6 +5,7 @@ Guides .. toctree:: :titlesonly: + guides/forms guides/themes guides/snippets guides/workflows diff --git a/doc/guides/forms.rst b/doc/guides/forms.rst new file mode 100644 index 00000000000..da09d634cd3 --- /dev/null +++ b/doc/guides/forms.rst @@ -0,0 +1,327 @@ +.. highlight:: xml + +.. _form-view-guidelines: + +Form Views Guidelines +===================== + +.. sectionauthor:: Aline Preillon, Raphael Collet + +This document presents functional and technical guidelines for +creating/organizing form views in Odoo. For each item, both the functional and +technical aspects are explained. The goal of the new style of forms is to make +Odoo 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:: forms/oppreadonly.png + :class: img-responsive + +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 current record and +the action buttons. + +.. image:: forms/status.png + :class: img-responsive + +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 by default) emphasize the logical next step, to +help the user. It is usually the first active button. On the other hand, +:guilabel:`cancel` buttons *must* remain grey (normal). For instance, in +Invoice the button :guilabel:`Refund` must never be red. + +Technically, buttons are highlighted by adding the class "oe_highlight":: + +