diff --git a/content/administration/odoo_sh/getting_started/first_module.rst b/content/administration/odoo_sh/getting_started/first_module.rst index 3499306fe..25c6dd1d6 100644 --- a/content/administration/odoo_sh/getting_started/first_module.rst +++ b/content/administration/odoo_sh/getting_started/first_module.rst @@ -146,7 +146,7 @@ Manually -------- If you want to create your module structure manually, -you can follow the :doc:`/developer/tutorials/getting_started` tutorial to understand +you can follow the :doc:`/developer/tutorials/server_framework_101` tutorial to understand the structure of a module and the content of each file. Push the development branch diff --git a/content/administration/on_premise/source.rst b/content/administration/on_premise/source.rst index e3d3a884d..e5fadc90d 100644 --- a/content/administration/on_premise/source.rst +++ b/content/administration/on_premise/source.rst @@ -45,7 +45,7 @@ Git To clone a Git repository, choose between cloning with HTTPS or SSH. In most cases, the best option is HTTPS. However, choose SSH to contribute to Odoo source code or when following the :doc:`Getting -Started developer tutorial `. +Started developer tutorial `. .. tabs:: diff --git a/content/contributing.rst b/content/contributing.rst index 3f9533401..dc141711f 100644 --- a/content/contributing.rst +++ b/content/contributing.rst @@ -48,7 +48,8 @@ lists the most important of them. pull requests from other contributors. By contributing to the codebase, you can make a direct and lasting impact on the quality and features of Odoo. - * :doc:`Guide: Contributing to the codebase ` - * :doc:`Developer tutorials ` + * :doc:`Developer tutorials ` + * :doc:`How-to guides ` - Developers with experience in Python and web development * - Contribute to the documentation - Submit corrections and improvements to the Odoo documentation. The product evolves fast, and diff --git a/content/developer.rst b/content/developer.rst index 84002fbfa..3a8825dcc 100644 --- a/content/developer.rst +++ b/content/developer.rst @@ -1,20 +1,47 @@ -:nosearch: :show-content: :hide-page-toc: -:show-toc: - ========= Developer ========= -Learn through tutorials and get help using reference guides. - - .. toctree:: - :titlesonly: - :maxdepth: 3 + developer/tutorials + developer/howtos + developer/reference - developer/tutorials - developer/howtos - developer/reference +Welcome to the developer documentation of Odoo! Whether you're a seasoned developer or just getting +started, you'll find here all the technical guidance and resources you need for developing Odoo +applications. Explore our extensive collection of tutorials, how-to guides, and reference materials +to achieve your development goals. + +The Odoo development ecosystem is built on a modular and extensible architecture that allows you +to extend existing applications or create new ones to meet the specific needs of modern businesses. +You can make use of the tools and frameworks provided by Odoo to focus on getting your web +application up and running quickly, without needing to reinvent the wheel and worry about the +underlying infrastructure. + +If you are new to Odoo or web application development, start with the +:doc:`developer/tutorials/server_framework_101` tutorial. + +.. cards:: + + .. card:: Tutorials + :target: developer/tutorials + + Tutorials take you by the hand through hands-on exercises to build skills and familiarity in + Odoo development. + + .. card:: How-to guides + :target: developer/howtos + + Recipes that provide a step-by-step guide for addressing real-world problems and use-cases. + + .. card:: Reference + :target: developer/reference + + Technical descriptions and factual information on the frameworks and APIs of Odoo. + +.. seealso:: + - :doc:`Guide: Contribute to the codebase ` + - `Community forums `_ diff --git a/content/developer/howtos.rst b/content/developer/howtos.rst index a25ab7d3d..f9a14f24e 100644 --- a/content/developer/howtos.rst +++ b/content/developer/howtos.rst @@ -6,22 +6,25 @@ How-to guides ============= .. toctree:: - :titlesonly: + howtos/scss_tips + howtos/javascript_field + howtos/javascript_view + howtos/javascript_client_action + howtos/standalone_owl_application + howtos/frontend_owl_components + howtos/website_themes - howtos/scss_tips - howtos/javascript_field - howtos/javascript_view - howtos/javascript_client_action - howtos/standalone_owl_application - howtos/frontend_owl_components - howtos/web_services - howtos/company - howtos/create_reports - howtos/accounting_localization - howtos/translations - howtos/website_themes - howtos/connect_device - howtos/upgrade_custom_db + howtos/web_services + howtos/company + howtos/create_reports + howtos/accounting_localization + howtos/translations + howtos/connect_device + + howtos/upgrade_custom_db + +Frontend development +==================== .. cards:: @@ -33,29 +36,39 @@ How-to guides .. card:: Customize a field :target: howtos/javascript_field - Learn how to customize field components in the Odoo JavaScript web framework. + Learn how to customize field components in the web framework. .. card:: Customize a view type :target: howtos/javascript_view - Learn how to customize view types in the Odoo JavaScript web framework. + Learn how to customize view types in the web framework. .. card:: Create a client action :target: howtos/javascript_client_action - Learn how to create client actions in the Odoo JavaScript web framework. + Learn how to create client actions in the web framework. .. card:: Create a standalone Owl application :target: howtos/standalone_owl_application Learn how to create a public-facing Owl application outside of the web client using a - controller and the Odoo JavaScript framework. + controller and the web framework. .. card:: Use Owl components on the portal and website :target: howtos/frontend_owl_components Learn how to use Owl components on the portal and website. + .. card:: Website themes + :target: howtos/website_themes + + Learn how to customize your website by creating a custom theme. + +Server-side development +======================= + +.. cards:: + .. card:: Web services :target: howtos/web_services @@ -82,17 +95,18 @@ How-to guides Learn how to provide translation abilities to your module. - .. card:: Website themes - :target: howtos/website_themes - - Learn how to customize your website by creating a custom theme. - .. card:: Connect with a device :target: howtos/connect_device Learn how to enable a module to detect and communicate with an IoT device. +Custom development +================== + +.. cards:: + .. card:: Upgrade a customized database :target: howtos/upgrade_custom_db - Learn how to upgrade a customized database, as well as the code and data of its custom modules. + Learn how to upgrade a customized database, as well as the code and data of its custom + modules. diff --git a/content/developer/howtos/accounting_localization.rst b/content/developer/howtos/accounting_localization.rst index 2b8d3ac0c..2b029678f 100644 --- a/content/developer/howtos/accounting_localization.rst +++ b/content/developer/howtos/accounting_localization.rst @@ -6,7 +6,7 @@ Accounting localization .. warning:: This tutorial requires knowledge about how to build a module in Odoo (see - :doc:`../tutorials/getting_started`). + :doc:`../tutorials/server_framework_101`). Installation procedure diff --git a/content/developer/howtos/company.rst b/content/developer/howtos/company.rst index b8f10480c..d6c6f7a08 100644 --- a/content/developer/howtos/company.rst +++ b/content/developer/howtos/company.rst @@ -8,7 +8,7 @@ Multi-company Guidelines .. warning:: This tutorial requires good knowledge of Odoo. - Please refer to the :doc:`../tutorials/getting_started` tutorial first if needed. + Please refer to the :doc:`../tutorials/server_framework_101` tutorial first if needed. As of version 13.0, a user can be logged in to multiple companies at once. This allows the user to access information from multiple companies, but also to create/edit records in a multi-company diff --git a/content/developer/reference.rst b/content/developer/reference.rst index 48c56b2d8..a8b0c34b4 100644 --- a/content/developer/reference.rst +++ b/content/developer/reference.rst @@ -1,18 +1,21 @@ :nosearch: +:show-content: +:show-toc: +:hide-page-toc: ========= Reference ========= .. toctree:: - :titlesonly: + :maxdepth: 3 - reference/backend - reference/frontend - reference/user_interface - reference/standard_modules - reference/cli - reference/upgrade_scripts - reference/upgrade_utils - reference/external_api - reference/extract_api + reference/backend + reference/frontend + reference/user_interface + reference/standard_modules + reference/cli + reference/upgrade_scripts + reference/upgrade_utils + reference/external_api + reference/extract_api diff --git a/content/developer/reference/backend.rst b/content/developer/reference/backend.rst index cd56eca9c..e7e1f06da 100644 --- a/content/developer/reference/backend.rst +++ b/content/developer/reference/backend.rst @@ -1,19 +1,20 @@ :nosearch: +:hide-page-toc: ================ -Python framework +Server framework ================ .. toctree:: - :titlesonly: + :titlesonly: - backend/orm - backend/data - backend/actions - backend/reports - backend/module - backend/security - backend/performance - backend/testing - backend/http - backend/mixins + backend/orm + backend/data + backend/actions + backend/reports + backend/module + backend/security + backend/performance + backend/testing + backend/http + backend/mixins diff --git a/content/developer/reference/frontend.rst b/content/developer/reference/frontend.rst index cf95a3841..cc65ce4a6 100644 --- a/content/developer/reference/frontend.rst +++ b/content/developer/reference/frontend.rst @@ -1,21 +1,22 @@ :nosearch: +:hide-page-toc: -==================== -JavaScript framework -==================== +============= +Web framework +============= .. toctree:: - :titlesonly: + :titlesonly: - frontend/framework_overview - frontend/assets - frontend/javascript_modules - frontend/owl_components - frontend/registries - frontend/services - frontend/hooks - frontend/patching_code - frontend/javascript_reference - frontend/mobile - frontend/qweb - frontend/odoo_editor + frontend/framework_overview + frontend/assets + frontend/javascript_modules + frontend/owl_components + frontend/registries + frontend/services + frontend/hooks + frontend/patching_code + frontend/javascript_reference + frontend/mobile + frontend/qweb + frontend/odoo_editor diff --git a/content/developer/reference/user_interface/view_architectures/button_attribute_context.rst b/content/developer/reference/user_interface/view_architectures/button_attribute_context.rst index 9bea9acc2..eec05a0b3 100644 --- a/content/developer/reference/user_interface/view_architectures/button_attribute_context.rst +++ b/content/developer/reference/user_interface/view_architectures/button_attribute_context.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: context :noindex: diff --git a/content/developer/reference/user_interface/view_architectures/button_attribute_help.rst b/content/developer/reference/user_interface/view_architectures/button_attribute_help.rst index c06abff00..e2f69d76f 100644 --- a/content/developer/reference/user_interface/view_architectures/button_attribute_help.rst +++ b/content/developer/reference/user_interface/view_architectures/button_attribute_help.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: help :noindex: diff --git a/content/developer/reference/user_interface/view_architectures/button_attribute_icon.rst b/content/developer/reference/user_interface/view_architectures/button_attribute_icon.rst index f1ba26cf2..b9f553922 100644 --- a/content/developer/reference/user_interface/view_architectures/button_attribute_icon.rst +++ b/content/developer/reference/user_interface/view_architectures/button_attribute_icon.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: icon :noindex: diff --git a/content/developer/reference/user_interface/view_architectures/button_attribute_name.rst b/content/developer/reference/user_interface/view_architectures/button_attribute_name.rst index 86996cfa4..43938a320 100644 --- a/content/developer/reference/user_interface/view_architectures/button_attribute_name.rst +++ b/content/developer/reference/user_interface/view_architectures/button_attribute_name.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: name :noindex: diff --git a/content/developer/reference/user_interface/view_architectures/button_attribute_string.rst b/content/developer/reference/user_interface/view_architectures/button_attribute_string.rst index dcfb97858..af525fc57 100644 --- a/content/developer/reference/user_interface/view_architectures/button_attribute_string.rst +++ b/content/developer/reference/user_interface/view_architectures/button_attribute_string.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: string :noindex: diff --git a/content/developer/reference/user_interface/view_architectures/button_attribute_type.rst b/content/developer/reference/user_interface/view_architectures/button_attribute_type.rst index 51701e75e..d3f201236 100644 --- a/content/developer/reference/user_interface/view_architectures/button_attribute_type.rst +++ b/content/developer/reference/user_interface/view_architectures/button_attribute_type.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: type :noindex: diff --git a/content/developer/reference/user_interface/view_architectures/field_attribute_name.rst b/content/developer/reference/user_interface/view_architectures/field_attribute_name.rst index 1f1cd534a..226a6e01e 100644 --- a/content/developer/reference/user_interface/view_architectures/field_attribute_name.rst +++ b/content/developer/reference/user_interface/view_architectures/field_attribute_name.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: name :noindex: diff --git a/content/developer/reference/user_interface/view_architectures/field_attribute_readonly.rst b/content/developer/reference/user_interface/view_architectures/field_attribute_readonly.rst index 2900584a0..f7e346706 100644 --- a/content/developer/reference/user_interface/view_architectures/field_attribute_readonly.rst +++ b/content/developer/reference/user_interface/view_architectures/field_attribute_readonly.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: readonly :noindex: diff --git a/content/developer/reference/user_interface/view_architectures/field_attribute_required.rst b/content/developer/reference/user_interface/view_architectures/field_attribute_required.rst index 9022debfc..814d83acb 100644 --- a/content/developer/reference/user_interface/view_architectures/field_attribute_required.rst +++ b/content/developer/reference/user_interface/view_architectures/field_attribute_required.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: required :noindex: diff --git a/content/developer/reference/user_interface/view_architectures/field_attribute_string.rst b/content/developer/reference/user_interface/view_architectures/field_attribute_string.rst index d32e88cde..7c4d12c7b 100644 --- a/content/developer/reference/user_interface/view_architectures/field_attribute_string.rst +++ b/content/developer/reference/user_interface/view_architectures/field_attribute_string.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: string :noindex: diff --git a/content/developer/reference/user_interface/view_architectures/field_attribute_widget.rst b/content/developer/reference/user_interface/view_architectures/field_attribute_widget.rst index 089f657ce..046741b51 100644 --- a/content/developer/reference/user_interface/view_architectures/field_attribute_widget.rst +++ b/content/developer/reference/user_interface/view_architectures/field_attribute_widget.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: widget :noindex: diff --git a/content/developer/reference/user_interface/view_architectures/generic_attribute_class.rst b/content/developer/reference/user_interface/view_architectures/generic_attribute_class.rst index 606d3e57c..8c41f8e3e 100644 --- a/content/developer/reference/user_interface/view_architectures/generic_attribute_class.rst +++ b/content/developer/reference/user_interface/view_architectures/generic_attribute_class.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: class :noindex: diff --git a/content/developer/reference/user_interface/view_architectures/generic_attribute_column_invisible.rst b/content/developer/reference/user_interface/view_architectures/generic_attribute_column_invisible.rst index 49578ebfc..de883c9b6 100644 --- a/content/developer/reference/user_interface/view_architectures/generic_attribute_column_invisible.rst +++ b/content/developer/reference/user_interface/view_architectures/generic_attribute_column_invisible.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: column_invisible :noindex: diff --git a/content/developer/reference/user_interface/view_architectures/generic_attribute_groups.rst b/content/developer/reference/user_interface/view_architectures/generic_attribute_groups.rst index 4ea4e8eb5..03f2eb467 100644 --- a/content/developer/reference/user_interface/view_architectures/generic_attribute_groups.rst +++ b/content/developer/reference/user_interface/view_architectures/generic_attribute_groups.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: groups :noindex: diff --git a/content/developer/reference/user_interface/view_architectures/generic_attribute_invisible.rst b/content/developer/reference/user_interface/view_architectures/generic_attribute_invisible.rst index d3d6849f0..c1e448595 100644 --- a/content/developer/reference/user_interface/view_architectures/generic_attribute_invisible.rst +++ b/content/developer/reference/user_interface/view_architectures/generic_attribute_invisible.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: invisible :noindex: diff --git a/content/developer/reference/user_interface/view_architectures/root_attribute_banner_route.rst b/content/developer/reference/user_interface/view_architectures/root_attribute_banner_route.rst index 5e96dca09..e2be02b15 100644 --- a/content/developer/reference/user_interface/view_architectures/root_attribute_banner_route.rst +++ b/content/developer/reference/user_interface/view_architectures/root_attribute_banner_route.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: banner_route :noindex: diff --git a/content/developer/reference/user_interface/view_architectures/root_attribute_create.rst b/content/developer/reference/user_interface/view_architectures/root_attribute_create.rst index a7b1f6f34..a3c3e0630 100644 --- a/content/developer/reference/user_interface/view_architectures/root_attribute_create.rst +++ b/content/developer/reference/user_interface/view_architectures/root_attribute_create.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: create :noindex: diff --git a/content/developer/reference/user_interface/view_architectures/root_attribute_default_group_by.rst b/content/developer/reference/user_interface/view_architectures/root_attribute_default_group_by.rst index 419486bc2..2824700d1 100644 --- a/content/developer/reference/user_interface/view_architectures/root_attribute_default_group_by.rst +++ b/content/developer/reference/user_interface/view_architectures/root_attribute_default_group_by.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: default_group_by :noindex: diff --git a/content/developer/reference/user_interface/view_architectures/root_attribute_default_order.rst b/content/developer/reference/user_interface/view_architectures/root_attribute_default_order.rst index bc3a9c0ee..5b1358f97 100644 --- a/content/developer/reference/user_interface/view_architectures/root_attribute_default_order.rst +++ b/content/developer/reference/user_interface/view_architectures/root_attribute_default_order.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: default_order :noindex: diff --git a/content/developer/reference/user_interface/view_architectures/root_attribute_delete.rst b/content/developer/reference/user_interface/view_architectures/root_attribute_delete.rst index 04a290b4e..c0b2e86ff 100644 --- a/content/developer/reference/user_interface/view_architectures/root_attribute_delete.rst +++ b/content/developer/reference/user_interface/view_architectures/root_attribute_delete.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: delete :noindex: diff --git a/content/developer/reference/user_interface/view_architectures/root_attribute_edit.rst b/content/developer/reference/user_interface/view_architectures/root_attribute_edit.rst index 90fe2f860..8642cdc53 100644 --- a/content/developer/reference/user_interface/view_architectures/root_attribute_edit.rst +++ b/content/developer/reference/user_interface/view_architectures/root_attribute_edit.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: edit :noindex: diff --git a/content/developer/reference/user_interface/view_architectures/root_attribute_sample.rst b/content/developer/reference/user_interface/view_architectures/root_attribute_sample.rst index c41d31e6e..cfc46339d 100644 --- a/content/developer/reference/user_interface/view_architectures/root_attribute_sample.rst +++ b/content/developer/reference/user_interface/view_architectures/root_attribute_sample.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: sample :noindex: diff --git a/content/developer/reference/user_interface/view_architectures/root_attribute_string.rst b/content/developer/reference/user_interface/view_architectures/root_attribute_string.rst index ba9ace025..82c89b229 100644 --- a/content/developer/reference/user_interface/view_architectures/root_attribute_string.rst +++ b/content/developer/reference/user_interface/view_architectures/root_attribute_string.rst @@ -1,3 +1,5 @@ +:nosearch: + .. attribute:: string :noindex: diff --git a/content/developer/tutorials.rst b/content/developer/tutorials.rst index d4aedc5ed..d133a3eab 100644 --- a/content/developer/tutorials.rst +++ b/content/developer/tutorials.rst @@ -6,42 +6,52 @@ Tutorials ========= .. toctree:: - :titlesonly: + tutorials/setup_guide + tutorials/server_framework_101 + tutorials/discover_js_framework + tutorials/master_odoo_web_framework + tutorials/define_module_data + tutorials/restrict_data_access + tutorials/unit_tests + tutorials/mixins + tutorials/pdf_reports - tutorials/getting_started - tutorials/discover_js_framework - tutorials/master_odoo_web_framework - tutorials/define_module_data - tutorials/restrict_data_access - tutorials/unit_tests - tutorials/mixins - tutorials/pdf_reports +.. tip:: + If you are new to Odoo development, we recommend starting with the :doc:`setup guide + `. + +Learn the server and web frameworks +=================================== .. cards:: - .. card:: Getting started - :target: tutorials/getting_started + .. card:: Server framework 101 + :target: tutorials/server_framework_101 :tag: Beginner :large: - Develop your own module with the Odoo framework. This step-by-step tutorial is crafted for - newcomers and any other individual curious about Odoo development. + This introductory tutorial is designed for complete beginners seeking to get started in Odoo + development. It covers the essential aspects and key concepts of the server framework. Learn + to create a simple module from scratch with step-by-step instructions and practical insights. - .. card:: Discover the JavaScript Framework + .. card:: Discover the web framework :target: tutorials/discover_js_framework :tag: Beginner - :large: - Learn the basics of the JavaScript framework of Odoo. This tutorial will teach you how to work - with Owl components and introduce the basic principles underlying the Odoo JavaScript - codebase. + This tutorial will teach the basics of the web framework and how to work with Owl components + by customizing the web client. - .. card:: Master the Odoo Web Framework + .. card:: Master the web framework :target: tutorials/master_odoo_web_framework :tag: Advanced - Become an expert in the Odoo Web Framework. A large variety of features are covered such as - fields, views, and even the kitten mode. + Become an expert in the web framework. A large variety of features are covered such as fields, + views, and even the kitten mode. + +Expand your knowledge on the server framework +============================================= + +.. cards:: .. card:: Define module data :target: tutorials/define_module_data diff --git a/content/developer/tutorials/backend.rst b/content/developer/tutorials/backend.rst index 8739c4d9f..9249e97d2 100644 --- a/content/developer/tutorials/backend.rst +++ b/content/developer/tutorials/backend.rst @@ -8,7 +8,7 @@ Building a Module ================= .. danger:: - This tutorial is outdated. We recommend reading :doc:`getting_started` instead. + This tutorial is outdated. We recommend reading :doc:`server_framework_101` instead. .. warning:: This tutorial requires :doc:`having installed Odoo ` diff --git a/content/developer/tutorials/define_module_data.rst b/content/developer/tutorials/define_module_data.rst index 1c1e912fb..d115be32e 100644 --- a/content/developer/tutorials/define_module_data.rst +++ b/content/developer/tutorials/define_module_data.rst @@ -3,11 +3,9 @@ Define module data ================== .. important:: - This tutorial is an extension of the :doc:`getting_started` tutorial. Make sure you have + This tutorial is an extension of the :doc:`server_framework_101` tutorial. Make sure you have completed it and use the `estate` module you have built as a base for the exercises in this - tutorial. Fetch the branch `{BRANCH}-core` from the `technical-training-solutions - `_ repository if you - want to start from a clean base. + tutorial. Data Types ========== @@ -193,7 +191,7 @@ When the data to create is more complex it can be useful, or even necessary, to Data Extension ~~~~~~~~~~~~~~ -During the Core Training, we saw in the :ref:`tutorials/getting_started/13_inheritance` chapter we +During the Core Training, we saw in the :doc:`server_framework_101/12_inheritance` chapter we could inherit (extend) an existing view. This was a special case of data extension: any data can be extended in a module. @@ -251,7 +249,7 @@ works too if you are in the module declaring it). The value to assign to a field is not always a simple string and you might need to compute it. It can also be used to optimize the insertion of related values, or because a constraint forces you to add the related values in batch. See ::ref:`Add X2many fields -`. +`. .. code-block:: xml @@ -298,7 +296,7 @@ You might also need to execute python code when loading data. others. -.. _tutorials/getting_started/C_data/x2m: +.. _tutorials/define_module_data/x2m: Add X2many fields ----------------- @@ -362,7 +360,7 @@ In CSV, the title of the column must be suffixed with ``:id`` or ``/id``. "child3","module.parent","Name3" In SQL, it is more complicated, see :ref:`the advanced section -`. +`. .. warning:: Data can always be deleted by the user. Always code defensively, taking this into account. @@ -373,7 +371,7 @@ In SQL, it is more complicated, see :ref:`the advanced section Advanced ======== -.. _tutorials/getting_started/C_data/xml_id: +.. _tutorials/define_module_data/xml_id: What is the XML id? ------------------- diff --git a/content/developer/tutorials/discover_js_framework.rst b/content/developer/tutorials/discover_js_framework.rst index fe178dd89..ca4f4d80a 100644 --- a/content/developer/tutorials/discover_js_framework.rst +++ b/content/developer/tutorials/discover_js_framework.rst @@ -1,8 +1,8 @@ :show-content: -========================= -Discover the JS framework -========================= +========================== +Discover the web framework +========================== .. toctree:: :titlesonly: @@ -10,12 +10,12 @@ Discover the JS framework discover_js_framework/* -This two parts tutorial is designed to introduce you to the basics of the Odoo Javascript framework. Whether +This two parts tutorial is designed to introduce you to the basics of the web framework. Whether you are new to the framework or have some prior experience, this tutorial will provide you with a -solid foundation for using the Odoo JavaScript framework in your projects. +solid foundation for using the web framework in your projects. The first part covers the basics of Owl components, which -are a key part of the Odoo JS framework. Owl components are reusable UI components that can be used +are a key part of the web framework. Owl components are reusable UI components that can be used to build complex web interfaces quickly and efficiently. We will explore how to create and use Owl components in Odoo. Then, in the second part of this tutorial, we focus on creating a dashboard using various features of Odoo. Dashboards are an essential part of any web application, and provide a nice starting @@ -23,8 +23,7 @@ point to use and interact with the Odoo codebase. This tutorial assumes that you have some basic knowledge of development with Odoo in general (models, controllers, QWeb, ...). If you are new to Odoo, we recommend that you start with the -:doc:`Getting started ` tutorial before proceeding with this -one. +:doc:`/developer/tutorials/server_framework_101` tutorial before proceeding with this one. .. note:: diff --git a/content/developer/tutorials/getting_started.rst b/content/developer/tutorials/getting_started.rst deleted file mode 100644 index 64c2aeb9d..000000000 --- a/content/developer/tutorials/getting_started.rst +++ /dev/null @@ -1,47 +0,0 @@ -:show-content: - -.. _tutorials/getting_started: - -=============== -Getting started -=============== - -.. toctree:: - :titlesonly: - :glob: - - getting_started/* - -Welcome to the Getting Started Odoo tutorial! If you reached this page that means you are -interested in the development of your own Odoo module. It might also mean that you recently -joined the Odoo company for a rather technical position. In any case, your journey to the -technical side of Odoo starts here. - -The goal of this tutorial is for you to get an insight of the most important parts of the Odoo -development framework while developing your own Odoo module to manage real estate assets. The -chapters should be followed in their given order since they cover the development of a new Odoo -application from scratch in an incremental way. In other words, each chapter depends on the previous -one. - -.. attention:: - Are you following this tutorial as part of your technical onboarding as an Odoo employee? Then, - we ask you to complete all the chapters before joining your new team. - -Ready? Let's get started! - -* :doc:`getting_started/01_architecture` -* :doc:`getting_started/02_setup` -* :doc:`getting_started/03_newapp` -* :doc:`getting_started/04_basicmodel` -* :doc:`getting_started/05_securityintro` -* :doc:`getting_started/06_firstui` -* :doc:`getting_started/07_basicviews` -* :doc:`getting_started/08_relations` -* :doc:`getting_started/09_compute_onchange` -* :doc:`getting_started/10_actions` -* :doc:`getting_started/11_constraints` -* :doc:`getting_started/12_sprinkles` -* :doc:`getting_started/13_inheritance` -* :doc:`getting_started/14_other_module` -* :doc:`getting_started/15_qwebintro` -* :doc:`getting_started/16_final_word` diff --git a/content/developer/tutorials/getting_started/02_setup/account-settings.png b/content/developer/tutorials/getting_started/02_setup/account-settings.png deleted file mode 100644 index 90392e7b2..000000000 Binary files a/content/developer/tutorials/getting_started/02_setup/account-settings.png and /dev/null differ diff --git a/content/developer/tutorials/getting_started/02_setup/settings-sidebar-ssh-keys.png b/content/developer/tutorials/getting_started/02_setup/settings-sidebar-ssh-keys.png deleted file mode 100644 index 67c61910a..000000000 Binary files a/content/developer/tutorials/getting_started/02_setup/settings-sidebar-ssh-keys.png and /dev/null differ diff --git a/content/developer/tutorials/getting_started/02_setup/ssh-add-ssh-key.png b/content/developer/tutorials/getting_started/02_setup/ssh-add-ssh-key.png deleted file mode 100644 index e8a103e32..000000000 Binary files a/content/developer/tutorials/getting_started/02_setup/ssh-add-ssh-key.png and /dev/null differ diff --git a/content/developer/tutorials/getting_started/02_setup/ssh-key-paste.png b/content/developer/tutorials/getting_started/02_setup/ssh-key-paste.png deleted file mode 100644 index 139047c57..000000000 Binary files a/content/developer/tutorials/getting_started/02_setup/ssh-key-paste.png and /dev/null differ diff --git a/content/developer/tutorials/master_odoo_web_framework.rst b/content/developer/tutorials/master_odoo_web_framework.rst index 608c44f69..9e5d7a915 100644 --- a/content/developer/tutorials/master_odoo_web_framework.rst +++ b/content/developer/tutorials/master_odoo_web_framework.rst @@ -1,8 +1,8 @@ :show-content: -============================= -Master the Odoo web framework -============================= +======================== +Master the web framework +======================== .. toctree:: :titlesonly: @@ -11,7 +11,7 @@ Master the Odoo web framework master_odoo_web_framework/* This tutorial is designed for those who have completed the :doc:`discover_js_framework` tutorial and -are looking to deepen their knowledge of the Odoo web framework. It is organized in four independant +are looking to deepen their knowledge of the web framework. It is organized in four independent projects, each focusing on different features of Odoo. .. note:: diff --git a/content/developer/tutorials/master_odoo_web_framework/03_customize_kanban_view.rst b/content/developer/tutorials/master_odoo_web_framework/03_customize_kanban_view.rst index b67987489..bea7197d6 100644 --- a/content/developer/tutorials/master_odoo_web_framework/03_customize_kanban_view.rst +++ b/content/developer/tutorials/master_odoo_web_framework/03_customize_kanban_view.rst @@ -2,7 +2,7 @@ Chapter 3: Customize a kanban view ================================== -We have gained an understanding of the numerous capabilities offered by the Odoo web framework. As a +We have gained an understanding of the numerous capabilities offered by the web framework. As a next step, we will customize a kanban view. This is a more complicated project that will showcase some non trivial aspects of the framework. The goal is to practice composing views, coordinating various aspects of the UI, and doing it in a maintainable way. diff --git a/content/developer/tutorials/pdf_reports.rst b/content/developer/tutorials/pdf_reports.rst index 83bcba73c..614ff5894 100644 --- a/content/developer/tutorials/pdf_reports.rst +++ b/content/developer/tutorials/pdf_reports.rst @@ -3,13 +3,11 @@ Build PDF Reports ================= .. important:: - This tutorial is an extension of the :doc:`getting_started` tutorial. Make sure you have + This tutorial is an extension of the :doc:`server_framework_101` tutorial. Make sure you have completed it and use the `estate` module you have built as a base for the exercises in this - tutorial. Fetch the branch `{BRANCH}-core` from the `technical-training-solutions - `_ repository if you - want to start from a clean base. + tutorial. -We were previously :ref:`introduced to QWeb ` +We were previously :doc:`introduced to QWeb ` where it was used to build a kanban view. Now we will expand on one of QWeb's other main uses: creating PDF reports. A common business requirement is the ability to create documents to send to customers and to use internally. These reports can be used to summarize and display @@ -180,7 +178,7 @@ Its contents are all explained in :ref:`the documentation `_ repository if you - want to start from a clean base. + tutorial. So far we have mostly concerned ourselves with implementing useful features. However in most business scenarios *security* quickly becomes a concern: @@ -17,7 +15,7 @@ currently, update or delete properties, property types, or property tags. * If ``estate_account`` is installed then only agents allowed to interact with invoicing can confirm sales as that's necessary to :ref:`create an - invoice `. + invoice `. However: @@ -142,7 +140,7 @@ Access Rights real-estate application. - Real-estate agents will not be able to update the property types or tags. -Access rights were first introduced in :ref:`tutorials/getting_started/05_securityintro`. +Access rights were first introduced in :doc:`server_framework_101/04_securityintro`. Access rights are a way to give users access to models *via* groups: associate an access right to a group, then all users with that group will have the access. diff --git a/content/developer/tutorials/server_framework_101.rst b/content/developer/tutorials/server_framework_101.rst new file mode 100644 index 000000000..e6ef2e04e --- /dev/null +++ b/content/developer/tutorials/server_framework_101.rst @@ -0,0 +1,44 @@ +:show-content: + +==================== +Server framework 101 +==================== + +.. toctree:: + :titlesonly: + :glob: + + server_framework_101/* + +Welcome to the Server framework 101 tutorial! If you reached this page that means you are +interested in the development of your own Odoo module. It might also mean that you recently +joined the Odoo company for a rather technical position. In any case, your journey to the +technical side of Odoo starts here. + +The goal of this tutorial is for you to get an insight of the most important parts of the Odoo +development framework while developing your own Odoo module to manage real estate assets. The +chapters should be followed in their given order since they cover the development of a new Odoo +application from scratch in an incremental way. In other words, each chapter depends on the previous +one. + +.. important:: + Before going further, make sure you have prepared your development environment with the + :doc:`setup guide `. + +Ready? Let's get started! + +* :doc:`server_framework_101/01_architecture` +* :doc:`server_framework_101/02_newapp` +* :doc:`server_framework_101/03_basicmodel` +* :doc:`server_framework_101/04_securityintro` +* :doc:`server_framework_101/05_firstui` +* :doc:`server_framework_101/06_basicviews` +* :doc:`server_framework_101/07_relations` +* :doc:`server_framework_101/08_compute_onchange` +* :doc:`server_framework_101/09_actions` +* :doc:`server_framework_101/10_constraints` +* :doc:`server_framework_101/11_sprinkles` +* :doc:`server_framework_101/12_inheritance` +* :doc:`server_framework_101/13_other_module` +* :doc:`server_framework_101/14_qwebintro` +* :doc:`server_framework_101/15_final_word` diff --git a/content/developer/tutorials/getting_started/01_architecture.rst b/content/developer/tutorials/server_framework_101/01_architecture.rst similarity index 93% rename from content/developer/tutorials/getting_started/01_architecture.rst rename to content/developer/tutorials/server_framework_101/01_architecture.rst index 1cc0a2486..5c5f3ca6f 100644 --- a/content/developer/tutorials/getting_started/01_architecture.rst +++ b/content/developer/tutorials/server_framework_101/01_architecture.rst @@ -1,4 +1,4 @@ -.. _tutorials/getting_started/01_architecture: +.. _tutorials/server_framework_101/01_architecture: ================================ Chapter 1: Architecture Overview @@ -121,10 +121,7 @@ Odoo is available in `two versions`_: Odoo Enterprise (licensed & shared sources functionalities to Odoo. From a technical point-of-view, these functionalities are simply new modules installed on top of the modules provided by the Community version. -Ready to start? Before writing actual code, let's go to the :doc:`next chapter <02_setup>` to review -the Odoo installation process. Even if Odoo is already running on your system, we strongly suggest -you go through this chapter to make sure we start on the same page during the development of our new -application. +Ready to start? It is now time to :doc:`write your own application <02_newapp>`! .. _multitier architecture: https://en.wikipedia.org/wiki/Multitier_architecture diff --git a/content/developer/tutorials/getting_started/01_architecture/three_tier.svg b/content/developer/tutorials/server_framework_101/01_architecture/three_tier.svg similarity index 100% rename from content/developer/tutorials/getting_started/01_architecture/three_tier.svg rename to content/developer/tutorials/server_framework_101/01_architecture/three_tier.svg diff --git a/content/developer/tutorials/getting_started/03_newapp.rst b/content/developer/tutorials/server_framework_101/02_newapp.rst similarity index 92% rename from content/developer/tutorials/getting_started/03_newapp.rst rename to content/developer/tutorials/server_framework_101/02_newapp.rst index d40afedbd..31e02dcfd 100644 --- a/content/developer/tutorials/getting_started/03_newapp.rst +++ b/content/developer/tutorials/server_framework_101/02_newapp.rst @@ -1,7 +1,5 @@ -.. _tutorials/getting_started/03_newapp: - ============================ -Chapter 3: A New Application +Chapter 2: A New Application ============================ The purpose of this chapter is to lay the foundation for the creation of a completely new Odoo module. @@ -18,7 +16,7 @@ to answer the specific business case. Here is an overview of the main list view containing some advertisements: -.. image:: 03_newapp/overview_list_view_01.png +.. image:: 02_newapp/overview_list_view_01.png :align: center :alt: List view 01 @@ -26,14 +24,14 @@ The top area of the form view summarizes important information for the property, the property type, the postcode and so on. The first tab contains information describing the property: bedrooms, living area, garage, garden... -.. image:: 03_newapp/overview_form_view_01.png +.. image:: 02_newapp/overview_form_view_01.png :align: center :alt: Form view 01 The second tab lists the offers for the property. We can see here that potential buyers can make offers above or below the expected selling price. It is up to the seller to accept an offer. -.. image:: 03_newapp/overview_form_view_02.png +.. image:: 02_newapp/overview_form_view_02.png :align: center :alt: Form view 02 @@ -52,7 +50,7 @@ Prepare the addon directory **Goal**: the goal of this section is to have Odoo recognize our new module, which will be an empty shell for now. It will be listed in the Apps: - .. image:: 03_newapp/app_in_list.png + .. image:: 02_newapp/app_in_list.png :align: center :alt: The new module appears in the list @@ -98,5 +96,4 @@ tadaaa, your module appears! Did it not appear? Maybe try removing the default ' You can even install the module! But obviously it's an empty shell, so no menu will appear. -All good? If yes, then let's :ref:`create our first model -`! +All good? If yes, then let's :doc:`create our first model <03_basicmodel>`! diff --git a/content/developer/tutorials/getting_started/03_newapp/app_in_list.png b/content/developer/tutorials/server_framework_101/02_newapp/app_in_list.png similarity index 100% rename from content/developer/tutorials/getting_started/03_newapp/app_in_list.png rename to content/developer/tutorials/server_framework_101/02_newapp/app_in_list.png diff --git a/content/developer/tutorials/getting_started/03_newapp/overview_form_view_01.png b/content/developer/tutorials/server_framework_101/02_newapp/overview_form_view_01.png similarity index 100% rename from content/developer/tutorials/getting_started/03_newapp/overview_form_view_01.png rename to content/developer/tutorials/server_framework_101/02_newapp/overview_form_view_01.png diff --git a/content/developer/tutorials/getting_started/03_newapp/overview_form_view_02.png b/content/developer/tutorials/server_framework_101/02_newapp/overview_form_view_02.png similarity index 100% rename from content/developer/tutorials/getting_started/03_newapp/overview_form_view_02.png rename to content/developer/tutorials/server_framework_101/02_newapp/overview_form_view_02.png diff --git a/content/developer/tutorials/getting_started/03_newapp/overview_list_view_01.png b/content/developer/tutorials/server_framework_101/02_newapp/overview_list_view_01.png similarity index 100% rename from content/developer/tutorials/getting_started/03_newapp/overview_list_view_01.png rename to content/developer/tutorials/server_framework_101/02_newapp/overview_list_view_01.png diff --git a/content/developer/tutorials/getting_started/04_basicmodel.rst b/content/developer/tutorials/server_framework_101/03_basicmodel.rst similarity index 98% rename from content/developer/tutorials/getting_started/04_basicmodel.rst rename to content/developer/tutorials/server_framework_101/03_basicmodel.rst index c7b1a7ea5..fcdbceaeb 100644 --- a/content/developer/tutorials/getting_started/04_basicmodel.rst +++ b/content/developer/tutorials/server_framework_101/03_basicmodel.rst @@ -1,10 +1,8 @@ -.. _tutorials/getting_started/04_basicmodel: - ================================== -Chapter 4: Models And Basic Fields +Chapter 3: Models And Basic Fields ================================== -At the end of the :ref:`previous chapter `, we were able to +At the end of the :doc:`previous chapter <02_newapp>`, we were able to create an Odoo module. However, at this point it is still an empty shell which doesn't allow us to store any data. In our real estate module, we want to store the information related to the properties (name, description, price, living area...) in a database. The Odoo framework provides @@ -289,7 +287,7 @@ useful or necessary: Now that we have created our first model, let's -:ref:`add some security `! +:doc:`add some security <04_securityintro>`! .. [#autofields] it is possible to :ref:`disable the automatic creation of some diff --git a/content/developer/tutorials/getting_started/05_securityintro.rst b/content/developer/tutorials/server_framework_101/04_securityintro.rst similarity index 94% rename from content/developer/tutorials/getting_started/05_securityintro.rst rename to content/developer/tutorials/server_framework_101/04_securityintro.rst index 80c8ccbd2..5c4c2317f 100644 --- a/content/developer/tutorials/getting_started/05_securityintro.rst +++ b/content/developer/tutorials/server_framework_101/04_securityintro.rst @@ -1,10 +1,8 @@ -.. _tutorials/getting_started/05_securityintro: - ========================================== -Chapter 5: Security - A Brief Introduction +Chapter 4: Security - A Brief Introduction ========================================== -In the :ref:`previous chapter `, we created our first table +In the :doc:`previous chapter <03_basicmodel>`, we created our first table intended to store business data. In a business application such as Odoo, one of the first questions to consider is who\ [#who]_ can access the data. Odoo provides a security mechanism to allow access to the data for specific groups of users. @@ -119,7 +117,7 @@ Here is an example for our previous `test_model`: Restart the server and the warning message should have disappeared! -It's now time to finally :ref:`interact with the UI `! +It's now time to finally :doc:`interact with the UI <05_firstui>`! .. [#who] meaning which Odoo user (or group of users) diff --git a/content/developer/tutorials/getting_started/06_firstui.rst b/content/developer/tutorials/server_framework_101/05_firstui.rst similarity index 91% rename from content/developer/tutorials/getting_started/06_firstui.rst rename to content/developer/tutorials/server_framework_101/05_firstui.rst index ec1558431..22974b67a 100644 --- a/content/developer/tutorials/getting_started/06_firstui.rst +++ b/content/developer/tutorials/server_framework_101/05_firstui.rst @@ -1,11 +1,9 @@ -.. _tutorials/getting_started/06_firstui: - ======================================== -Chapter 6: Finally, Some UI To Play With +Chapter 5: Finally, Some UI To Play With ======================================== -Now that we've created our new :ref:`model ` and its -corresponding :ref:`access rights `, it is time to +Now that we've created our new :doc:`model <03_basicmodel>` and its +corresponding :doc:`access rights <04_securityintro>`, it is time to interact with the user interface. At the end of this chapter, we will have created a couple of menus in order to access a default list @@ -17,7 +15,7 @@ Data Files (XML) **Reference**: the documentation related to this topic can be found in :ref:`reference/data`. -In :ref:`tutorials/getting_started/05_securityintro`, we added data through a CSV file. The CSV +In :doc:`04_securityintro`, we added data through a CSV file. The CSV format is convenient when the data to load has a simple format. When the format is more complex (e.g. load the structure of a view or an email template), we use the XML format. For example, this @@ -65,7 +63,7 @@ Actions can be triggered in three ways: 3. as contextual actions on object We will only cover the first case in this chapter. The second case will be covered in a -:ref:`later chapter ` while the last is the focus of an +:doc:`later chapter <09_actions>` while the last is the focus of an advanced topic. In our Real Estate example, we would like to link a menu to the ``estate.property`` model, so we are able to create a new record. The action can be viewed as the link between the menu and the model. @@ -86,7 +84,7 @@ A basic action for our `test_model` is: - ``name`` is the name of the action. - ``res_model`` is the model which the action applies to. - ``view_mode`` are the views that will be available; in this case they are the list (tree) and form views. - We'll see :ref:`later ` that there can be other view modes. + We'll see :doc:`later <14_qwebintro>` that there can be other view modes. Examples can be found everywhere in Odoo, but `this `__ @@ -113,15 +111,15 @@ Menus **Goal**: at the end of this section, three menus should be created and the default view is displayed: - .. image:: 06_firstui/estate_menu_root.png + .. image:: 05_firstui/estate_menu_root.png :align: center :alt: Root menus - .. image:: 06_firstui/estate_menu_action.png + .. image:: 05_firstui/estate_menu_action.png :align: center :alt: First level and action menus - .. image:: 06_firstui/estate_form_default.png + .. image:: 05_firstui/estate_form_default.png :align: center :alt: Default form view @@ -145,11 +143,11 @@ However, menus always follow an architecture, and in practice there are three le 2. The first level menu, displayed in the top bar 3. The action menus - .. image:: 06_firstui/menu_01.png + .. image:: 05_firstui/menu_01.png :align: center :alt: Root menus - .. image:: 06_firstui/menu_02.png + .. image:: 05_firstui/menu_02.png :align: center :alt: First level and action menus @@ -186,7 +184,7 @@ Fields, Attributes And View of bedrooms and the availability date should have default values. Additionally the selling price and availability date values won't be copied when the record is duplicated. - .. image:: 06_firstui/attribute_and_default.gif + .. image:: 05_firstui/attribute_and_default.gif :align: center :alt: Interaction between model and view @@ -266,7 +264,7 @@ not be listed! ``active`` is an example of a reserved field with a specific beha a record has ``active=False``, it is automatically removed from any search. To display the created property, you will need to specifically search for inactive records. -.. image:: 06_firstui/inactive.gif +.. image:: 05_firstui/inactive.gif :align: center :alt: Inactive records @@ -287,7 +285,7 @@ Note that the default ``active=False`` value was assigned to all existing record The ``state`` will be used later on for several UI enhancements. Now that we are able to interact with the UI thanks to the default views, the next step is -obvious: we want to define :ref:`our own views `. +obvious: we want to define :doc:`our own views <06_basicviews>`. .. [#refresh] A refresh is needed since the web client keeps a cache of the various menus and views for performance reasons. diff --git a/content/developer/tutorials/getting_started/06_firstui/attribute_and_default.gif b/content/developer/tutorials/server_framework_101/05_firstui/attribute_and_default.gif similarity index 100% rename from content/developer/tutorials/getting_started/06_firstui/attribute_and_default.gif rename to content/developer/tutorials/server_framework_101/05_firstui/attribute_and_default.gif diff --git a/content/developer/tutorials/getting_started/06_firstui/estate_form_default.png b/content/developer/tutorials/server_framework_101/05_firstui/estate_form_default.png similarity index 100% rename from content/developer/tutorials/getting_started/06_firstui/estate_form_default.png rename to content/developer/tutorials/server_framework_101/05_firstui/estate_form_default.png diff --git a/content/developer/tutorials/getting_started/06_firstui/estate_menu_action.png b/content/developer/tutorials/server_framework_101/05_firstui/estate_menu_action.png similarity index 100% rename from content/developer/tutorials/getting_started/06_firstui/estate_menu_action.png rename to content/developer/tutorials/server_framework_101/05_firstui/estate_menu_action.png diff --git a/content/developer/tutorials/getting_started/06_firstui/estate_menu_root.png b/content/developer/tutorials/server_framework_101/05_firstui/estate_menu_root.png similarity index 100% rename from content/developer/tutorials/getting_started/06_firstui/estate_menu_root.png rename to content/developer/tutorials/server_framework_101/05_firstui/estate_menu_root.png diff --git a/content/developer/tutorials/getting_started/06_firstui/inactive.gif b/content/developer/tutorials/server_framework_101/05_firstui/inactive.gif similarity index 100% rename from content/developer/tutorials/getting_started/06_firstui/inactive.gif rename to content/developer/tutorials/server_framework_101/05_firstui/inactive.gif diff --git a/content/developer/tutorials/getting_started/06_firstui/menu_01.png b/content/developer/tutorials/server_framework_101/05_firstui/menu_01.png similarity index 100% rename from content/developer/tutorials/getting_started/06_firstui/menu_01.png rename to content/developer/tutorials/server_framework_101/05_firstui/menu_01.png diff --git a/content/developer/tutorials/getting_started/06_firstui/menu_02.png b/content/developer/tutorials/server_framework_101/05_firstui/menu_02.png similarity index 100% rename from content/developer/tutorials/getting_started/06_firstui/menu_02.png rename to content/developer/tutorials/server_framework_101/05_firstui/menu_02.png diff --git a/content/developer/tutorials/getting_started/07_basicviews.rst b/content/developer/tutorials/server_framework_101/06_basicviews.rst similarity index 94% rename from content/developer/tutorials/getting_started/07_basicviews.rst rename to content/developer/tutorials/server_framework_101/06_basicviews.rst index 0fd158150..bf1f769ba 100644 --- a/content/developer/tutorials/getting_started/07_basicviews.rst +++ b/content/developer/tutorials/server_framework_101/06_basicviews.rst @@ -1,10 +1,8 @@ -.. _tutorials/getting_started/07_basicviews: - ====================== -Chapter 7: Basic Views +Chapter 6: Basic Views ====================== -We have seen in the :ref:`previous chapter ` that Odoo is able +We have seen in the :doc:`previous chapter <05_firstui>` that Odoo is able to generate default views for a given model. In practice, the default view is **never** acceptable for a business application. Instead, we should at least organize the various fields in a logical manner. @@ -29,7 +27,7 @@ List **Goal**: at the end of this section, the list view should look like this: - .. image:: 07_basicviews/list.png + .. image:: 06_basicviews/list.png :align: center :alt: List view @@ -78,7 +76,7 @@ Form **Goal**: at the end of this section, the form view should look like this: - .. image:: 07_basicviews/form.png + .. image:: 06_basicviews/form.png :align: center :alt: Form view @@ -140,15 +138,15 @@ Search **Goal**: at the end of this section, the search view should look like this: - .. image:: 07_basicviews/search_01.png + .. image:: 06_basicviews/search_01.png :align: center :alt: Search fields - .. image:: 07_basicviews/search_02.png + .. image:: 06_basicviews/search_02.png :align: center :alt: Filter - .. image:: 07_basicviews/search_03.png + .. image:: 06_basicviews/search_03.png :align: center :alt: Group By @@ -239,4 +237,4 @@ services *OR* have a unit price which is *NOT* between 1000 and 2000':: Looking good? At this point we are already able to create models and design a user interface which makes sense business-wise. However, a key component is still missing: the -:ref:`link between models `. +:doc:`link between models <07_relations>`. diff --git a/content/developer/tutorials/getting_started/07_basicviews/form.png b/content/developer/tutorials/server_framework_101/06_basicviews/form.png similarity index 100% rename from content/developer/tutorials/getting_started/07_basicviews/form.png rename to content/developer/tutorials/server_framework_101/06_basicviews/form.png diff --git a/content/developer/tutorials/getting_started/07_basicviews/list.png b/content/developer/tutorials/server_framework_101/06_basicviews/list.png similarity index 100% rename from content/developer/tutorials/getting_started/07_basicviews/list.png rename to content/developer/tutorials/server_framework_101/06_basicviews/list.png diff --git a/content/developer/tutorials/getting_started/07_basicviews/search_01.png b/content/developer/tutorials/server_framework_101/06_basicviews/search_01.png similarity index 100% rename from content/developer/tutorials/getting_started/07_basicviews/search_01.png rename to content/developer/tutorials/server_framework_101/06_basicviews/search_01.png diff --git a/content/developer/tutorials/getting_started/07_basicviews/search_02.png b/content/developer/tutorials/server_framework_101/06_basicviews/search_02.png similarity index 100% rename from content/developer/tutorials/getting_started/07_basicviews/search_02.png rename to content/developer/tutorials/server_framework_101/06_basicviews/search_02.png diff --git a/content/developer/tutorials/getting_started/07_basicviews/search_03.png b/content/developer/tutorials/server_framework_101/06_basicviews/search_03.png similarity index 100% rename from content/developer/tutorials/getting_started/07_basicviews/search_03.png rename to content/developer/tutorials/server_framework_101/06_basicviews/search_03.png diff --git a/content/developer/tutorials/getting_started/08_relations.rst b/content/developer/tutorials/server_framework_101/07_relations.rst similarity index 92% rename from content/developer/tutorials/getting_started/08_relations.rst rename to content/developer/tutorials/server_framework_101/07_relations.rst index 6042df068..28538d4dd 100644 --- a/content/developer/tutorials/getting_started/08_relations.rst +++ b/content/developer/tutorials/server_framework_101/07_relations.rst @@ -1,10 +1,8 @@ -.. _tutorials/getting_started/08_relations: - =================================== -Chapter 8: Relations Between Models +Chapter 7: Relations Between Models =================================== -The :ref:`previous chapter ` covered the creation of custom +The :doc:`previous chapter <06_basicviews>` covered the creation of custom views for a model containing basic fields. However, in any real business scenario we need more than one model. Moreover, links between models are necessary. One can easily imagine one model containing the customers and another one containing the list of users. You might need to refer to a customer @@ -30,13 +28,13 @@ Many2one - a new ``estate.property.type`` model should be created with the corresponding menu, action and views. - .. image:: 08_relations/property_type.png + .. image:: 07_relations/property_type.png :align: center :alt: Property type - three Many2one fields should be added to the ``estate.property`` model: property type, buyer and seller. - .. image:: 08_relations/property_many2one.png + .. image:: 07_relations/property_many2one.png :align: center :alt: Property @@ -78,10 +76,10 @@ In practice a many2one can be seen as a dropdown list in a form view. and search views This exercise is a good recap of the previous chapters: you need to create a - :ref:`model `, set the - :ref:`model `, add an - :ref:`action and a menu `, and - :ref:`create a view `. + :doc:`model <03_basicmodel>`, set the + :doc:`model <04_securityintro>`, add an + :doc:`action and a menu <05_firstui>`, and + :doc:`create a view <06_basicviews>`. Tip: do not forget to import any new Python files in ``__init__.py``, add new data files in ``__manifest.py__`` or add the access rights ;-) @@ -137,13 +135,13 @@ Many2many - a new ``estate.property.tag`` model should be created with the corresponding menu and action. - .. image:: 08_relations/property_tag.png + .. image:: 07_relations/property_tag.png :align: center :alt: Property tag - tags should be added to the ``estate.property`` model: - .. image:: 08_relations/property_many2many.png + .. image:: 07_relations/property_many2many.png :align: center :alt: Property @@ -185,7 +183,7 @@ operations like ``recs1 | recs2``. Tip: in the view, use the ``widget="many2many_tags"`` attribute as demonstrated `here `__. - The ``widget`` attribute will be explained in detail in :ref:`a later chapter of the training `. + The ``widget`` attribute will be explained in detail in :doc:`a later chapter of the training <11_sprinkles>`. For now, you can try to adding and removing it and see the result ;-) One2many @@ -201,7 +199,7 @@ One2many - a new ``estate.property.offer`` model should be created with the corresponding form and tree view. - offers should be added to the ``estate.property`` model: - .. image:: 08_relations/property_offer.png + .. image:: 07_relations/property_offer.png :align: center :alt: Property offers @@ -263,4 +261,4 @@ for convenience. Still alive? This chapter is definitely not the easiest one. It introduced a couple of new concepts while relying on everything that was introduced before. The -:ref:`next chapter ` will be lighter, don't worry ;-) +:doc:`next chapter <08_compute_onchange>` will be lighter, don't worry ;-) diff --git a/content/developer/tutorials/getting_started/08_relations/property_many2many.png b/content/developer/tutorials/server_framework_101/07_relations/property_many2many.png similarity index 100% rename from content/developer/tutorials/getting_started/08_relations/property_many2many.png rename to content/developer/tutorials/server_framework_101/07_relations/property_many2many.png diff --git a/content/developer/tutorials/getting_started/08_relations/property_many2one.png b/content/developer/tutorials/server_framework_101/07_relations/property_many2one.png similarity index 100% rename from content/developer/tutorials/getting_started/08_relations/property_many2one.png rename to content/developer/tutorials/server_framework_101/07_relations/property_many2one.png diff --git a/content/developer/tutorials/getting_started/08_relations/property_offer.png b/content/developer/tutorials/server_framework_101/07_relations/property_offer.png similarity index 100% rename from content/developer/tutorials/getting_started/08_relations/property_offer.png rename to content/developer/tutorials/server_framework_101/07_relations/property_offer.png diff --git a/content/developer/tutorials/getting_started/08_relations/property_tag.png b/content/developer/tutorials/server_framework_101/07_relations/property_tag.png similarity index 100% rename from content/developer/tutorials/getting_started/08_relations/property_tag.png rename to content/developer/tutorials/server_framework_101/07_relations/property_tag.png diff --git a/content/developer/tutorials/getting_started/08_relations/property_type.png b/content/developer/tutorials/server_framework_101/07_relations/property_type.png similarity index 100% rename from content/developer/tutorials/getting_started/08_relations/property_type.png rename to content/developer/tutorials/server_framework_101/07_relations/property_type.png diff --git a/content/developer/tutorials/getting_started/09_compute_onchange.rst b/content/developer/tutorials/server_framework_101/08_compute_onchange.rst similarity index 96% rename from content/developer/tutorials/getting_started/09_compute_onchange.rst rename to content/developer/tutorials/server_framework_101/08_compute_onchange.rst index a5b73f39c..a5ac62f5d 100644 --- a/content/developer/tutorials/getting_started/09_compute_onchange.rst +++ b/content/developer/tutorials/server_framework_101/08_compute_onchange.rst @@ -1,10 +1,8 @@ -.. _tutorials/getting_started/09_compute_onchange: - ======================================== -Chapter 9: Computed Fields And Onchanges +Chapter 8: Computed Fields And Onchanges ======================================== -The :ref:`relations between models ` are a key component of +The :doc:`relations between models <07_relations>` are a key component of any Odoo module. They are necessary for the modelization of any business case. However, we may want links between the fields within a given model. Sometimes the value of one field is determined from the values of other fields and other times we want to help the user with data entry. @@ -26,13 +24,13 @@ Computed Fields - In the property model, the total area and the best offer should be computed: - .. image:: 09_compute_onchange/compute.gif + .. image:: 08_compute_onchange/compute.gif :align: center :alt: Compute fields - In the property offer model, the validity date should be computed and can be updated: - .. image:: 09_compute_onchange/compute_inverse.gif + .. image:: 08_compute_onchange/compute_inverse.gif :align: center :alt: Compute field with inverse @@ -52,7 +50,7 @@ method should set the value of the computed field for every record in By convention, :attr:`~odoo.fields.Field.compute` methods are private, meaning that they cannot be called from the presentation tier, only from the business tier (see -:ref:`tutorials/getting_started/01_architecture`). Private methods have a name starting with an +:ref:`tutorials/server_framework_101/01_architecture`). Private methods have a name starting with an underscore ``_``. Dependencies @@ -230,7 +228,7 @@ Onchanges **Goal**: at the end of this section, enabling the garden will set a default area of 10 and an orientation to North. - .. image:: 09_compute_onchange/onchange.gif + .. image:: 08_compute_onchange/onchange.gif :align: center :alt: Onchange @@ -301,5 +299,5 @@ When using stored computed fields, pay close attention to the dependencies. When depend on other computed fields, changing a value can trigger a large number of recomputations. This leads to poor performance. -In the :ref:`next chapter `, we'll see how we can trigger some +In the :doc:`next chapter <09_actions>`, we'll see how we can trigger some business logic when buttons are clicked. diff --git a/content/developer/tutorials/getting_started/09_compute_onchange/compute.gif b/content/developer/tutorials/server_framework_101/08_compute_onchange/compute.gif similarity index 100% rename from content/developer/tutorials/getting_started/09_compute_onchange/compute.gif rename to content/developer/tutorials/server_framework_101/08_compute_onchange/compute.gif diff --git a/content/developer/tutorials/getting_started/09_compute_onchange/compute_inverse.gif b/content/developer/tutorials/server_framework_101/08_compute_onchange/compute_inverse.gif similarity index 100% rename from content/developer/tutorials/getting_started/09_compute_onchange/compute_inverse.gif rename to content/developer/tutorials/server_framework_101/08_compute_onchange/compute_inverse.gif diff --git a/content/developer/tutorials/getting_started/09_compute_onchange/onchange.gif b/content/developer/tutorials/server_framework_101/08_compute_onchange/onchange.gif similarity index 100% rename from content/developer/tutorials/getting_started/09_compute_onchange/onchange.gif rename to content/developer/tutorials/server_framework_101/08_compute_onchange/onchange.gif diff --git a/content/developer/tutorials/getting_started/10_actions.rst b/content/developer/tutorials/server_framework_101/09_actions.rst similarity index 90% rename from content/developer/tutorials/getting_started/10_actions.rst rename to content/developer/tutorials/server_framework_101/09_actions.rst index c1820eec0..9fc86d913 100644 --- a/content/developer/tutorials/getting_started/10_actions.rst +++ b/content/developer/tutorials/server_framework_101/09_actions.rst @@ -1,11 +1,9 @@ -.. _tutorials/getting_started/10_actions: - ================================== -Chapter 10: Ready For Some Action? +Chapter 9: Ready For Some Action? ================================== So far we have mostly built our module by declaring fields and views. We just introduced business -logic in the :ref:`previous chapter ` thanks to +logic in the :doc:`previous chapter <08_compute_onchange>` thanks to computed fields and onchanges. In any real business scenario, we would want to link some business logic to action buttons. In our real estate example, we would like to be able to: @@ -28,7 +26,7 @@ Object Type - You should be able to cancel or set a property as sold: - .. image:: 10_actions/property.gif + .. image:: 09_actions/property.gif :align: center :alt: Cancel and set to sold @@ -37,13 +35,13 @@ Object Type - You should be able to accept or refuse an offer: - .. image:: 10_actions/offer_01.gif + .. image:: 09_actions/offer_01.gif :align: center :alt: Accept or refuse an offer - Once an offer is accepted, the selling price and the buyer should be set: - .. image:: 10_actions/offer_02.gif + .. image:: 09_actions/offer_02.gif :align: center :alt: Accept an offer @@ -125,7 +123,7 @@ and its Action Type =========== -In :ref:`tutorials/getting_started/06_firstui`, we created an action that was linked to a menu. You +In :doc:`05_firstui`, we created an action that was linked to a menu. You may be wondering if it is possible to link an action to a button. Good news, it is! One way to do it is: @@ -135,5 +133,5 @@ is: We use ``type="action"`` and we refer to the :term:`external identifier` in the ``name``. -In the :ref:`next chapter ` we'll see how we can prevent +In the :doc:`next chapter <10_constraints>` we'll see how we can prevent encoding incorrect data in Odoo. diff --git a/content/developer/tutorials/getting_started/10_actions/offer_01.gif b/content/developer/tutorials/server_framework_101/09_actions/offer_01.gif similarity index 100% rename from content/developer/tutorials/getting_started/10_actions/offer_01.gif rename to content/developer/tutorials/server_framework_101/09_actions/offer_01.gif diff --git a/content/developer/tutorials/getting_started/10_actions/offer_02.gif b/content/developer/tutorials/server_framework_101/09_actions/offer_02.gif similarity index 100% rename from content/developer/tutorials/getting_started/10_actions/offer_02.gif rename to content/developer/tutorials/server_framework_101/09_actions/offer_02.gif diff --git a/content/developer/tutorials/getting_started/10_actions/property.gif b/content/developer/tutorials/server_framework_101/09_actions/property.gif similarity index 100% rename from content/developer/tutorials/getting_started/10_actions/property.gif rename to content/developer/tutorials/server_framework_101/09_actions/property.gif diff --git a/content/developer/tutorials/getting_started/11_constraints.rst b/content/developer/tutorials/server_framework_101/10_constraints.rst similarity index 92% rename from content/developer/tutorials/getting_started/11_constraints.rst rename to content/developer/tutorials/server_framework_101/10_constraints.rst index 02fd5f783..b6f5f771e 100644 --- a/content/developer/tutorials/getting_started/11_constraints.rst +++ b/content/developer/tutorials/server_framework_101/10_constraints.rst @@ -1,10 +1,8 @@ -.. _tutorials/getting_started/11_constraints: - ======================= -Chapter 11: Constraints +Chapter 10: Constraints ======================= -The :ref:`previous chapter ` introduced the ability to add +The :doc:`previous chapter <09_actions>` introduced the ability to add some business logic to our model. We can now link buttons to business code, but how can we prevent users from entering incorrect data? For example, in our real estate module nothing prevents users from setting a negative expected price. @@ -25,13 +23,13 @@ SQL - Amounts should be (strictly) positive - .. image:: 11_constraints/sql_01.gif + .. image:: 10_constraints/sql_01.gif :align: center :alt: Constraints on amounts - Property types and tags should have a unique name - .. image:: 11_constraints/sql_02.gif + .. image:: 10_constraints/sql_02.gif :align: center :alt: Constraints on names @@ -76,7 +74,7 @@ Python **Goal**: at the end of this section, it will not be possible to accept an offer lower than 90% of the expected price. - .. image:: 11_constraints/python.gif + .. image:: 10_constraints/python.gif :align: center :alt: Python constraint @@ -123,7 +121,7 @@ prefer SQL over Python constraints. Our real estate module is starting to look good. We added some business logic, and now we make sure the data is consistent. However, the user interface is still a bit rough. Let's see how we can -improve it in the :ref:`next chapter `. +improve it in the :doc:`next chapter <11_sprinkles>`. .. _PostgreSQL's documentation: .. _table_constraint: diff --git a/content/developer/tutorials/getting_started/11_constraints/python.gif b/content/developer/tutorials/server_framework_101/10_constraints/python.gif similarity index 100% rename from content/developer/tutorials/getting_started/11_constraints/python.gif rename to content/developer/tutorials/server_framework_101/10_constraints/python.gif diff --git a/content/developer/tutorials/getting_started/11_constraints/sql_01.gif b/content/developer/tutorials/server_framework_101/10_constraints/sql_01.gif similarity index 100% rename from content/developer/tutorials/getting_started/11_constraints/sql_01.gif rename to content/developer/tutorials/server_framework_101/10_constraints/sql_01.gif diff --git a/content/developer/tutorials/getting_started/11_constraints/sql_02.gif b/content/developer/tutorials/server_framework_101/10_constraints/sql_02.gif similarity index 100% rename from content/developer/tutorials/getting_started/11_constraints/sql_02.gif rename to content/developer/tutorials/server_framework_101/10_constraints/sql_02.gif diff --git a/content/developer/tutorials/getting_started/12_sprinkles.rst b/content/developer/tutorials/server_framework_101/11_sprinkles.rst similarity index 95% rename from content/developer/tutorials/getting_started/12_sprinkles.rst rename to content/developer/tutorials/server_framework_101/11_sprinkles.rst index 567a8e871..32977b6a3 100644 --- a/content/developer/tutorials/getting_started/12_sprinkles.rst +++ b/content/developer/tutorials/server_framework_101/11_sprinkles.rst @@ -1,13 +1,11 @@ -.. _tutorials/getting_started/12_sprinkles: - ============================= -Chapter 12: Add The Sprinkles +Chapter 11: Add The Sprinkles ============================= Our real estate module now makes sense from a business perspective. We created -:ref:`specific views `, added several -:ref:`action buttons ` and -:ref:`constraints `. However our user interface is still a bit +:doc:`specific views <06_basicviews>`, added several +:doc:`action buttons <09_actions>` and +:doc:`constraints <10_constraints>`. However our user interface is still a bit rough. We would like to add some colors to the list views and make some fields and buttons conditionally disappear. For example, the 'Sold' and 'Cancel' buttons should disappear when the property is sold or canceled since it is no longer allowed to change the state at this point. @@ -27,7 +25,7 @@ Inline Views **Goal**: at the end of this section, a specific list of properties should be added to the property type view: - .. image:: 12_sprinkles/inline_view.png + .. image:: 11_sprinkles/inline_view.png :align: center :alt: Inline list view @@ -102,7 +100,7 @@ Widgets **Goal**: at the end of this section, the state of the property should be displayed using a specific widget: - .. image:: 12_sprinkles/widget.png + .. image:: 11_sprinkles/widget.png :align: center :alt: Statusbar widget @@ -241,7 +239,7 @@ Form - Conditional display of buttons and fields - Tag colors - .. image:: 12_sprinkles/form.gif + .. image:: 11_sprinkles/form.gif :align: center :alt: Form view with sprinkles @@ -269,7 +267,7 @@ behavior customizations, we can add the ``options`` attribute to several field w Have a look at the :ref:`FieldMany2ManyTags widget documentation ` for more info. -In :ref:`tutorials/getting_started/06_firstui`, we saw that reserved fields were used for +In :doc:`05_firstui`, we saw that reserved fields were used for specific behaviors. For example, the ``active`` field is used to automatically filter out inactive records. We added the ``state`` as a reserved field as well. It's now time to use it! A ``state`` field can be used in combination with an ``invisible`` attribute in the view to display @@ -322,11 +320,11 @@ List Additionally, offers and tags will be editable directly in the list, and the availability date will be hidden by default. - .. image:: 12_sprinkles/decoration.png + .. image:: 11_sprinkles/decoration.png :align: center :alt: List view with decorations and optional field - .. image:: 12_sprinkles/editable_list.gif + .. image:: 11_sprinkles/editable_list.gif :align: center :alt: Editable list @@ -392,7 +390,7 @@ Search and searching on the living area returns results where the area is larger than the given number. - .. image:: 12_sprinkles/search.gif + .. image:: 11_sprinkles/search.gif :align: center :alt: Default filters and domains @@ -440,7 +438,7 @@ Stat Buttons **Goal**: at the end of this section, there will be a stat button on the property type form view which shows the list of all offers related to properties of the given type when it is clicked on. - .. image:: 12_sprinkles/stat_button.gif + .. image:: 11_sprinkles/stat_button.gif :align: center :alt: Stat button @@ -505,7 +503,7 @@ Every time the partner name is changed, the description is modified. - Create a stat button on ``estate.property.type`` pointing to the ``estate.property.offer`` action. This means you should use the ``type="action"`` attribute (go back to the end of - :ref:`tutorials/getting_started/10_actions` if you need a refresher). + :doc:`09_actions` if you need a refresher). At this point, clicking on the stat button should display all offers. We still need to filter out the offers. @@ -514,8 +512,8 @@ Every time the partner name is changed, the description is modified. as equal to the ``active_id`` (= the current record, `here is an example `__) -Looking good? If not, don't worry, the :ref:`next chapter -` doesn't require stat buttons ;-) +Looking good? If not, don't worry, the :doc:`next chapter +<12_inheritance>` doesn't require stat buttons ;-) .. _order_by: https://www.postgresql.org/docs/12/queries-order.html diff --git a/content/developer/tutorials/getting_started/12_sprinkles/decoration.png b/content/developer/tutorials/server_framework_101/11_sprinkles/decoration.png similarity index 100% rename from content/developer/tutorials/getting_started/12_sprinkles/decoration.png rename to content/developer/tutorials/server_framework_101/11_sprinkles/decoration.png diff --git a/content/developer/tutorials/getting_started/12_sprinkles/editable_list.gif b/content/developer/tutorials/server_framework_101/11_sprinkles/editable_list.gif similarity index 100% rename from content/developer/tutorials/getting_started/12_sprinkles/editable_list.gif rename to content/developer/tutorials/server_framework_101/11_sprinkles/editable_list.gif diff --git a/content/developer/tutorials/getting_started/12_sprinkles/form.gif b/content/developer/tutorials/server_framework_101/11_sprinkles/form.gif similarity index 100% rename from content/developer/tutorials/getting_started/12_sprinkles/form.gif rename to content/developer/tutorials/server_framework_101/11_sprinkles/form.gif diff --git a/content/developer/tutorials/getting_started/12_sprinkles/inline_view.png b/content/developer/tutorials/server_framework_101/11_sprinkles/inline_view.png similarity index 100% rename from content/developer/tutorials/getting_started/12_sprinkles/inline_view.png rename to content/developer/tutorials/server_framework_101/11_sprinkles/inline_view.png diff --git a/content/developer/tutorials/getting_started/12_sprinkles/search.gif b/content/developer/tutorials/server_framework_101/11_sprinkles/search.gif similarity index 100% rename from content/developer/tutorials/getting_started/12_sprinkles/search.gif rename to content/developer/tutorials/server_framework_101/11_sprinkles/search.gif diff --git a/content/developer/tutorials/getting_started/12_sprinkles/stat_button.gif b/content/developer/tutorials/server_framework_101/11_sprinkles/stat_button.gif similarity index 100% rename from content/developer/tutorials/getting_started/12_sprinkles/stat_button.gif rename to content/developer/tutorials/server_framework_101/11_sprinkles/stat_button.gif diff --git a/content/developer/tutorials/getting_started/12_sprinkles/widget.png b/content/developer/tutorials/server_framework_101/11_sprinkles/widget.png similarity index 100% rename from content/developer/tutorials/getting_started/12_sprinkles/widget.png rename to content/developer/tutorials/server_framework_101/11_sprinkles/widget.png diff --git a/content/developer/tutorials/getting_started/13_inheritance.rst b/content/developer/tutorials/server_framework_101/12_inheritance.rst similarity index 96% rename from content/developer/tutorials/getting_started/13_inheritance.rst rename to content/developer/tutorials/server_framework_101/12_inheritance.rst index fbab169b4..31440969f 100644 --- a/content/developer/tutorials/getting_started/13_inheritance.rst +++ b/content/developer/tutorials/server_framework_101/12_inheritance.rst @@ -1,7 +1,5 @@ -.. _tutorials/getting_started/13_inheritance: - ======================= -Chapter 13: Inheritance +Chapter 12: Inheritance ======================= A powerful aspect of Odoo is its modularity. A module is dedicated to a business need, but @@ -21,14 +19,14 @@ Python Inheritance - It should not be possible to delete a property which is not new or canceled. - .. image:: 13_inheritance/unlink.gif + .. image:: 12_inheritance/unlink.gif :align: center :alt: Unlink - When an offer is created, the property state should change to 'Offer Received' - It should not be possible to create an offer with a lower price than an existing offer - .. image:: 13_inheritance/create.gif + .. image:: 12_inheritance/create.gif :align: center :alt: Create @@ -126,7 +124,7 @@ The second inheritance mechanism (delegation) allows every record of a model to to a parent model's record and provides transparent access to the fields of this parent record. -.. image:: 13_inheritance/inheritance_methods.png +.. image:: 12_inheritance/inheritance_methods.png :align: center :alt: Inheritance Methods @@ -173,7 +171,7 @@ View Inheritance **Goal**: at the end of this section, the list of available properties linked to a salesperson should be displayed in their user form view - .. image:: 13_inheritance/users.png + .. image:: 12_inheritance/users.png :align: center :alt: Users @@ -245,7 +243,7 @@ An example of a view inheritance extension can be found Inheritance is extensively used in Odoo due to its modular concept. Do not hesitate to read the corresponding documentation for more info! -In the :ref:`next chapter `, we will learn how to +In the :doc:`next chapter <13_other_module>`, we will learn how to interact with other modules. .. _XPath: https://w3.org/TR/xpath diff --git a/content/developer/tutorials/getting_started/13_inheritance/create.gif b/content/developer/tutorials/server_framework_101/12_inheritance/create.gif similarity index 100% rename from content/developer/tutorials/getting_started/13_inheritance/create.gif rename to content/developer/tutorials/server_framework_101/12_inheritance/create.gif diff --git a/content/developer/tutorials/getting_started/13_inheritance/inheritance_methods.png b/content/developer/tutorials/server_framework_101/12_inheritance/inheritance_methods.png similarity index 100% rename from content/developer/tutorials/getting_started/13_inheritance/inheritance_methods.png rename to content/developer/tutorials/server_framework_101/12_inheritance/inheritance_methods.png diff --git a/content/developer/tutorials/getting_started/13_inheritance/unlink.gif b/content/developer/tutorials/server_framework_101/12_inheritance/unlink.gif similarity index 100% rename from content/developer/tutorials/getting_started/13_inheritance/unlink.gif rename to content/developer/tutorials/server_framework_101/12_inheritance/unlink.gif diff --git a/content/developer/tutorials/getting_started/13_inheritance/users.png b/content/developer/tutorials/server_framework_101/12_inheritance/users.png similarity index 100% rename from content/developer/tutorials/getting_started/13_inheritance/users.png rename to content/developer/tutorials/server_framework_101/12_inheritance/users.png diff --git a/content/developer/tutorials/getting_started/14_other_module.rst b/content/developer/tutorials/server_framework_101/13_other_module.rst similarity index 89% rename from content/developer/tutorials/getting_started/14_other_module.rst rename to content/developer/tutorials/server_framework_101/13_other_module.rst index 6a8dd188c..f32e4a4f7 100644 --- a/content/developer/tutorials/getting_started/14_other_module.rst +++ b/content/developer/tutorials/server_framework_101/13_other_module.rst @@ -1,10 +1,8 @@ -.. _tutorials/getting_started/14_other_module: - ======================================= -Chapter 14: Interact With Other Modules +Chapter 13: Interact With Other Modules ======================================= -In the :ref:`previous chapter `, we used inheritance to +In the :doc:`previous chapter <12_inheritance>`, we used inheritance to modify the behavior of a module. In our real estate scenario, we would like to go a step further and be able to generate invoices for our customers. Odoo provides an Invoicing module, so it would be neat to create an invoice directly from our real estate module, i.e. once a property @@ -20,7 +18,7 @@ Concrete Example: Account Move - A new module ``estate_account`` should be created - When a property is sold, an invoice should be issued for the buyer - .. image:: 14_other_module/create_inv.gif + .. image:: 13_other_module/create_inv.gif :align: center :alt: Invoice creation @@ -42,14 +40,14 @@ independently. When both are installed, the link module provides the new feature For now, it will be an empty shell. Tip: you already did this at the - :ref:`beginning of the tutorial `. The process is very + :doc:`beginning of the tutorial <02_newapp>`. The process is very similar. When the ``estate_account`` module appears in the list, go ahead and install it! You'll notice that the Invoicing application is installed as well. This is expected since your module depends on it. If you uninstall the Invoicing application, your module will be uninstalled as well. -.. _tutorials/getting_started/14_other_module/create: +.. _tutorials/server_framework_101/13_other_module/create: Invoice Creation ---------------- @@ -57,12 +55,12 @@ Invoice Creation It's now time to generate the invoice. We want to add functionality to the ``estate.property`` model, i.e. we want to add some extra logic for when a property is sold. Does that sound familiar? If not, it's a good idea to go back to the -:ref:`previous chapter ` since you might have missed +:doc:`previous chapter <12_inheritance>` since you might have missed something ;-) As a first step, we need to extend the action called when pressing the -:ref:`'Sold' button ` on a property. To do so, we need to -create a :ref:`model inheritance ` in the `estate_account` +:doc:`'Sold' button <09_actions>` on a property. To do so, we need to +create a :doc:`model inheritance <12_inheritance>` in the `estate_account` module for the ``estate.property`` model. For now, the overridden action will simply return the ``super`` call. Maybe an example will make things clearer:: @@ -168,5 +166,5 @@ field ``line_ids`` at creation of a ``test_model``:: For each line, we need a ``name``, ``quantity`` and ``price_unit``. This chapter might be one of the most difficult that has been covered so far, but it is the closest -to what Odoo development will be in practice. In the :ref:`next chapter -`, we will introduce the templating mechanism used in Odoo. +to what Odoo development will be in practice. In the :doc:`next chapter +<14_qwebintro>`, we will introduce the templating mechanism used in Odoo. diff --git a/content/developer/tutorials/getting_started/14_other_module/create_inv.gif b/content/developer/tutorials/server_framework_101/13_other_module/create_inv.gif similarity index 100% rename from content/developer/tutorials/getting_started/14_other_module/create_inv.gif rename to content/developer/tutorials/server_framework_101/13_other_module/create_inv.gif diff --git a/content/developer/tutorials/getting_started/15_qwebintro.rst b/content/developer/tutorials/server_framework_101/14_qwebintro.rst similarity index 97% rename from content/developer/tutorials/getting_started/15_qwebintro.rst rename to content/developer/tutorials/server_framework_101/14_qwebintro.rst index 12fd3098b..b4643eb57 100644 --- a/content/developer/tutorials/getting_started/15_qwebintro.rst +++ b/content/developer/tutorials/server_framework_101/14_qwebintro.rst @@ -1,7 +1,5 @@ -.. _tutorials/getting_started/15_qwebintro: - =================================== -Chapter 15: A Brief History Of QWeb +Chapter 14: A Brief History Of QWeb =================================== So far the interface design of our real estate module has been rather limited. Building @@ -31,7 +29,7 @@ Concrete Example: A Kanban View **Goal**: at the end of this section a Kanban view of the properties should be created: - .. image:: 15_qwebintro/kanban.png + .. image:: 14_qwebintro/kanban.png :align: center :alt: Kanban view diff --git a/content/developer/tutorials/getting_started/15_qwebintro/kanban.png b/content/developer/tutorials/server_framework_101/14_qwebintro/kanban.png similarity index 100% rename from content/developer/tutorials/getting_started/15_qwebintro/kanban.png rename to content/developer/tutorials/server_framework_101/14_qwebintro/kanban.png diff --git a/content/developer/tutorials/getting_started/16_final_word.rst b/content/developer/tutorials/server_framework_101/15_final_word.rst similarity index 93% rename from content/developer/tutorials/getting_started/16_final_word.rst rename to content/developer/tutorials/server_framework_101/15_final_word.rst index 80a9d1f34..57ae22961 100644 --- a/content/developer/tutorials/getting_started/16_final_word.rst +++ b/content/developer/tutorials/server_framework_101/15_final_word.rst @@ -1,7 +1,5 @@ -.. _tutorials/getting_started/16_final_word: - ========================== -Chapter 16: The final word +Chapter 15: The final word ========================== Coding guidelines diff --git a/content/developer/tutorials/getting_started/02_setup.rst b/content/developer/tutorials/setup_guide.rst similarity index 87% rename from content/developer/tutorials/getting_started/02_setup.rst rename to content/developer/tutorials/setup_guide.rst index aa9920299..a1d56720d 100644 --- a/content/developer/tutorials/getting_started/02_setup.rst +++ b/content/developer/tutorials/setup_guide.rst @@ -1,28 +1,28 @@ -======================================== -Chapter 2: Development environment setup -======================================== +=========== +Setup guide +=========== Depending on the intended use case, there are multiple ways to install Odoo. For developers of the Odoo community and Odoo employees alike, the preferred way is to perform a source install (:dfn:`running Odoo from the source code`). -Prepare the environment -======================= +.. important:: + Follow the :ref:`contributing/development/setup` section of the contributing guide to prepare + your environment for pushing local changes to the Odoo repositories. -First, follow the :ref:`contributing/development/setup` section of the contributing guide to prepare -your environment. +Adapt the environment for the tutorials +======================================= By now, you should have downloaded the source code into two local repositories, one for `odoo/odoo` and one for `odoo/enterprise`. These repositories are set up to push changes to pre-defined forks on GitHub. This will prove to be convenient when you start contributing to the codebase, but -for the scope of this tutorial, we want to avoid polluting them with training material. Let's then -develop your own module in a third repository `odoo/tutorials`. Like the first two repositories, -it will be part of the `addons-path` that references all directories containing Odoo modules. -In this repository, we will create our first module! +in the scope of following a tutorial, we want to avoid polluting them with training material. Let's +then push your changes in a third repository: `odoo/tutorials`. Like the first two repositories, it +will be part of the `addons-path` that references all directories containing Odoo modules. .. note:: - - This repository also already contains some bare modules that will be used in other tutorials. + Depending on the tutorial that you are following, you might not need to install all the modules + that this repository contains. #. Following the same process as with the `odoo/odoo` and `odoo/enterprise` repositories, clone the `odoo/tutorials` repository on your machine with: @@ -147,10 +147,6 @@ the server. In this training you will only need some of them. (comma-separated list). This is equivalent to going to :guilabel:`Apps` in the user interface, selecting a module, and upgrading it from there. -.. note:: - For now you cannot add `../technical-training-sandbox` to your `addons-path` as it is empty - and will result into an invalid addons-path folder error, but you will have to add it back later on ! - Log in to Odoo -------------- @@ -167,14 +163,8 @@ Enable the developer mode ========================= The developer or debug mode is useful for training as it gives access to additional (advanced) -tools. In the next chapters, **we will always assume that you have enabled the developer mode**. - -:ref:`Enable the developer mode ` now. Choose the method that you prefer; they are -all equivalent. - -.. note:: - The main page of the Settings screen is only accessible if at least one application is installed. - You will be led into installing your own application in the next chapter. +tools. :ref:`Enable the developer mode ` now. Choose the method that you prefer; +they are all equivalent. Extra tools =========== @@ -318,6 +308,3 @@ Here is a list of commands: .. option:: q(uit) Quit the debugger. The program being executed is aborted. - -Now that your server is running, it's time to start :ref:`writing your own application -`! diff --git a/content/developer/tutorials/unit_tests.rst b/content/developer/tutorials/unit_tests.rst index 19969e83f..5448b3b95 100644 --- a/content/developer/tutorials/unit_tests.rst +++ b/content/developer/tutorials/unit_tests.rst @@ -3,11 +3,9 @@ Safeguard your code with unit tests =================================== .. important:: - This tutorial is an extension of the :doc:`getting_started` tutorial. Make sure you have + This tutorial is an extension of the :doc:`server_framework_101` tutorial. Make sure you have completed it and use the `estate` module you have built as a base for the exercises in this - tutorial. Fetch the branch `{BRANCH}-core` from the `technical-training-solutions - `_ repository if you - want to start from a clean base. + tutorial. **Reference**: `Odoo's Test Framework: Learn Best Practices `__ diff --git a/content/developer/tutorials/website.rst b/content/developer/tutorials/website.rst index 9e0c324d8..3c6a09109 100644 --- a/content/developer/tutorials/website.rst +++ b/content/developer/tutorials/website.rst @@ -5,7 +5,7 @@ Building a Website ================== .. danger:: - This tutorial is outdated. We recommend reading :doc:`getting_started` instead. + This tutorial is outdated. We recommend reading :doc:`server_framework_101` instead. .. warning:: diff --git a/extensions/odoo_theme/layout_templates/homepage.html b/extensions/odoo_theme/layout_templates/homepage.html index 9f5f4b4c7..09df56e4c 100644 --- a/extensions/odoo_theme/layout_templates/homepage.html +++ b/extensions/odoo_theme/layout_templates/homepage.html @@ -62,31 +62,26 @@

{{ _("Developer") }}

-

{{ _("Learn to develop in Odoo by reading the framework references and programmer tutorials.") }}

+

{{ _("Learn to develop in Odoo with the developer tutorials and framework references.") }}

{{ _("Top Links") }}
  • - - {{ _("Tutorial: Getting started") }} + + {{ _("Tutorials") }}
  • - - {{ _("ORM") }} + + {{ _("How-to guides") }}
  • - - {{ _("Regular Views") }} + + {{ _("Reference") }}
  • - - {{ _("QWeb Views") }} - -
    • -
  • - + {{ _("External API") }}
    • diff --git a/redirects/17.0.txt b/redirects/17.0.txt index eb098d3c9..b19e99b9d 100644 --- a/redirects/17.0.txt +++ b/redirects/17.0.txt @@ -3,6 +3,26 @@ developer/reference/backend/views.rst developer/reference/user_interface/view_records.rst developer/reference/user_interface/view_architecture.rst developer/reference/user_interface/view_architectures.rst +# developer/tutorials + +developer/tutorials/getting_started.rst developer/tutorials/server_framework_101.rst +developer/tutorials/getting_started/01_architecture.rst developer/tutorials/server_framework_101/01_architecture.rst +developer/tutorials/getting_started/02_setup.rst developer/tutorials/setup_guide.rst +developer/tutorials/getting_started/03_newapp.rst developer/tutorials/server_framework_101/02_newapp.rst +developer/tutorials/getting_started/04_basicmodel.rst developer/tutorials/server_framework_101/03_basicmodel.rst +developer/tutorials/getting_started/05_securityintro.rst developer/tutorials/server_framework_101/04_securityintro.rst +developer/tutorials/getting_started/06_firstui.rst developer/tutorials/server_framework_101/05_firstui.rst +developer/tutorials/getting_started/07_basicviews.rst developer/tutorials/server_framework_101/06_basicviews.rst +developer/tutorials/getting_started/08_relations.rst developer/tutorials/server_framework_101/07_relations.rst +developer/tutorials/getting_started/09_compute_onchange.rst developer/tutorials/server_framework_101/08_compute_onchange.rst +developer/tutorials/getting_started/10_actions.rst developer/tutorials/server_framework_101/09_actions.rst +developer/tutorials/getting_started/11_constraints.rst developer/tutorials/server_framework_101/10_constraints.rst +developer/tutorials/getting_started/12_sprinkles.rst developer/tutorials/server_framework_101/11_sprinkles.rst +developer/tutorials/getting_started/13_inheritance.rst developer/tutorials/server_framework_101/12_inheritance.rst +developer/tutorials/getting_started/14_other_module.rst developer/tutorials/server_framework_101/13_other_module.rst +developer/tutorials/getting_started/15_qwebintro.rst developer/tutorials/server_framework_101/14_qwebintro.rst +developer/tutorials/getting_started/16_final_word.rst developer/tutorials/server_framework_101/15_final_word.rst + # applications/inventory_and_mrp applications/inventory_and_mrp/inventory/warehouses_storage/advanced_operations_warehouse/closest_location.rst applications/inventory_and_mrp/inventory/warehouses_storage/removal_strategies/closest_location.rst # advanced_operations_warehouse/* --> removal_strategies/*