From 03e9a38a1d1586139d61b753ecfcf7373e6b1f2c Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Mon, 3 Nov 2014 17:31:54 +0100 Subject: [PATCH] [IMP] doc: remove guides section, move themes to tutorials and rest to reference also pass PNGs through crusher, turns out dot produces pretty terrible PNGs --- doc/guides.rst | 12 - doc/guides/deployment.rst | 5 - doc/guides/forms.rst | 327 ------------------ doc/guides/forms/header2.png | Bin 7379 -> 0 bytes doc/guides/snippets.rst | 3 - doc/guides/workflow/join.png | Bin 6835 -> 0 bytes doc/guides/workflow/order_0.png | Bin 16986 -> 0 bytes doc/guides/workflow/order_1.png | Bin 28452 -> 0 bytes doc/guides/workflow/split.png | Bin 6912 -> 0 bytes doc/{guides => howtos}/themes.rst | 0 doc/howtos/website.rst | 2 - doc/images/inheritance_methods.png | Bin 38431 -> 26704 bytes doc/images/view-on-github.png | Bin 1496 -> 1493 bytes doc/index.rst | 3 - doc/reference.rst | 1 + doc/{guides => reference}/forms/header.png | Bin doc/reference/forms/header2.png | Bin 0 -> 7059 bytes doc/{guides => reference}/forms/header3.png | Bin doc/{guides => reference}/forms/nosheet.png | Bin .../forms/oppreadonly.png | Bin .../forms/placeholder.png | Bin .../forms/screenshot-00.png | Bin .../forms/screenshot-01.png | Bin .../forms/screenshot-02.png | Bin .../forms/screenshot-03.png | Bin .../forms/screenshot-04.png | Bin doc/{guides => reference}/forms/sheet.png | Bin doc/{guides => reference}/forms/status.png | Bin doc/{guides => reference}/forms/status1.png | Bin doc/{guides => reference}/forms/status2.png | Bin .../forms/wizard-popup.png | Bin doc/reference/images/runner.png | Bin 3963 -> 3791 bytes doc/reference/images/runner2.png | Bin 6807 -> 6601 bytes doc/reference/images/tests.png | Bin 65388 -> 63426 bytes doc/reference/images/tests2.png | Bin 20114 -> 19446 bytes doc/reference/images/tests3.png | Bin 20382 -> 19698 bytes doc/reference/views.rst | 324 ++++++++++++++++- doc/{guides => reference}/workflow/Makefile | 0 doc/{guides => reference}/workflow/join.dot | 0 doc/reference/workflow/join.png | Bin 0 -> 2687 bytes doc/{guides => reference}/workflow/join.svg | 0 .../workflow/order_0.dot | 0 doc/reference/workflow/order_0.png | Bin 0 -> 12078 bytes .../workflow/order_0.svg | 0 .../workflow/order_1.dot | 0 doc/reference/workflow/order_1.png | Bin 0 -> 20662 bytes .../workflow/order_1.svg | 0 doc/{guides => reference}/workflow/split.dot | 0 doc/reference/workflow/split.png | Bin 0 -> 2694 bytes doc/{guides => reference}/workflow/split.svg | 0 doc/{guides => reference}/workflows.rst | 2 +- doc/tutorials.rst | 1 + 52 files changed, 322 insertions(+), 358 deletions(-) delete mode 100644 doc/guides.rst delete mode 100644 doc/guides/deployment.rst delete mode 100644 doc/guides/forms.rst delete mode 100644 doc/guides/forms/header2.png delete mode 100644 doc/guides/snippets.rst delete mode 100644 doc/guides/workflow/join.png delete mode 100644 doc/guides/workflow/order_0.png delete mode 100644 doc/guides/workflow/order_1.png delete mode 100644 doc/guides/workflow/split.png rename doc/{guides => howtos}/themes.rst (100%) rename doc/{guides => reference}/forms/header.png (100%) create mode 100644 doc/reference/forms/header2.png rename doc/{guides => reference}/forms/header3.png (100%) rename doc/{guides => reference}/forms/nosheet.png (100%) rename doc/{guides => reference}/forms/oppreadonly.png (100%) rename doc/{guides => reference}/forms/placeholder.png (100%) rename doc/{guides => reference}/forms/screenshot-00.png (100%) rename doc/{guides => reference}/forms/screenshot-01.png (100%) rename doc/{guides => reference}/forms/screenshot-02.png (100%) rename doc/{guides => reference}/forms/screenshot-03.png (100%) rename doc/{guides => reference}/forms/screenshot-04.png (100%) rename doc/{guides => reference}/forms/sheet.png (100%) rename doc/{guides => reference}/forms/status.png (100%) rename doc/{guides => reference}/forms/status1.png (100%) rename doc/{guides => reference}/forms/status2.png (100%) rename doc/{guides => reference}/forms/wizard-popup.png (100%) rename doc/{guides => reference}/workflow/Makefile (100%) rename doc/{guides => reference}/workflow/join.dot (100%) create mode 100644 doc/reference/workflow/join.png rename doc/{guides => reference}/workflow/join.svg (100%) rename doc/{guides => reference}/workflow/order_0.dot (100%) create mode 100644 doc/reference/workflow/order_0.png rename doc/{guides => reference}/workflow/order_0.svg (100%) rename doc/{guides => reference}/workflow/order_1.dot (100%) create mode 100644 doc/reference/workflow/order_1.png rename doc/{guides => reference}/workflow/order_1.svg (100%) rename doc/{guides => reference}/workflow/split.dot (100%) create mode 100644 doc/reference/workflow/split.png rename doc/{guides => reference}/workflow/split.svg (100%) rename doc/{guides => reference}/workflows.rst (99%) diff --git a/doc/guides.rst b/doc/guides.rst deleted file mode 100644 index 00fea8dd946..00000000000 --- a/doc/guides.rst +++ /dev/null @@ -1,12 +0,0 @@ -====== -Guides -====== - -.. toctree:: - :titlesonly: - - guides/forms - guides/themes - guides/snippets - guides/workflows - guides/deployment diff --git a/doc/guides/deployment.rst b/doc/guides/deployment.rst deleted file mode 100644 index 65b68fac7cb..00000000000 --- a/doc/guides/deployment.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _guides/deployment: - -======================= -Deploying to production -======================= diff --git a/doc/guides/forms.rst b/doc/guides/forms.rst deleted file mode 100644 index da09d634cd3..00000000000 --- a/doc/guides/forms.rst +++ /dev/null @@ -1,327 +0,0 @@ -.. 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":: - -