Commit Graph

34 Commits

Author SHA1 Message Date
samueljlieber
194ed8085a [FIX] clean unused resource files
X-original-commit: a4b841afce
Part-of: odoo/documentation#12082
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2025-02-14 21:59:10 +00:00
Aaron Bohy
ace11b6980 [IMP] developer/../view_architectures: add overflow option
This commit documents the new `overflow` option of the calendar
view.

Associated PR: odoo/odoo#197274
Task-4564270

closes odoo/documentation#12024

Signed-off-by: Aaron Bohy (aab) <aab@odoo.com>
2025-02-14 13:53:38 +00:00
Aaron Bohy
7d90b85f4f [IMP] developer/../view_architectures: show_date_picker option
This commit documents the newly added `show_date_picker` option in
the calendar view.

PR: https://github.com/odoo/odoo/pull/196945
Task-4510549

closes odoo/documentation#11985

Signed-off-by: Aaron Bohy (aab) <aab@odoo.com>
2025-02-10 08:23:51 +00:00
Aaron Bohy
d3664e0596 [IMP] developer/../view_architectures: improve calendar doc
This commit reworks the documentation of the calendar view, by
using a style which is more aligned with other views. We also
reworded and re-organized it.

Part-of: odoo/documentation#11985
Signed-off-by: Aaron Bohy (aab) <aab@odoo.com>
2025-02-10 08:23:51 +00:00
Rémy Voet (ryv)
2958013fa3 [IMP] orm: Deprecated read_group
Update documentation for the deprecatation of read_group.

closes odoo/documentation#11354

Related: odoo/odoo#163300
Related: odoo/enterprise#62388
Related: odoo/upgrade#6682
Signed-off-by: Rémy Voet (ryv) <ryv@odoo.com>
2025-02-05 13:54:00 +00:00
Aaron Bohy
366f1d4735 [IMP] developer/../view_architectures: new control feature
This commit updates the documentation related to the `control`
feature of list and kanban views, w.r.t. to recent changes on that
matter.

Linked to odoo/odoo#188619

task~4063960

closes odoo/documentation#11536

Signed-off-by: Aaron Bohy (aab) <aab@odoo.com>
2024-12-09 14:20:19 +00:00
Albaraa Maktabi
7c2a16b28d [FW][FIX] developer/view_architectures: fix a typo
Corrected a typo in the file view_architectures.rst on line 2395. Changed 'than' to 'that'.

closes odoo/documentation#11317

Forward-port-of: odoo/documentation#11314
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-11-04 15:09:23 +00:00
Gorash
f1a607a9c7 [IMP] *: Using class name corresponding to odoo models
closes odoo/documentation#11115

Related: odoo/odoo#178200
Related: odoo/enterprise#69762
Related: odoo/upgrade#6577
Related: odoo/design-themes#988
Related: odoo/upgrade-util#143
Signed-off-by: Christophe Matthieu (chm) <chm@odoo.com>
2024-10-15 09:33:04 +00:00
Aaron Bohy
5765edca11 [IMP] reference/user_interface: rework kanban documentation
Following the new kanban API with `card` template.

Task~3992107

closes odoo/documentation#11081

Signed-off-by: Aaron Bohy (aab) <aab@odoo.com>
2024-09-25 08:09:21 +00:00
Gorash
f8a114b334 [IMP] all: replace <tree> in <list>
Remove historical error from semantically incorrect <tree>.

Viewtiverse
task-3599136
task-27709
task-3414068

closes odoo/documentation#8446

Related: odoo/odoo#159909
Related: odoo/enterprise#59787
Related: odoo/upgrade#5884
Signed-off-by: Christophe Matthieu (chm) <chm@odoo.com>
2024-09-10 06:01:21 +00:00
Aaron Bohy
a89ea48c8f [REM] reference/user_interface: remove banner_route
This commit removes the documentation about the banner_route view
attribute, which has been dropped in odoo/odoo#177244.

Task~4126004

closes odoo/documentation#10841

Related: odoo/enterprise#68621
Related: odoo/upgrade#6404
Signed-off-by: Aaron Bohy (aab) <aab@odoo.com>
2024-08-27 13:13:56 +00:00
Antoine Vandevenne (anv)
e661c7f66e [FIX] reference/view_architectures: remove outdated and broken link
The external link to `AbstractController` class was broken, both because
the placeholder substitution mechanism doesn't work in included RST
excerpts and because the class has long been removed.

Since it makes little sense to replace the link with another link to
the `useActionLinks` hook in the context of this reference doc, this
commit removes the link altogether, as well as the erroneous mention
of class limitations.

closes odoo/documentation#10733

X-original-commit: e7d2be6366
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-08-16 06:40:59 +00:00
Julien Carion (juca)
1e14a5b6f8 [IMP] web: replace attribute in form dialog footer
Task-4010906

closes odoo/documentation#10519

