NextERP/documentation
5
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update

Browse Source
This commit is contained in:
Hoàng
2025-02-28 02:35:19 +07:00
parent d9cb9d975f
commit 6b0c648c8e
9 changed files with 192 additions and 165 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/developer/reference/user_interface/view_architectures.md
+93 -93
View File
@@ -81,15 +81,15 @@ The root element of form views is `form`.
Optional attributes can be added to the root element `form` to customize the view.
```{eval-rst}
.. include:: view_architectures/root_attribute_string.rst
.. include:: view_architectures/root_attribute_string.md
```
```{eval-rst}
.. include:: view_architectures/root_attribute_create.rst
.. include:: view_architectures/root_attribute_create.md
```
```{eval-rst}
.. include:: view_architectures/root_attribute_edit.rst
.. include:: view_architectures/root_attribute_edit.md
```
```{eval-rst}
@@ -104,7 +104,7 @@ Optional attributes can be added to the root element `form` to customize the vie
```
```{eval-rst}
.. include:: view_architectures/root_attribute_delete.rst
.. include:: view_architectures/root_attribute_delete.md
```
```{eval-rst}
@@ -163,7 +163,7 @@ exist with different values for the `required` attribute.
The `field` element can have the following attributes:
```{eval-rst}
.. include:: view_architectures/field_attribute_name.rst
.. include:: view_architectures/field_attribute_name.md
```
```{eval-rst}
@@ -179,7 +179,7 @@ The `field` element can have the following attributes:
```
```{eval-rst}
.. include:: view_architectures/field_attribute_string.rst
.. include:: view_architectures/field_attribute_string.md
```
```{eval-rst}
@@ -214,19 +214,19 @@ The `field` element can have the following attributes:
```
```{eval-rst}
.. include:: view_architectures/field_attribute_readonly.rst
.. include:: view_architectures/field_attribute_readonly.md
```
```{eval-rst}
.. include:: view_architectures/field_attribute_required.rst
.. include:: view_architectures/field_attribute_required.md
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_invisible.rst
.. include:: view_architectures/generic_attribute_invisible.md
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_groups.rst
.. include:: view_architectures/generic_attribute_groups.md
```
```{eval-rst}
@@ -313,7 +313,7 @@ The `field` element can have the following attributes:
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_class.rst
.. include:: view_architectures/generic_attribute_class.md
```
```{eval-rst}
@@ -432,11 +432,11 @@ The `label` element can have the following attributes:
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_class.rst
.. include:: view_architectures/generic_attribute_class.md
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_invisible.rst
.. include:: view_architectures/generic_attribute_invisible.md
```
(reference-view-architectures-form-button)=
@@ -453,39 +453,39 @@ The `label` element can have the following attributes:
The `button` element can have the following attributes:
```{eval-rst}
.. include:: view_architectures/button_attribute_type.rst
.. include:: view_architectures/button_attribute_type.md
```
```{eval-rst}
.. include:: view_architectures/button_attribute_name.rst
.. include:: view_architectures/button_attribute_name.md
```
```{eval-rst}
.. include:: view_architectures/button_attribute_string.rst
.. include:: view_architectures/button_attribute_string.md
```
```{eval-rst}
.. include:: view_architectures/button_attribute_icon.rst
.. include:: view_architectures/button_attribute_icon.md
```
```{eval-rst}
.. include:: view_architectures/button_attribute_help.rst
.. include:: view_architectures/button_attribute_help.md
```
```{eval-rst}
.. include:: view_architectures/button_attribute_context.rst
.. include:: view_architectures/button_attribute_context.md
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_groups.rst
.. include:: view_architectures/generic_attribute_groups.md
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_invisible.rst
.. include:: view_architectures/generic_attribute_invisible.md
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_class.rst
.. include:: view_architectures/generic_attribute_class.md
```
```{eval-rst}
@@ -671,7 +671,7 @@ The `group` element can have the following attributes:
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_invisible.rst
.. include:: view_architectures/generic_attribute_invisible.md
```
:::{admonition} Possible structure and representation of its rendering
@@ -759,7 +759,7 @@ The `page` element can have the following attributes:
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_invisible.rst
.. include:: view_architectures/generic_attribute_invisible.md
```
:::{admonition} Possible structure and representation of its rendering
@@ -1112,11 +1112,11 @@ The `app` element can have the following attributes:
% todo: document attribute notApp
```{eval-rst}
.. include:: view_architectures/generic_attribute_groups.rst
.. include:: view_architectures/generic_attribute_groups.md
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_invisible.rst
.. include:: view_architectures/generic_attribute_invisible.md
```
(reference-view-architectures-settings-block)=
@@ -1163,11 +1163,11 @@ The `block` element can have the following attributes:
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_groups.rst
.. include:: view_architectures/generic_attribute_groups.md
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_invisible.rst
.. include:: view_architectures/generic_attribute_invisible.md
```
(reference-view-architectures-settings-setting)=
@@ -1279,11 +1279,11 @@ The `<setting>` element can have the following attributes:
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_groups.rst
.. include:: view_architectures/generic_attribute_groups.md
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_invisible.rst
.. include:: view_architectures/generic_attribute_invisible.md
```
(reference-view-architectures-list)=
@@ -1315,19 +1315,19 @@ The root element of list views is `list` (the previous name was `tree`).
Optional attributes can be added to the root element `list` to customize the view.
```{eval-rst}
.. include:: view_architectures/root_attribute_string.rst
.. include:: view_architectures/root_attribute_string.md
```
```{eval-rst}
.. include:: view_architectures/root_attribute_create.rst
.. include:: view_architectures/root_attribute_create.md
```
```{eval-rst}
.. include:: view_architectures/root_attribute_edit.rst
.. include:: view_architectures/root_attribute_edit.md
```
```{eval-rst}
.. include:: view_architectures/root_attribute_delete.rst
.. include:: view_architectures/root_attribute_delete.md
```
```{eval-rst}
@@ -1409,11 +1409,11 @@ Optional attributes can be added to the root element `list` to customize the vie
```
```{eval-rst}
.. include:: view_architectures/root_attribute_default_group_by.rst
.. include:: view_architectures/root_attribute_default_group_by.md
```
```{eval-rst}
.. include:: view_architectures/root_attribute_default_order.rst
.. include:: view_architectures/root_attribute_default_order.md
```
```{eval-rst}
@@ -1476,7 +1476,7 @@ Optional attributes can be added to the root element `list` to customize the vie
```
```{eval-rst}
.. include:: view_architectures/root_attribute_sample.rst
.. include:: view_architectures/root_attribute_sample.md
```
(reference-view-architectures-list-components)=
@@ -1510,11 +1510,11 @@ Using the same field multiple times in a list view is not supported
The `field` element can have the following attributes:
```{eval-rst}
.. include:: view_architectures/field_attribute_name.rst
.. include:: view_architectures/field_attribute_name.md
```
```{eval-rst}
.. include:: view_architectures/field_attribute_string.rst
.. include:: view_architectures/field_attribute_string.md
```
```{eval-rst}
@@ -1547,23 +1547,23 @@ The `field` element can have the following attributes:
```
```{eval-rst}
.. include:: view_architectures/field_attribute_readonly.rst
.. include:: view_architectures/field_attribute_readonly.md
```
```{eval-rst}
.. include:: view_architectures/field_attribute_required.rst
.. include:: view_architectures/field_attribute_required.md
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_invisible.rst
.. include:: view_architectures/generic_attribute_invisible.md
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_column_invisible.rst
.. include:: view_architectures/generic_attribute_column_invisible.md
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_groups.rst
.. include:: view_architectures/generic_attribute_groups.md
```
```{eval-rst}
@@ -1679,43 +1679,43 @@ form view, as they cannot be grouped.
The `button` element can have the following attributes:
```{eval-rst}
.. include:: view_architectures/button_attribute_type.rst
.. include:: view_architectures/button_attribute_type.md
```
```{eval-rst}
.. include:: view_architectures/button_attribute_name.rst
.. include:: view_architectures/button_attribute_name.md
```
```{eval-rst}
.. include:: view_architectures/button_attribute_string.rst
.. include:: view_architectures/button_attribute_string.md
```
```{eval-rst}
.. include:: view_architectures/button_attribute_icon.rst
.. include:: view_architectures/button_attribute_icon.md
```
```{eval-rst}
.. include:: view_architectures/button_attribute_help.rst
.. include:: view_architectures/button_attribute_help.md
```
```{eval-rst}
.. include:: view_architectures/button_attribute_context.rst
.. include:: view_architectures/button_attribute_context.md
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_groups.rst
.. include:: view_architectures/generic_attribute_groups.md
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_invisible.rst
.. include:: view_architectures/generic_attribute_invisible.md
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_column_invisible.rst
.. include:: view_architectures/generic_attribute_column_invisible.md
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_class.rst
.. include:: view_architectures/generic_attribute_class.md
```
:::{admonition} Possible structure and representation of its rendering
@@ -2011,7 +2011,7 @@ The `field` element can have the following attributes:
```
```{eval-rst}
.. include:: view_architectures/field_attribute_string.rst
.. include:: view_architectures/field_attribute_string.md
```
```{eval-rst}
@@ -2077,11 +2077,11 @@ The `field` element can have the following attributes:
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_groups.rst
.. include:: view_architectures/generic_attribute_groups.md
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_invisible.rst
.. include:: view_architectures/generic_attribute_invisible.md
```
:::{admonition} Possible structure and representation of its rendering
@@ -2307,11 +2307,11 @@ The `filter` element can have the following attributes:
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_invisible.rst
.. include:: view_architectures/generic_attribute_invisible.md
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_groups.rst
.. include:: view_architectures/generic_attribute_groups.md
```
```{eval-rst}
@@ -2455,7 +2455,7 @@ attributes:
```
```{eval-rst}
.. include:: view_architectures/field_attribute_string.rst
.. include:: view_architectures/field_attribute_string.md
```
```{eval-rst}
@@ -2481,7 +2481,7 @@ attributes:
```
```{eval-rst}
.. include:: view_architectures/generic_attribute_groups.rst
.. include:: view_architectures/generic_attribute_groups.md
```
```{eval-rst}
@@ -2673,27 +2673,27 @@ still be opened by the user.
Optional attributes can be added to the root element `kanban` to customize the view.
```{eval-rst}
.. include:: view_architectures/root_attribute_string.rst
.. include:: view_architectures/root_attribute_string.md
```
```{eval-rst}
.. include:: view_architectures/root_attribute_create.rst
.. include:: view_architectures/root_attribute_create.md
```
```{eval-rst}
.. include:: view_architectures/root_attribute_edit.rst
.. include:: view_architectures/root_attribute_edit.md
```
```{eval-rst}
.. include:: view_architectures/root_attribute_delete.rst
.. include:: view_architectures/root_attribute_delete.md
```
```{eval-rst}
.. include:: view_architectures/root_attribute_default_group_by.rst
.. include:: view_architectures/root_attribute_default_group_by.md
```
```{eval-rst}
.. include:: view_architectures/root_attribute_default_order.rst
.. include:: view_architectures/root_attribute_default_order.md
```
```{eval-rst}
@@ -2851,7 +2851,7 @@ Optional attributes can be added to the root element `kanban` to customize the v
```
```{eval-rst}
.. include:: view_architectures/root_attribute_sample.rst
.. include:: view_architectures/root_attribute_sample.md
```
(reference-view-architectures-kanban-components)=
@@ -2900,7 +2900,7 @@ Inside those templates, the `field` element allows to render a field. It can hav
attributes:
```{eval-rst}
.. include:: view_architectures/field_attribute_name.rst
.. include:: view_architectures/field_attribute_name.md
```
By default, field nodes are replaced by a `span` containing their formatted value, unless the
@@ -3345,7 +3345,7 @@ The main additions of qweb-as-view to the basic qweb-as-template are:
context:
```{eval-rst}
.. rst-class:: o-definition-list
.. container:: o-definition-list
```
`model`
@@ -3383,7 +3383,7 @@ record groups. Its root element is `<graph>` which can take the following
attributes:
```{eval-rst}
.. rst-class:: o-definition-list
.. container:: o-definition-list
```
`type` (optional)
@@ -3410,14 +3410,14 @@ attributes:
: string displayed in the breadcrumbs when redirecting to list view.
```{eval-rst}
.. include:: view_architectures/root_attribute_sample.rst
.. include:: view_architectures/root_attribute_sample.md
```
The only allowed element within a graph view is `field` which can have the
following attributes:
```{eval-rst}
.. rst-class:: o-definition-list
.. container:: o-definition-list
```
`name` (mandatory)
@@ -3475,7 +3475,7 @@ The pivot view is used to visualize aggregations as a [pivot table]. Its root
element is `<pivot>` which can take the following attributes:
```{eval-rst}
.. rst-class:: o-definition-list
.. container:: o-definition-list
```
`disable_linking` (optional)
@@ -3501,7 +3501,7 @@ The only allowed element within a pivot view is `field` which can have the
following attributes:
```{eval-rst}
.. rst-class:: o-definition-list
.. container:: o-definition-list
```
`name` (mandatory)
@@ -3520,7 +3520,7 @@ following attributes:
aggregated value within a group. Possible values are:
```{eval-rst}
.. rst-class:: o-definition-list
.. container:: o-definition-list
```
`row` (default)
@@ -3548,7 +3548,7 @@ following attributes:
such as fields in different units, e.g. € and \$).
```{eval-rst}
.. include:: view_architectures/root_attribute_sample.rst
.. include:: view_architectures/root_attribute_sample.md
```
The measures are automatically generated from the model fields; only the
@@ -3608,14 +3608,14 @@ calendar view are:
Disable/enable record deletion on the view through the **Action** dropdown.
.. rst-class:: o-definition-list
.. container:: o-definition-list
``date_start`` (required)
name of the record's field holding the start date for the event
```
```{eval-rst}
.. rst-class:: o-definition-list
.. container:: o-definition-list
```
`date_start` (required)
@@ -3697,7 +3697,7 @@ calendar view are:
Fields can have additional attributes:
```{eval-rst}
.. rst-class:: o-definition-list
.. container:: o-definition-list
```
`invisible`
@@ -3751,7 +3751,7 @@ The root element of the Activity view is `<activity>`, it accepts the following
attributes:
```{eval-rst}
.. rst-class:: o-definition-list
.. container:: o-definition-list
```
`string` (mandatory)
@@ -3761,7 +3761,7 @@ attributes:
Possible children of the view element are:
```{eval-rst}
.. rst-class:: o-definition-list
.. container:: o-definition-list
```
`field`
@@ -3772,7 +3772,7 @@ Possible children of the view element are:
Possible attributes are:
```{eval-rst}
.. rst-class:: o-definition-list
.. container:: o-definition-list
```
`name` (required)
@@ -3791,7 +3791,7 @@ Possible children of the view element are:
(see {ref}`reference/view_architectures/kanban` for more details):
```{eval-rst}
.. rst-class:: o-definition-list
.. container:: o-definition-list
```
`widget`
@@ -3838,7 +3838,7 @@ The root element of the Cohort view is \<cohort>, it accepts the following
attributes:
```{eval-rst}
.. rst-class:: o-definition-list
.. container:: o-definition-list
```
`string` (mandatory)
@@ -3888,7 +3888,7 @@ attributes:
main use is for hiding a field from the selectable measures:
```{eval-rst}
.. rst-class:: o-definition-list
.. container:: o-definition-list
```
`name` (mandatory)
@@ -3913,7 +3913,7 @@ attributes:
: alternate representations for a field's display.
```{eval-rst}
.. include:: view_architectures/root_attribute_sample.rst
.. include:: view_architectures/root_attribute_sample.md
```
(reference-view-architectures-grid)=
@@ -4274,14 +4274,14 @@ take the following attributes:
Disable/enable record deletion on the view through the **Action** dropdown.
.. rst-class:: o-definition-list
.. container:: o-definition-list
``date_start`` (required)
name of the field providing the start datetime of the event for each
```
```{eval-rst}
.. rst-class:: o-definition-list
.. container:: o-definition-list
```
`date_start` (required)
@@ -4466,7 +4466,7 @@ take the following attributes:
<reference/qweb/javascript>` and provides the following context variables:
```{eval-rst}
.. rst-class:: o-definition-list
.. container:: o-definition-list
```
`widget`
@@ -4517,7 +4517,7 @@ take the following attributes:
will display the users avatars next to their names when grouped by user_id.
```{eval-rst}
.. include:: view_architectures/root_attribute_sample.rst
.. include:: view_architectures/root_attribute_sample.md
```
(reference-view-architectures-map)=
@@ -4545,7 +4545,7 @@ As soon as a valid [MapBox] token is provided in the general settings the view s
The view's root element is `<map>`. It can have the following attributes:
```{eval-rst}
.. rst-class:: o-definition-list
.. container:: o-definition-list
```
`res_partner`
@@ -4583,7 +4583,7 @@ The view's root element is `<map>`. It can have the following attributes:
The `<map>` element can contain multiple `<field>` elements. Each `<field>` element is interpreted as a line in the pin's popup. The field's attributes are the following:
```{eval-rst}
.. rst-class:: o-definition-list
.. container:: o-definition-list
```
`name`