diff --git a/content/developer/reference/frontend/framework_overview.rst b/content/developer/reference/frontend/framework_overview.rst index c57e2ad5f..7d6e8ff3e 100644 --- a/content/developer/reference/frontend/framework_overview.rst +++ b/content/developer/reference/frontend/framework_overview.rst @@ -110,7 +110,7 @@ the shared ``env`` object: * - `bus` - :ref:`main bus `, used to coordinate some generic events * - `services` - - all deployed :ref:`services ` (should usually be accessed + - all deployed :ref:`services ` (should usually be accessed with the `useService` hook) * - `debug` - string. If non empty, the web client is in :ref:`debug mode ` @@ -144,11 +144,11 @@ services, components and hooks. Registries ---------- -Registries are basically a simple key/value mapping that stores some specific -kind of objects. They are an important part of the extensibility of the UI: -once some object is registered, the rest of the web client can use it. For -example, the field registry contains all field components (or widgets) that -can be used in views. +:ref:`Registries ` are basically a simple key/value mapping +that stores some specific kind of objects. They are an important part of the +extensibility of the UI: once some object is registered, the rest of the web +client can use it. For example, the field registry contains all field components +(or widgets) that can be used in views. .. code-block:: javascript @@ -166,12 +166,12 @@ sub registry ``fields``. Services -------- -Services are long lived pieces of code that provide a feature. They may be -imported by components (with ``useService``) or by other services. Also, they -can declare a set of dependencies. In that sense, services are basically a DI -(dependency injection) system. For example, the ``notification`` service -provides a way to display a notification, or the ``rpc`` service is the proper -way to perform a request to the Odoo server. +:ref:`Services ` are long lived pieces of code that provide a +feature. They may be imported by components (with ``useService``) or by other +services. Also, they can declare a set of dependencies. In that sense, services +are basically a DI (dependency injection) system. For example, the ``notification`` +service provides a way to display a notification, or the ``rpc`` service is the +proper way to perform a request to the Odoo server. The following example registers a simple service that displays a notification every 5 second: @@ -195,7 +195,7 @@ every 5 second: Components and Hooks -------------------- -Components and hooks are ideas coming from the +:ref:`Components ` and :ref:`hooks ` are ideas coming from the `Owl component system `_. Odoo components are simply owl components that are part of the web client. diff --git a/content/developer/reference/frontend/hooks.rst b/content/developer/reference/frontend/hooks.rst index 24e43245c..8cfd7e213 100644 --- a/content/developer/reference/frontend/hooks.rst +++ b/content/developer/reference/frontend/hooks.rst @@ -1,3 +1,5 @@ +.. _frontend/hooks: + ===== Hooks ===== diff --git a/content/developer/reference/frontend/owl_components.rst b/content/developer/reference/frontend/owl_components.rst index 0b9f15b6a..a66a0b4a5 100644 --- a/content/developer/reference/frontend/owl_components.rst +++ b/content/developer/reference/frontend/owl_components.rst @@ -1,3 +1,4 @@ +.. _frontend/components: ============== Owl Components diff --git a/content/developer/reference/frontend/registries.rst b/content/developer/reference/frontend/registries.rst index 22ceec15d..e696f4194 100644 --- a/content/developer/reference/frontend/registries.rst +++ b/content/developer/reference/frontend/registries.rst @@ -1,3 +1,5 @@ +.. _frontend/registries: + ========== Registries ========== @@ -147,7 +149,7 @@ Service registry ---------------- The service registry (category: `services`) contains all -:ref:`services ` that should be activated by the Odoo +:ref:`services ` that should be activated by the Odoo framework. .. code-block:: javascript @@ -244,5 +246,8 @@ Example: }; } -:ref:`Effect registry` ---------------------------------------------------------- \ No newline at end of file +Effect registry +--------------- + +Contains the implementations of all available effects. See the section on the +:ref:`effect service ` for more details. \ No newline at end of file diff --git a/content/developer/reference/frontend/services.rst b/content/developer/reference/frontend/services.rst index 755aa3335..21778e198 100644 --- a/content/developer/reference/frontend/services.rst +++ b/content/developer/reference/frontend/services.rst @@ -1,5 +1,5 @@ -.. _javascript/services: +.. _frontend/services: ======== Services