Signed-off-by: Julien Carion (juca) <juca@odoo.com>
2024-08-09 03:15:47 +00:00
sami odoo
a395e108ac [IMP] reference/user_interface: update documentation regarding widget in graph
This commit aims to update the documentation regarding the adaptability of
widgets in the graph view of Odoo.

Task-3861721

closes odoo/documentation#10608

X-original-commit: 9dc985ef47
Signed-off-by: Mathieu Duckerts-Antoine (dam) <dam@odoo.com>
2024-08-06 09:51:43 +00:00
Aaron Bohy
63789b0aa7 [IMP] reference/user_interface: adapt list width attr doc
This commit rewrittes the documentation of the `width` attribute
in list views, following recent changes [1]

[1] odoo/odoo#170511

closes odoo/documentation#10160

Signed-off-by: Aaron Bohy (aab) <aab@odoo.com>
2024-07-11 17:14:12 +00:00
Sam Lieber (sali)
03d435ea31 [IMP] reference/user_interface: 17.0 odoo ui icons
closes odoo/documentation#9830

X-original-commit: d506554ed0
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2024-06-17 14:46:20 +00:00
Aaron Bohy
a164b8ab65 [IMP] reference/user interface: remove kanban-tooltip doc
This feature has been dropped.

(Part of) task `3650117`

closes odoo/documentation#9604

Related: odoo/odoo#167751
Related: odoo/enterprise#63714
Signed-off-by: Aaron Bohy (aab) <aab@odoo.com>
2024-06-17 11:35:45 +00:00
Aaron Bohy
05500b1416 [IMP] reference/user interface: kanban: color attribute
(Part of) task `3650117`

Part-of: odoo/documentation#9604
Related: odoo/odoo#167751
Related: odoo/enterprise#63714
Signed-off-by: Aaron Bohy (aab) <aab@odoo.com>
2024-06-17 11:35:45 +00:00
Aaron Bohy
ce5a8d554d [IMP] reference/user interface: kanban: can_open attribute
(Part of) task `3650117`

Part-of: odoo/documentation#9604
Related: odoo/odoo#167751
Related: odoo/enterprise#63714
Signed-off-by: Aaron Bohy (aab) <aab@odoo.com>
2024-06-17 11:35:45 +00:00
Vincent Larcin
ac5f9cd28e [IMP] developer/view_architectures: new date filters
Task-3692123

closes odoo/documentation#9398

