Commit Graph

296 Commits

Author SHA1 Message Date
Mohamed Alkobrosli
47edb88436 [FW][FIX] dev/assets: typo
the "py" letter should be "by" to make the syntax correct and understood.

closes odoo/documentation#8302

Forward-port-of: odoo/documentation#8276
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2024-03-22 07:27:11 +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
tiku-odoo
cbe068e3ab [IMP] developer: external api add admonition block
closes odoo/documentation#8240

X-original-commit: d6f5e74971
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-03-20 16:31:57 +00:00
Bastien Fafchamps (bafa)
df1f1dd6b6 [FIX] web: adapted Dropdown component documentation to new api
This commit adapts the documentation to reflect changes made to the Dropdown
component after its refactor, namely:
- Adapted props list
- Adapted code snippets
- Added DropdownGroup component documentation
- More consise examples

closes odoo/documentation#8156

Task-id: 3266145
Signed-off-by: Bastien Fafchamps (bafa) <bafa@odoo.com>
2024-03-20 16:31:55 +00:00
Louis (loti)
5bb97c3fcb [IMP] payment: render /payment/status entirely from the server
Previously, /payment/status would render a template on the server-side, and a JS widget would render subtemplates on the client-side and insert them in the server-side rendered template.

However, mixing server-side and client-side templates causes issues because the context is not properly communicated between client and server. It also makes the code more complex.

This change assumes that no new information returned by /payment/status is worth re-rendering part of the template. If the transaction moves from a pending ('draft', 'pending') state to a final state, the customer should be redirected to the final route that will display the updated information on the transaction.

task-3340354

closes odoo/documentation#8198

Related: odoo/upgrade#5829
Related: odoo/odoo#149821
Related: odoo/enterprise#58822
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-03-20 12:09:27 +00:00
Raphael Collet
cb948c7f05 [IMP] core: remove user_has_groups()
Simply align the documentation with the new API and usage of method
user.has_group().

closes odoo/documentation#8131

