[IMP] general: add notes about dev mode toggle

closes odoo/documentation#3140

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit is contained in:
Sam Lieber (sali) 2022-12-07 19:55:01 +00:00
parent 0b9279d52f
commit dc3d43c143
8 changed files with 65 additions and 22 deletions

View File

@ -4,53 +4,96 @@
Developer Mode (debug mode) Developer Mode (debug mode)
=========================== ===========================
The developer mode (or debug mode) gives you access to extra and advanced tools. The developer mode (or debug mode) unlocks access to extra and advanced tools in Odoo. There are
several ways to activate the developer mode: through the
:ref:`settings <general/developer_mode/settings>`, the
:ref:`browser extension <general/developer_mode/browser-extension>`, through
the :ref:`command palette <general/developer_mode/command-palette>` or the
:ref:`URL <general/developer_mode/url>`.
.. _general/developer_mode/settings:
Activate through the Settings Activate through the Settings
============================= =============================
Go to :menuselection:`Settings --> Activate the developer mode`. The debug mode can be activated in the Odoo database settings. Go to :menuselection:`Settings -->
General Settings --> Developer Tools` and click on :guilabel:`Activate the developer mode`. At
least one application needs to be installed for the :guilabel:`Developer Tools` section to appear
in the :guilabel:`Settings` module.
.. image:: developer_mode/settings.png .. image:: developer_mode/settings.png
:align: center :align: center
:alt: Overview of the debug options under settings in Odoo :alt: Overview of the debug options under settings in Odoo.
.. note:: .. note::
*Activate the developer mode (with assets)* is used by developers; *Activate the developer mode :guilabel:`Activate the developer mode (with assets)` is used by developers; :guilabel:`Activate
(with tests assets)* is used by developers and testers. the developer mode (with tests assets)` is used by developers and testers.
Once activated, the *Deactivate the developer mode* option becomes available. Once activated, the :guilabel:`Deactivate the developer mode` option becomes available.
Activate through a browser extension .. _general/developer_mode/browser-extension:
Activate through the browser extension
======================================
Within a web browser, navigate to the browser settings and extensions and search for the `Odoo
Debug` extension. Once the extension is installed, a new icon will be shown on the browser's
toolbar.
For the *Odoo Debug* extension, a single click enables a normal version of the mode, while a
double click enables it with assets. To deactivate it, use a single click.
.. image:: developer_mode/developer-mode-monkey.png
:align: center
:alt: View of Odoo's debug icon in a Google Chrome toolbar.
.. _general/developer_mode/command-palette:
Activate through the command palette
==================================== ====================================
| Go to the settings and extensions of your web browser, and search for *Odoo Debug*. Once the In Odoo, the command palette tool has a command to activate the debug mode. First, open the command
extension is installed, a new icon will be shown on your toolbar. palette tool with the keyboard shortcut `ctrl+k` and then type `debug`. A command will show up to
| For the *Odoo Debug* extension, a single click enables a normal version of the mode, while a activate the debug mode.
double click enables it with assets. To deactivate it, use a single click.
.. image:: developer_mode/monkey.png .. image:: developer_mode/command-palette.png
:align: center :align: center
:alt: View of odoos debug icon in a chromes toolbar :alt: Command palette with debug command.
.. _general/developer_mode/url:
Activate through the URL Activate through the URL
======================== ========================
In the URL add ``?debug=1`` or ``?debug=true`` after *web*. The debug mode can also be activated by adding an extra query string to the database's URL. In the
URL, add `?debug=1` or `?debug=true` after `/web`. To deactivate the debug mode, change the
value to `?debug=0` instead.
.. image:: developer_mode/url.png .. image:: developer_mode/url.png
:align: center :align: center
:alt: Overview of an url with the debug mode command added in Odoo :alt: Overview of a URL with the debug mode command added.
.. tip:: .. tip::
Developers: type ``?debug=assets`` and activate the mode with assets. Additional modes are available for developers: `?debug=assets` enables the assets mode, and
`?debug=tests` enables the tests mode.
Locate the mode tools .. _developer-mode/mode-tools:
=====================
The Developer mode tools can be accessed from the *Open Developer Tools* button, located on the Locate the developer mode tools
header of your pages. ===============================
.. image:: developer_mode/button_location.png Once developer mode is activated, the developer mode tools can be accessed from the :guilabel:`Open
Developer Tools` button, the bug icon located in the header of the Odoo database.
.. image:: developer_mode/button-location.png
:align: center :align: center
:alt: Overview of a console page and the debug icon being shown in Odoo :alt: Overview of a console page and the debug icon being shown in Odoo.
This menu contains additional tools that are useful to understand or edit technical data, such as
the views or actions of a page. On a page that has filters, actions, and view options, the
developer mode tools contain some useful menu items such as:
- :guilabel:`Edit Action`
- :guilabel:`Manage Filters`
- Edit the current view (e.g. Kanban, List, Graph, etc.)
- See the :guilabel:`Fields View Get`

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 24 KiB