Related: odoo/odoo#156746
Related: odoo/enterprise#59901
Related: odoo/upgrade#6034
Signed-off-by: Vincent Larcin (vila) <vila@odoo.com>
2024-05-23 16:31:34 +00:00
Antoine Vandevenne (anv)
6332d389f9 [FIX] reference/view_architectures/*: remove nosearch meta directives
The `nosearch` meta directive is not fully supported in included files:
the generated file is excluded from search results, but the "nosearch"
term is present in the included content.

closes odoo/documentation#9191

X-original-commit: 298a222d00
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-05-07 07:08:25 +00:00
Antoine Vandevenne (anv)
57b7ca69d9 [IMP] developer: improve navigation in top-level pages
Prior to this commit, users had to either know in advance or guess the
location of the content they were looking for. Top-level pages of the
"Developer" section of the documentation, in particular the "Developer"
page itself, were listing their sub-pages without directions for users.

This commit brings the following changes to improve the navigation:
- add directions for users on the "Developer" page and list the three
  main categories of developer documentation ("Tutorials", "How-to
  guides", and "Reference") with explanations of their content and
  target audience;
- add categories for content cards on the "Tutorials" and "How-to
  guides" pages, and fine-tune the toctree of the "Reference" page to
  more easily locate specific topics;
- clarify what are the "Python framework" and the "JavaScript framework"
  by relabelling them to "Server framework" and "Web framework" on
  top-level pages, as some users were confused to find that the JS
  framework was not responsible for the server, and others that the
  documentation for QWeb template is located in the Python documentation;
- extract the "Setup guide" from the "Getting started" tutorial and
  rename the latter to "Server framework 101" to allow reusing the setup
  guide in other tutorials and make clear that the "Server framework 101"
  tutorial is not about the Web framework.

task-3802536

closes odoo/documentation#8712

X-original-commit: 7f623b6ad5
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Valeriya (vchu) <vchu@odoo.com>
2024-04-13 12:16:35 +00:00
Gorash
644cbd052f [IMP] base: required field (from view python expr) are add automatically
related to odoo/odoo#137031

closes odoo/documentation#6115

Related: odoo/enterprise#48832
Related: odoo/upgrade#5861
Signed-off-by: Raphael Collet <rco@odoo.com>
2024-04-08 19:17:56 +00:00
glovebx
3e4b026979 [FW][FIX] dev/view_architectures: domain attribute of search view fields
The domain in the `field` component cannot accept user-provided values or access self variables.
This commit removes the misleading sentence about it from the documentation.

closes odoo/documentation#8229

Forward-port-of: odoo/documentation#8193
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2024-03-22 03:08:58 +00:00
Rémy Voet (ryv)
99751542c7 [IMP] orm: renaming of group_operator -> aggregator
closes odoo/documentation#5541

Related: odoo/enterprise#46795
Related: odoo/odoo#127353
Signed-off-by: Rémy Voet (ryv) <ryv@odoo.com>
2024-02-08 11:24:50 +00:00
Julien Alardot (jual)
958fa599e1 [FIX] reference/user_interface: filter element name is mandatory
The filter element attribute 'name' is now required since
odoo/odoo/commit/4ddc3231

closes odoo/documentation#7523

X-original-commit: cbe72a69bb
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Julien Alardot (jual) <jual@odoo.com>
2024-01-24 10:52:51 +00:00
Antoine Vandevenne (anv)
14c0438764 [IMP] reference/user_interface: reformat and clarify views reference
In particular, the following changes are made:
- Use the `class` and `attribute` admonitions along with custom
  attributes to define classes, views' root attributes, views'
  components, and attribute values. This allows re-using the responsive
  design that was made for reference lists, and getting rid of the
  previous implementation that relied on class attributes, which were not
  intended for this usage and reduce readability while hindering further
  contributions due to a lack of flexibility (no admonitions,
  sub-attributes...)
- Use definition lists to define view types to allow for clearer and
  longer descriptions.
- Rewrite and restructure the explanations when there is a lack clarity.
- Extract duplicated content to included RST files.
- Display SVG images into dedicated admonitions.
- Fix RST and English mistakes.
- Rename `view_architecture` to `view_architectures`, as it lists all
  existing architectures and doesn't describe "the architecture of a
  view".
- Replace underscores with hyphens in image file names to improve SEO.

task-3458320

closes odoo/documentation#5237

closes odoo/documentation#7497

X-original-commit: a17eaf4c6f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-01-23 10:51:24 +00:00
ezoer
15beccfd50 [FW][FIX] developer/user_interface: fix typo in 'attribute'
closes odoo/documentation#7225

Forward-port-of: odoo/documentation#7190
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-01-03 17:43:34 +00:00
Audric Onockx (auon)
66b08cd4fd [IMP] developer: add "widget" attr to cohort field tag
Related PR: https://github.com/odoo/enterprise/pull/46693

task-3475463

closes odoo/documentation#6284

Related: odoo/enterprise#46693
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-11-07 13:03:52 +00:00
Mathieu Duckerts-Antoine
ae05fe478d [FIX] search panel: fix bad indentation
closes odoo/documentation#6204

X-original-commit: 82055c1f15
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-10-24 13:55:29 +00:00
Michael (mcm)
82fdeb62b5 [IMP] calendar view: update attributes
This commit renames the calendar attribute "quick_add" to "quick_create"
and adds the attribute "quick_create_view_id".

closes odoo/documentation#6105

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-10-12 09:49:47 +00:00
Pierre Rousseau
be064dff98 [IMP] list: add open_form_view to list attributes
Task-id 3063425

closes odoo/documentation#5671

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-08-29 11:10:54 +00:00
Gorash
83c2012f95 [IMP] reference: rewrite and move views documentation to user_interface/
The documentation of the views is redone in order to be up to date and
has allowed a better visualization of the task on the modifiers.

task-2495504

closes odoo/documentation#3523

Related: odoo/odoo#104741
Related: odoo/enterprise#35255
Related: odoo/upgrade#4884
Signed-off-by: Julien Castiaux (juc) <juc@odoo.com>
2023-08-18 09:49:36 +02:00
stefanorigano (SRI)
9571a32131 [IMP] scss: update, improve preexisting content
Add a new content focused on SCSS and user-interface.

- SCSS coding guidelines: regroup information already available (eg [1])
  or based on "oral tradition".
  The aim is not to establish new rules, ~99% of the current codebase
  is already compliant.

- SCSS inheritance: explain how SCSS assets management works in odoo.
  For example, people still find confusing that overrides are defined
  *before* the variable to customize.

- SCSS optimization tips: suggestions to lean SCSS code. Based on SCSS
  optimization task's know-how [2].

- CSS variables: explain how this feature is commonly used in odoo to
  adapt layout & design without raw CSS overrides.

- UI Icons: Add link to fontAwesome4 library . Replace the picture of
  odoo icons with the actual font (90kb image VS 15Kb font)

[1] https://github.com/odoo/odoo/wiki/SCSS-coding-guidelines
[2] https://www.odoo.com/web#id=2704984&menu_id=4720&cids=1&model=project.task&view_type=form

task-3090800

closes odoo/documentation#3327

X-original-commit: 2ca32b40bc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-13 17:33:02 +01:00