Related: odoo/odoo#151597
Related: odoo/upgrade#5616
Related: odoo/enterprise#55523
Signed-off-by: Raphael Collet <rco@odoo.com>
2024-03-15 14:29:11 +00:00
Pierre Pulinckx (PIPU)
bf79132249 [IMP] dev/testing: document new tour debug mode
In this commit, documentation about debug mode feature in tour
(implemented in https://github.com/odoo/odoo/pull/155082) is added.

closes odoo/documentation#7807

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-03-13 19:23:45 +00:00
Jonathan Castillo (jcs)
0249d9d0a6 [MOV] documentation structure reorganization
This commit aims to improve the documentation's navigability by
redefining some categories' purposes and titles.

There is a redirection rule for each documentation page moved.
This ensures that users won't have a 404 error message.

task-3217827

closes odoo/documentation#8064

Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2024-03-12 07:08:34 +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
Rémy Voet (ryv)
ad749706ec [IMP] orm: changelog about group/aggregate/order by no-store related fields
Part-of: odoo/documentation#5541
2024-02-08 11:24:50 +00:00
Michaël Mattiello
973d5800d2 [IMP] web: update javascript odoo modules
This commit adapts the javascript modules section with the last
update https://github.com/odoo/odoo/pull/142858 and some outdated
features.

closes odoo/documentation#7640

Signed-off-by: Michaël Mattiello (mcm) <mcm@odoo.com>
2024-02-06 15:53:40 +00:00
Augusto Perez
1febb15453 [ADD] Upgrade documentation: Upgrade scripts and Util package
closes odoo/documentation#7550

X-original-commit: 16a209c750
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-01-26 09:56:30 +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
Rémy Voet (ryv)
be60243eff [IMP] orm: update changelog for the new flush strategy
closes odoo/documentation#7194

Related: odoo/upgrade#5469
Related: odoo/odoo#144747
Related: odoo/enterprise#53380
Signed-off-by: Rémy Voet (ryv) <ryv@odoo.com>
2024-01-15 13:04:08 +00:00
Nathan Marotte (nama)
080dc64e54 [ADD] Upgrade documentation: How-to-guide for developers
closes odoo/documentation#7336

X-original-commit: 44f4683519
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-01-11 17:21:54 +00:00
Julien Castiaux
b0cc13d4fe [FIX] developer/reference/cli: log on stderr
Odoo is actually logging on sys.stderr and not sys.stdout[^1][^2][^3].

Remove passage about the workflows, the workflows were an OpenERP
feature removed almost a decade ago in odoo/odoo@98cb4719db.

Fixes: #7210

[^1]: b3b9b2b49e/odoo/netsvc.py (L156)
[^2]: b3b9b2b49e/odoo/netsvc.py (L198)
[^3]: https://docs.python.org/3/library/logging.handlers.html#logging.StreamHandler

closes odoo/documentation#7274

X-original-commit: c55e8f251a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Julien Castiaux (juc) <juc@odoo.com>
2024-01-04 23:00:59 +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
Géry Debongnie
045fb847e8 [IMP] Rework the JavaScript tutorials
This commit rework the entire JavaScript tutorial series with the
following improvements:

-   Each chapter is now designed to be independent, allowing learners to
    follow any chapter without the necessity of completing previous ones.
-   Each chapter has been transformed into a standalone module, enabling
    learners to create small projects from scratch within each chapter.
-   The screenshots/text/code have been updated for Odoo 17.

Currently we have 5 chapters:
- Discover Chapter 1 - Owl Components: This chapter allows to learn the
  Owl framework in the `awesome_owl` module.
- Discover Chapter 2 - Build a dashboard: This chapter allows to grasp
  the basic of the web framework by building a dashboard in the
  `awesome_dashboard` module.
- Master Chapter 1 - Build a clicker game: This chapter allows to grasp
  the web framework by building a clicker game in the `awesome_clicker`
  module.
- Master Chapter 2 - Create a gallery view: This chapter allows to learn
  how to create a new view type. The new view is a gallery of records
  pictures. It can be done in the `awesome_gallery` module.
- Master Chapter 3 - Customize a kanban view: This chapter allows to
  learn to customize a kanban view by implementing a list of customer in
  the side of a kanban view. This can be done in the `awesome_kanban`
  module.

The chapter on creating and customizing fields is deleted for now and
will be completely rewritten in a near future.
The chapter on testing is deleted, how-to guides will be written to
cover this subject.

The solutions for all exercises has been done for v17, the goal by
merging the new tutorial is to have this new branch structure in
`odoo/tutorials`:
- 16.0
- 16.0-solutions
- 17.0
- 17.0-discover-js-framework-solutions
- 17.0-master-odoo-web-framework-solutions
-   master <-- default branch, starting point for all addons
-   master-discover-js-framework-solutions
-   master-master-odoo-web-framework-solutions

closes odoo/documentation#6980

Task-id: 3623595
X-original-commit: 3d4a275196
Signed-off-by: Géry Debongnie <ged@odoo.com>
Signed-off-by: Florent Dardenne (dafl) <dafl@odoo.com>
2023-12-20 00:41:24 +00:00
Ken Geis
8c4cb060f0 [FW][FIX] developer/mixins: fix typo in XMLID
closes odoo/documentation#6875

Forward-port-of: odoo/documentation#6801
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-12-07 22:05:57 +00:00
Julien Castiaux
883442e483 [IMP] developer/reference/cli: --proxy-mode
Many customers struggle with their web server configuration, notably
regarding the `--proxy-mode` option and the way `X-Forwarded-*` HTTP
request headers are interpreted within Odoo.

The `--proxy-mode` section has been updated to cover the most common
misunderstandings and to give guidances on how to setup a web server.

Odoo always only takes the last entry of the `X-Forwarded-*` request
header because there are situations where it is not possible to
determine which last n-th entry to use. Employees might access their
odoo database via the internal network: connecting directly to nginx,
while customers might access the database via an additional proxy such
as cloudflare. The real IP of employees would be the last inside the
`X-Forwarded-For` chain, while the real IP of customers would be the
*second* last entry inside the chain. It would be incorrect to always
take the same nth last entry inside the chain. The cloudflare's own IP
address must be discarded from the chain. Web servers usually feature
a way to ignore trusted IP from the chain, a way so that the real IP
of the user is always the last entry inside the chain. Odoo relies on
such feature to be active and configured.

Prior discussions about `X-Forwarded-For`:
* odoo/odoo#104947
* odoo/odoo#118629
* odoo/odoo#139536

All `X-Forwarded-*` headers are ignored in case the `X-Forwarded-Host`
header is missing (even with `--proxy-mode`). System admin might be
tempted to not set this header and to set `Host` instead, this is
broken as this a user-agent would be able to spoof `X-Forwarded-Host`
and Odoo would use that instead of the correct `Host`.

Prior discussions about `X-Forwarded-Host`:
* odoo/odoo#63277
* odoo/odoo#70117

closes odoo/documentation#6744

X-original-commit: 3d91c57b57
Signed-off-by: Julien Castiaux (juc) <juc@odoo.com>
2023-12-03 08:26:12 +00:00
Raphael Collet
2b8a578c9b [IMP] core: add SQL wrapper
This completes https://github.com/odoo/odoo/pull/134677.

closes odoo/documentation#6724

X-original-commit: 2662fa5437
Signed-off-by: Raphael Collet <rco@odoo.com>
2023-12-01 11:54:08 +00:00
Rémy Voet (ryv)
7067cf372a [FIX] performance: change example with the new _read_group
closes odoo/documentation#6540

X-original-commit: 01625aa661
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Rémy Voet (ryv) <ryv@odoo.com>
2023-11-21 19:58:05 +00:00
Rémi Rahir (rar)
671cca36a6 [FIX] dev/reference: Fix external reference
The tour utils were red and moved in Odoo (odoo/odoo#107618).

closes odoo/documentation#6521

X-original-commit: 9be2b43adb
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Rémi Rahir (rar) <rar@odoo.com>
2023-11-21 09:36:04 +00:00
Rémy Voet (ryv)
d105f614af [IMP] orm: update changelog
closes odoo/documentation#6465

X-original-commit: f1960a250c
Signed-off-by: Rémy Voet (ryv) <ryv@odoo.com>
2023-11-15 12:35: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
Louis Baudoux
cdc510295c [IMP] extract_api: document the new API version
We have introduced a second version of the Extract API that adds the IAP
account token to the `get_result` and `validate` routes.

There are also other changes in this commit:
 - The deprecated stuff has been removed as it's been deprecated for a
   while and won't be supported anymore in the future.
 - The `status` table of the `get_result` route has been added as it was
   missing for some reason.
 - The documentation regarding the `/validate` routes have been removed
   for security reasons.

closes odoo/documentation#6283

X-original-commit: a8c6272899
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Louis Baudoux (lba) <lba@odoo.com>
2023-11-03 16:55:58 +00:00
Rémy Voet (ryv)
d53c676288 [FIX] developer: fix bad documentation of --unaccent
In the CLI, `--unaccent` try to enable PostgreSQL unaccent extention
when odoo is responsible to create new database(s).

closes odoo/documentation#6246

X-original-commit: 1639d22efd
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Rémy Voet (ryv) <ryv@odoo.com>
2023-10-31 08:06:49 +00:00
Martin Trigaux
ff23483846 [FIX] developer: adapt markup documentation
On how to combine Markup and translations
Note that this does not work before 17.0

closes odoo/documentation#6189

Related: odoo/odoo#139316
Related: odoo/enterprise#49379
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2023-10-24 21:10:00 +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
Louis Baudoux
f74a99bdf1 [FIX] extract_api: remove bill_reference from expense fields
The bill reference is no longer detected since a few months because it
had poor results and wasn't very useful.

closes odoo/documentation#6012

X-original-commit: cade61dd56
Signed-off-by: Louis Baudoux (lba) <lba@odoo.com>
2023-10-06 06:14:10 +00:00
Louis Baudoux
b5c77e129c [REM] extract_api: remove documentation of get_result_batch
For security reasons, we had to drop the support of those routes.

X-original-commit: 24c7b2506e
Part-of: odoo/documentation#6012
2023-10-06 06:14:10 +00:00
Antoine Vandevenne (anv)
13feb8018d [IMP] developer/reference/payment: add docstrings for payment_method
task-2882677

closes odoo/documentation#5717

Related: odoo/upgrade#5103
Related: odoo/odoo#120446
Related: odoo/enterprise#40666
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-09-22 13:32:51 +00:00
Romeo Fragomeli
5d9f8c5a7d [IMP] developer reference: update act_url action doc
This commit, reword the doc about `ir.actions.act_url` and add also the
new `download` value for the `target`.

closes odoo/documentation#5822

Related: odoo/odoo#134436
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-09-13 15:34:35 +00:00
Leloup Loïc (lole)
f18162fe2a [IMP] cli: add unit to memory options
The documentation is unclear about the unit used for the --limit-memory-soft
and --limit-memory-hard options of odoo-bin.  The unit used is bytes, but
it isn't mentioned and the default unit is shown in mebibytes, causing
confusion.

closes odoo/documentation#5794

X-original-commit: 9fadc3355d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-09-11 10:29:04 +00:00
Xavier Morel
2e595b52b4 [IMP] developer reference: update t-debug doc
The value of `t-debug` is now optional, and leaving it out means the
directive just invokes the `breakpoint` builtin, which was added in
3.7 and is configurable via an envvar or a hook callable.

closes odoo/documentation#5800

Related: odoo/odoo#134842
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-09-11 10:29:03 +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
Antoine Vandevenne (anv)
a5d10930d6 [REM] payment_providers: remove mentions of extra fees
task-3358581

closes odoo/documentation#5517

Related: odoo/odoo#132104
Related: odoo/upgrade#5053
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-08-19 09:07:03 +02:00
Xavier (XPL)
ea53f06197 [REF] install: move intro to main install page and split by install type
This PR moves the introduction about the different installation methods and editions found on the
install/install.rst page directly under the main install/ page. It creates three pages, one per
installation method documented on the install/install.rst page (Docker being documented on
docker.com and maintained by us), and moves the related content there. In addition, it fixes various
typos/grammar issues and improves the content according to the documentation guidelines. Various
references and links across the documentation had to be fixed accordingly.

task-3459070

closes odoo/documentation#5543

X-original-commit: 91c28fd433
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2023-08-19 07:58:45 +02: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
imanie383
f4e7830a92 [FW][FIX] reference/owl_components: fix typo
Making edits for Owl Components Doc : [Link](https://www.odoo.com/documentation/16.0/developer/reference/frontend/owl_components.html#example-multi-level-dropdown-nested)

![image](https://github.com/odoo/documentation/assets/35231827/b2dd4b87-941c-4241-b0f5-e91ca69b3633)

closes odoo/documentation#5475

Forward-port-of: odoo/documentation#5459
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-08-11 22:50:14 +02:00
Samuel Degueldre
eb63fd7629 [IMP] remove references to owl template tagging
In odoo/odoo#130467 the necessity to tag owl templates with an owl="1"
attribute has been removed, update the docs to reflect that.

closes odoo/documentation#5460

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-08-11 19:34:53 +02:00
Martin Trigaux
7f62e44002 [IMP] developer: document new parameter
closes odoo/documentation#5273

X-original-commit: bf5c888446
Related: odoo/odoo#130883
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2023-08-04 16:35:01 +02:00
Michael (mcm)
775e80ed92 [IMP] web: update documentation of patch function
This commit updates the documentation of the patch function
with the changes done in https://github.com/odoo/odoo/pull/125716.

closes odoo/documentation#5017

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-08-03 16:07:00 +02:00
Levi Siuzdak (sile)
dd7ab18b9e [IMP] developer: add notes on entity references & fix illegal XML
Using `<` inside XML elements will result in a parsing error,
an entity reference should be used instead: `&lt;`.

closes odoo/documentation#5184

X-original-commit: a7743d513b
Signed-off-by: Levi Siuzdak (sile) <sile@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-07-24 23:04:05 +02:00
Henrique Dias
9514d7df55 [FW][ADD] rpc: Go examples
Examples rely on `kolo/xmlrpc` as well as on the standard library package `log` to panic on error, matching snippets in other languages (which tend to raise exceptions).

As with other languages, only the RPC interaction is spelled out.

closes odoo/documentation#5129

Forward-port-of: odoo/documentation#5064
Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com>
2023-07-15 12:00:28 +02:00
Martin Trigaux
0031e37c63 [FIX] developer: document changes of message_post API
closes odoo/documentation#5119

X-original-commit: 8bf2d026b7
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2023-07-15 10:54:41 +02:00
Marc Durepos
9988d0b214 [FIX] Remove reference to assets_qweb in assets.rst
Reflects the fact that assets_qweb bundle is no longer used in 16.0

closes odoo/documentation#5109

X-original-commit: c85031b3fc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-07-13 19:28:18 +02:00
Leonardo Pavan Rocha
6462ed0112 [IMP] web: merge quick_add with quick_create_form_view id in views
https://github.com/odoo/odoo/pull/114827 added a new attribute
quick_create_form_view_id to the calendar view that would allow showing a form
view when clicking on quick_create. This attribute was only used in calendar,
however it could be useful for other modules as well. It was decided to merge
this new attribute with the quick_add attribute, as they are related. Now, the
quick_add attribute accepts either a boolean or a form view id. This commit
changes the documentation of this attribute.

task-3286969

closes odoo/documentation#4707

Related: odoo/odoo#122923
Signed-off-by: Arnaud Joset (arj) <arj@odoo.com>
2023-07-12 20:33:53 +02:00
Julien Mougenot
35aae86dbd [IMP] web: Owl DateTimePicker
This commit introduces a date picker OWL component meant to handle the
following use-cases:
- date picker
- date & time picker
- date range picker
- date & time range picker

Basically, this component is the union of the two previous third-party
libraries handling these cases: TempusDominus and DateRangePicker.

New components introduced:

* The main addition of this commit is the `DateTimePicker` itself which
handles the display and interactions of the calendar and time pickers.
> see @web/core/datetime/datetime_picker

* The picker can then be coupled to an input using the
`useDateTimePicker` hook. The purpose of this hook is to handle events
on a given input element and syncronize its value to a date picker it
will spawn in a popover.
> see @web/core/datetime/datetime_hook

* Lastly, a simple `DateTimeInput` component will render an input and
call the hook mentioned above to handle it. This component is
effectively replacing the previous DatePicker and DateTimePicker
components (note that it does not handle range values).
> see @web/core/datetime/datetime_input

Another noticeable change of this commit is the definition of daterange
fields in views:

- Previously, the arch would have to define both fields
and bind them via their options, while also adding an arrow between
inputs or other forms of connection.

- In the new implementation, only the start date field must be declared,
and a date range can be spawned by providing an `end_date_field` in its
options.

Example:
```xml
<field
    name="start_datetime"
    widget="daterange"
    options="{'end_date_field': 'end_datetime'}"
/>
```

warning Added limitations:

- this new way of declaring date ranges means that templates have been
revised to declare one field tag instead of two. This means that list
views using date ranges have lost the ability to be sorted on their end
date fields.

> Justification: the current use cases have been reviewed and it has
been decided that it was not needed to sort on the end date on the
affected list views.

> Workaround: drop the date range and declare both fields as simple date
pickers (i.e. without the end_date_field option).

- all modifiers applied to a field using a date range will be copied and
applied to the end date field. There is no way to define modifiers
specific to one field or the other.

> Justification: there was no use case where one of the two fields
needed specific modifiers.

> Workaround: same as the previous point: split the range into 2 simple
date picker fields.

Additional notes:

- the widget="daterange" is not mandatory in form views, but is required
in list views because only fields with explicit widgets will not be
rendered as simple <span> elements. The date range feature will be
available as soon as an end_date_field is specified.

- as the end date field is not explicitly defined in the view anymore,
any modifier depending on it need to have it defined as invisible
somewhere in the arch.

Task ID: 3121497

closes odoo/documentation#5013

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Julien Mougenot (jum) <jum@odoo.com>
2023-07-04 12:47:02 +02:00
Julien Mougenot
a9c82ebb94 [REF] web: update JS fields documentation
This commit updates the documentation of JS fields:

- style and notation have been adapted to keep in line with the current
documentation writing guidelines;

- some outdated bits have been updated or removed (this is rather a
correction of misleading information than a proper update as no new
information has been added).

Part-of: odoo/documentation#5013
2023-07-04 12:47:01 +02:00
Rémy Voet (ryv)
13544bca17 [IMP] orm: name_get into display_name
odoo/odoo#122085
odoo/enterprise#42599
odoo/upgrade#4780

closes odoo/documentation#4639

Signed-off-by: Rémy Voet (ryv) <ryv@odoo.com>
2023-06-28 17:41:15 +02:00
Benoit Socias
2161dd5acf [IMP] developer/views: add optional attribute for fields of list views
The attributes of fields of list views do not mention the `optional`
attribute while it is used by chapter 12 of the R&D Training.

This commit describes this `optional` attribute.

task-3380953

closes odoo/documentation#4912

X-original-commit: 5a446f5c59
Signed-off-by: Benoit Socias (bso) <bso@odoo.com>
2023-06-27 13:44:35 +02:00
Christophe Monniez
899ee1c4c1 [FIX] deploy: reference the config parameter
The deploy documentation is assuming that `/etc/odoo.conf` is the
default config file, which is not the case.

With this commit, the configuration file references the cli
documentation.

closes odoo/documentation#4808

X-original-commit: 8aed7988ba
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Christophe Monniez (moc) <moc@odoo.com>
2023-06-20 18:02:00 +02:00
luvi
898b0280db [IMP] web: add documentation for Core components
This commit adds some documentation for features recently added to SelectMenu
and TagsList components during the saas-16.3 development. A screenshot has
been provided to the advances use case of the SelectMenu, with a customization
of the bottom area of the dropdown, to create display a button allowing the
creation of items.

closes odoo/documentation#4631

X-original-commit: 0aad6eafda
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Luca Vitali <luvi@odoo.com>
2023-06-06 14:48:43 +02:00
Mathieu Duckerts-Antoine
70b69857e9 [IMP] abstract actions: adapt code after some legacy code removal
closes odoo/documentation#3722

Signed-off-by: Géry Debongnie <ged@odoo.com>
2023-05-17 14:46:58 +02:00
Mathieu Duckerts-Antoine
b4ebef7d20 [IMP] gantt: adapt doc to last changes brought during owl conversion
Part-of: odoo/documentation#3722
2023-05-17 14:46:58 +02:00
Mathieu Duckerts-Antoine
1491cce9d6 [IMP] views: document attributes "class" and "js_class"
Part-of: odoo/documentation#3722
2023-05-17 14:46:58 +02:00
Antoine Vandevenne (anv)
8c29d1fd6a [FIX] reference/services: mark optional the params parameter of rpc
closes odoo/documentation#4282

X-original-commit: c1b38dc1f3
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-27 18:25:21 +02:00
Leonardo Pavan Rocha
fe2111ccbf [IMP] web: add quick_create_form_view_id attribute
In https://github.com/odoo/odoo/pull/114827, a new attribute was added in
calendar views to allow passing the id of a form view that is used internally
in the calendar module to show a different form view when quick_creating an
event.

task-3129030

closes odoo/documentation#4221

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-04-24 18:26:01 +02:00
Artygo8
ef4c3555bc [IMP] reference/extract: update documentation
task-3071317

closes odoo/documentation#4224

X-original-commit: 07eef81a95
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Arthur Gossuin (goa) <goa@odoo.com>
2023-04-22 06:53:41 +02:00
Rémy Voet (ryv)
584e44396b [ADD] add documentation about Model._read_group
task-3001022

odoo/odoo#110737

closes odoo/documentation#4064

Related: odoo/enterprise#38639
Signed-off-by: Rémy Voet <ryv@odoo.com>
2023-04-19 21:58:12 +02:00
Martin Trigaux
1e39949363 [IMP] reference: update markup documentation
closes odoo/documentation#3612

Related: odoo/odoo#111850
Related: odoo/enterprise#36728
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2023-04-13 16:39:45 +02:00
Tiffany Chang (tic)
e18b24a176 [REM] developer: remove references to web_dashboard view
Since odoo/enterprise#31641 the dashboard view no longer exists since it
is now replaced with spreadsheet_dashboard, therefore we remove it from
the backend Views documentation.

Task: 3226581
X-original-commit: e2c880aafe
Part-of: odoo/documentation#4035
2023-04-05 17:31:58 +02:00
fdardenne
56a5b0480e [IMP] create JavaScript howtos
The JavaScript cheatsheet is outdated, we therefore remove it and
replace it by multiple howtos:

- Create a view from scratch
- Extending an existing view
- Create a field from scratch
- Extend an existing field
- Create a client action

There is other subjects to introduce as the web framework is big. Other
future contributions will cover them.

closes odoo/documentation#4020

X-original-commit: 7e4435deb8
Signed-off-by: Dardenne Florent (dafl) <dafl@odoo.com>
2023-04-05 13:57:53 +02:00
luvi
5e248b7017 [IMP] web: Add core components documentation
This commit adds the documentation for core components that have
been improved or moved during the Studio refactor. Some new props
have been added, and the documentation is now present as expected.

Components involved:
- Notebook
- SelectMenu
- TagsList

closes odoo/documentation#4007

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-04 18:07:11 +02:00
kcv-odoo
ff846cc48d [IMP] backend: add disable_linking option in cohort view
Related PR: https://github.com/odoo/enterprise/pull/37396

task-3186590

closes odoo/documentation#3646

Related: odoo/enterprise#37396
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-04 18:07:01 +02:00
Raphael Collet
4f3531f81b [IMP] tests: server-side Form and other tests features
closes odoo/documentation#3968

Related: odoo/enterprise#38858
Related: odoo/odoo#116779
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-03-31 17:02:46 +02:00
FrancoisGe
679504a05c [REF] web: remove allow_group_range_value
The allow_group_range_value option is used in one arch of a kanban in
CRM. We therefore believe that this is not standard behaviour.
So we decided to move this logic to the custom view that uses it.

closes odoo/documentation#3964

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-03-30 13:58:28 +02:00
Valentin Vallaeys (vava)
04c732f89e [ADD] developer: add _get_available_tokens
Introduced with this commit:
e534ab41e7

closes odoo/documentation#3859

X-original-commit: cb06fb7687
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Vallaeys Valentin (vava) <vava@odoo.com>
2023-03-21 19:54:31 +01:00
Géry Debongnie
f6ce2b9904 [IMP] developer: add description of disabled prop to Dropdown
This prop has been implemented in pr https://github.com/odoo/odoo/pull/115201/files

closes odoo/documentation#3828

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-03-14 17:03:41 +01:00
Raphael Collet
097c247449 [IMP] core: introduce search_fetch() and fetch()
closes odoo/documentation#3749

Related: odoo/odoo#114551
Signed-off-by: Raphael Collet <rco@odoo.com>
2023-03-07 18:03:13 +01:00
Antoine Vandevenne (anv)
ed4b8c1320 [MOV] developer/cli: move "Command-line interface (CLI)" to the reference dir
task-2991663

closes odoo/documentation#3660

X-original-commit: 3dc6bb83c1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-23 16:09:00 +01:00
Antoine Vandevenne (anv)
6d50ac96de [MOV] developer/api/extract_api: move "Extract API" to the reference dir
task-2991663

X-original-commit: 73f976e679
Part-of: odoo/documentation#3660
2023-02-23 16:09:00 +01:00
Antoine Vandevenne (anv)
518db8b02a [MOV] developer/api/external_api: move "External API" to the reference dir
task-2991663

X-original-commit: 95ed856446
Part-of: odoo/documentation#3660
2023-02-23 16:09:00 +01:00
william-andre
cd81a97399 [REF] account: remove chart templates
The way of declaring charts of accounts has completely changed.

closes odoo/documentation#3336

Related: odoo/enterprise#35836
Related: odoo/odoo#110016
Related: odoo/upgrade#4276
Signed-off-by: William André (wan) <wan@odoo.com>
2023-02-17 19:30:29 +01:00
Jonathan Castillo (jcs)
65d71dd7be [FIX] *: RST cleanup
RST cleanup to comply with the RST guidelines. This is required so we
can use "make test", as there are currently hundreds of errors. For now,
it is unusable because of the oldest code in this repo.

closes odoo/documentation#3589

X-original-commit: 7ae76bad42
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-15 16:03:06 +01:00
luvi
f4c8a0f929 [ADD] web: add core components documentation
Those components were added during the Owl rewrite of the webclient
that happened in 16.0. Unfortunately, there was still no documentation
for them.

This commits fixes that by adding documentation for the Notebook and
the Colorlist components.

closes odoo/documentation#3586

X-original-commit: 7a9d807bcc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Luca Vitali <luvi@odoo.com>
2023-02-15 16:03:03 +01:00
luvi
a844c0aa12 [ADD] web: add SelectMenu documentation
This commit adds the documentation for the SelectMenu component, introduced
in saas-16.1. This documentation gives some example of its usage.

An image is also added, to better illustrate the grouping functionality.

closes odoo/documentation#3575

X-original-commit: 4a220d61fe
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Luca Vitali <luvi@odoo.com>
2023-02-14 18:12:04 +01:00
luvi
128bc1786c [FIX] web: fix wrong ActionSwiper documentation
Since 16.0, the documentation for this component was no longer
correct, since the component was moved to web during the refactor
of the webclient views. This commit also adds documentation of
props that were introduced during the refactor, already present
in 16.0.

closes odoo/documentation#3507

X-original-commit: fc79df42fd
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-08 16:50:05 +01:00
Mahmoud Metwally
c61c65da47 [FW][FIX] developer/javascript_reference: typos and phrasing
closes odoo/documentation#3476

Forward-port-of: odoo/documentation#3470
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-02-03 06:06:29 +01:00
Jorge Pinna Puissant
1d6c78a006 [IMP] views: allow the use of setting tags on the form view
Since [1], it's able to use of the setting tag in any form view.

[1]: 4cdd74fc585009a19a7d307f08411ad19255f8ff

closes odoo/documentation#3403

Signed-off-by: Aaron Bohy (aab) <aab@odoo.com>
2023-01-25 11:16:49 +01:00
FrancoisGe
b8ffda3c07 [IMP] backend/views: relative width of a field is no longer supported in list views
Since the conversion of the list view to owl, the relative field size has not been reimplemented. We have decided not to support it anymore. So we will remove all its uses.

The relative width consists in adding a width attribute with an integer value. This value corresponds to the weight of the field, the higher it is, the more space the field will take. This size is only used when the list is empty.

Example of this:
<tree>
    <field ... width="2">
    <field ... width="1">
</tree>

The first field will take 2x more space than the first one when the list is empty.

closes odoo/documentation#3375

Related: odoo/odoo#110382
Related: odoo/enterprise#36020
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-23 11:19:56 +01:00
FrancoisGe
37146744a0 [IMP] web: add buttons in control panel in kanban
closes odoo/documentation#3257

Taskid: 3082390
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-18 13:25:16 +01:00
Xavier BOL (xbo)
10c7b5cbae [IMP] backend: add groups_draggable option in kanban view
Related PR: odoo/odoo#97447

task-2941335

closes odoo/documentation#3338

X-original-commit: f51633fdd5
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Xavier Bol (xbo) <xbo@odoo.com>
2023-01-16 19:46:00 +01: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
fdardenne
8a30786495 [IMP] developer: JavaScript tutorial: chapter 3-7
This commit adds the chapter 3,4,5,6 and 7 of the JavaScript web
framework tutorial.

This new tutorial allows people to discover Owl and the building blocks
of the Odoo JavaScript framework.

closes odoo/documentation#3325

X-original-commit: 54628b4f5b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Géry Debongnie <ged@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-12 19:08:49 +01:00
Horacio Tellez
d8c9f6afa4 [FIX] developer: typo on a code example in the framework overview
There was a variable being used that was undeclared.

closes odoo/documentation#3316

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-11 15:39:02 +01:00
Xavier BOL (xbo)
b909a21d1f [IMP] backend: add default_group_by option in list view
Related PR: odoo/odoo#109281

task-3084850

closes odoo/documentation#3311

Related: odoo/enterprise#35504
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-10 15:43:05 +01:00
luvi
ad6cde3181 [IMP] web: update usePosition API
This commit updates the documentation of the position hook, to add
the latest variant "fit". This variant was introduced recently in
commit (1), when using it in the SelectMenu component.

(1): c21c415f38

closes odoo/documentation#3261

Signed-off-by: Luca Vitali <luvi@odoo.com>
2023-01-09 12:22:44 +01:00
luvi
bca9ac151f [ADD] web: add useSpellCheck hook documentation
This commit brings the documentation for the useSpellCheck hook,
introduced in commit (1). The documentation contains some example
and details on how to use the hook properly.

(1): 130719e584

Part-of: odoo/documentation#3261
2023-01-09 12:22:44 +01:00
Jorge Pinna Puissant
68a35753c6 [IMP] * : kanban, unify dropdown definition in archs
This commit add the documentation for the new 'kanban-menu' template
(the ellipsis dropdown menu).

No that, this commit add also the documentation for the 'kanban-tooltip'
template.

closes odoo/documentation#3284

Task-id: 3096776
Related: odoo/odoo#107589
Related: odoo/enterprise#34962
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-05 15:37:07 +01:00
Mahmoud Metwally
1a95d1cd6f Update qweb.rst
closes odoo/documentation#3289

X-original-commit: 8cde1f7b74
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-04 15:48:18 +01:00
FrancoisGe
e045da51b3 [IMP] web: adds the header to the list view
This commit adds the documentation related to the <header> tag to the list view.

closes odoo/documentation#3044

Related: odoo/odoo#106519
Related: odoo/enterprise#34387
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-16 18:40:01 +01:00
Valentin Vallaeys (vava)
2ce56e4fb1 [FIX] developer: better definition for oe_inline
closes odoo/documentation#3173

X-original-commit: b2d0ab29a5
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-09 21:01:00 +01:00
Antoine Vandevenne (anv)
b3a1f27461 [IMP] conf.py, *: interpolate the version and releases in the content
This commit replaces hard-coded occurrences of the version and of the
last, current and next releases' version with placeholders interpolated
at build time to avoid manually updating these after each freeze.

task-2917614

closes odoo/documentation#3170

X-original-commit: fa2d0f6363
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-09 13:03:46 +01:00
Jorge Pinna Puissant
d0ae1cbce0 [IMP] views: setting view
This commit, add the documentation of the new DSL created exclusively
for the settings.

closes odoo/documentation#3092

Task-id: 3081367
Signed-off-by: Jorge Pinna Puissant (jpp) <jpp@odoo.com>
2022-12-07 11:49:50 +01:00
Victor Feyens
2d1361c026 [FIX] developer/*: code blocks linting & fixes
invalid xml
invalid python
correct indentation

closes odoo/documentation#3029

X-original-commit: b2121b7891
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-25 10:52:04 +01:00
Victor Feyens
2b75fb4bbb [FIX] developer/*: consistent code-block language specification
X-original-commit: 387cf15e7f
Part-of: odoo/documentation#3029
2022-11-25 10:52:04 +01:00