Commit Graph

429 Commits

Author SHA1 Message Date
Samuel Degueldre
59e8cb1c3a [FIX] developer: rewrite a bunch of outdated info in JS reference
Previously, a lot of information on the JavaScript reference page was
outdated.

This commit rewrites a bunch of sections to bring them up to date and
removes others that are no longer relevant. While a more profound rework
of the JS documentation is still needed, this commit at least reduces
the amount of outdated information significantly in the meantime.

closes 

X-original-commit: 2354f0946e
Signed-off-by: Samuel Degueldre (sad) <sad@odoo.com>
2024-05-07 05:56:26 +00:00
Victor Feyens
b4a8e166a6 [FIX] dev/tutorials: typo
courtesy of @/ChloeLiang

closes 

X-original-commit: 3e62a8c4cd
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2024-04-30 02:30:25 +00:00
Vincent Schippefilt
564f2640c7 [IMP] base: add read_group relative granularity
references https://github.com/odoo/odoo/pull/159528

closes 

Task: 3836802
Related: 
Signed-off-by: Vincent Schippefilt (vsc) <vsc@odoo.com>
2024-04-25 17:11:23 +00:00
Alvaro Fuentes
3bba491f57 [IMP] doc: improve organization of upgrades docs
* Add autodoc directives to generate documentation directly from
  upgrade-util repo.
* Group all upgrades-related reference documentation into one group in
  the sidebar, instead of having two entries.
* Mention `upgrades` vs `migrations` directory. It has been supported
  since a while but nothing was explicit in the documentation.

Original commit: 91a48bfe88

closes 

X-original-commit: ef4b5f87d5
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2024-04-19 13:35:52 +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 

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 

closes 

Related: 
Related: 
Signed-off-by: Raphael Collet <rco@odoo.com>
2024-04-08 19:17:56 +00:00
mathysPaul
06d25495e6 [IMP] payment: Remove _compute_view_configuration_fields docs
Following the removal of explicit view configuration fields and
the `_compute_view_configuration_fields` method in the payment
module, this commit updates the documentation accordingly. It
removes all references and instructions related to
`_compute_view_configuration_fields`, ensuring the documentation
reflects the current implementation that leverages XPath for
view customization.

task-3679393

See 
See 
See 

closes 

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-04-02 13:09:25 +00:00
Rémy Voet (ryv)
5f2a5d318e [IMP] orm: add 'any' and 'not any' operators
- Add descriptions of the 'any' and 'not any' operators
- Simplify the example for searching partners
- Add an example using the 'any' operator for the sale.order model

closes odoo/documentation#8349

Closes: 
X-original-commit: 7353d7b2cc
Signed-off-by: Rémy Voet (ryv) <ryv@odoo.com>
2024-03-25 12:54:14 +00:00
Mohamed Alkobrosli
47edb88436 [FW][FIX] dev/assets: typo
the "py" letter should be "by" to make the syntax correct and understood.

closes 

Forward-port-of: 
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 

Forward-port-of: 
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 

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 

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 

Related: 
Related: 
Related: 
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-03-20 12:09:27 +00:00
Antoine Vandevenne (anv)
124f9743c6 [FIX] tutorials/discover_js_framework: clarify instructions
closes 

X-original-commit: 632add350d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-03-19 01:31:02 +00:00
Samuel Degueldre
ff36e1f7aa [IMP] web: create how-to for using Owl components in the frontend
closes 

X-original-commit: e259853486
Signed-off-by: Samuel Degueldre (sad) <sad@odoo.com>
2024-03-15 15:59:20 +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 

Related: 
Related: 
Related: 
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 

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 

Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2024-03-12 07:08:34 +00:00
Claire Bretton (clbr)
0fab281c12 [IMP] getting_started: use odoo/tutorials repository + runbot
We now use the odoo/tutorials to make the technical onboarding.
- Change the current documentation accordingly.
- Add a section for employees only so that they use odoo-dev/tutorials
as shared fork. It's closer to our way to work so we think it's better
to make them use to it as fast as possible.
- Add some explanations about runbot.

`odoo/technical-training-sandbox` will no longer be used and can be considered deprecated.

closes 

X-original-commit: e60affa6fe
Signed-off-by: Claire Bretton (clbr) <clbr@odoo.com>
2024-03-06 11:37:58 +00:00
Tarek berkane
54c328611c [FW][FIX] tutorials/getting_started: typo in 'estate'
closes 

Forward-port-of: 
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-02-20 11:02:07 +00:00
Rémy Voet (ryv)
99751542c7 [IMP] orm: renaming of group_operator -> aggregator
closes 

Related: 
Related: 
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: 
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 

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 

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 

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 

closes 

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 

Related: 
Related: 
Related: 
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 

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: 

[^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 

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
YStorm5
e765370016 [FW][FIX] developer/tutorials/getting_started: swap headers
I think these two header got mix up.

closes 

Forward-port-of: 
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-01-03 17:43:36 +00:00
ezoer
15beccfd50 [FW][FIX] developer/user_interface: fix typo in 'attribute'
closes 

Forward-port-of: 
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 

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 

Forward-port-of: 
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`:
* 
* 
* 

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`:
* 
* 

closes 

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 

X-original-commit: 2662fa5437
Signed-off-by: Raphael Collet <rco@odoo.com>
2023-12-01 11:54:08 +00:00
Samuel Degueldre
b093bdc871 [FIX] developer: remove confusing section about starting services
When writing the documentation page for standalone Owl apps, it was
originally required to create the env and start the services manually,
and then mount the application by giving it a bunch of configuration
parameters. During review, it was noted that this was error prone and
confusing, and as such a corresponding PR added a helper to mount the
application without needing to do much by hand. While the code was
adapted in the documentation that was merged, the text still referred to
starting the services and creating the environment which is no longer
necessary.

This commit removes references to those things, and because the
resulting section is very small and not very interesting it has been
merged into the previous section.

closes 

X-original-commit: 8e3008f06a
Signed-off-by: Samuel Degueldre (sad) <sad@odoo.com>
2023-11-28 05:50:46 +00:00
Claire Bretton (clbr)
6fd7446ad9 [FIX] getting_started: remove useless lambda
The lambda function here is useless and makes newdooers think
they need to use it everytime.
`default=fields.Date.add(fields.Date.today(), months=3))`
should do the trick, no lambda involved.

closes 

X-original-commit: 620508fb29
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Claire Bretton (clbr) <clbr@odoo.com>
2023-11-24 03:35:00 +00:00
Claire Bretton (clbr)
0dd8974ca1 [FIX] getting_started: invalid addons-path
The "../technical-training-sandbox" is added too early in the path since
its still empty, and results into an "invalid addons-path" error.

X-original-commit: 8707609b38
Part-of: 
2023-11-24 03:35:00 +00:00
Samuel Degueldre
16e10c53db [IMP] developer: document how to create standalone owl apps
Since we've introduced Owl, developers want more and more to create
standalone Owl applications outside of the webclient. This commit
introduces a How-to for doing just that.

task-3580007

closes 

X-original-commit: 1fc36ffa82
Related: 
Signed-off-by: Samuel Degueldre (sad) <sad@odoo.com>
2023-11-22 15:52:49 +00:00
Rémy Voet (ryv)
7067cf372a [FIX] performance: change example with the new _read_group
closes 

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 ().

closes 

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 

X-original-commit: f1960a250c
Signed-off-by: Rémy Voet (ryv) <ryv@odoo.com>
2023-11-15 12:35:34 +00:00
Louis Baudoux
49ad6221a8 [IMP] iap: remove documentation related to IAP services creation
It has been decided to remove the possibility for our users to create
their own IAP services.
This decision was motivated by the fact that, in the 5 years of
existence of IAP, very few non-Odoo services have been created and
actively used by our customers.

X-original-commit: 282f041ed1
Part-of: 
2023-11-07 18:17:37 +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 

Related: 
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 

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 

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 

Related: 
Related: 
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 

X-original-commit: 82055c1f15
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-10-24 13:55:29 +00:00
Stan (stgu)
cbcfb4b36f [IMP] howtos/translations: text & tips
Remove parenthesis around a term that's fairly straightforward to
understand and later used as a title Add a much-needed point.

closes 

X-original-commit: 6f3ed657fc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Stanislas Gueniffey (stgu) <stgu@odoo.com>
2023-10-17 01:48:10 +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 

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 

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: 
2023-10-06 06:14:10 +00:00
dispread
1a26e5ae52 [FW][FIX] developer/tutorials: wrong kanban view example
Pretty sure the previous wasnt the intended result as it would show the "this is new" in a new kanban card. This just groups it with the property it belongs to.

closes 

Forward-port-of: 
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-09-25 13:09:11 +00:00
Antoine Vandevenne (anv)
13feb8018d [IMP] developer/reference/payment: add docstrings for payment_method
task-2882677

closes 

Related: 
Related: 
Related: 
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 

Related: 
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-09-13 15:34:35 +00:00
fdardenne
b1ece27040 [IMP] Views howtos: add details on how to use a view in arch
closes 

X-original-commit: c1c04f90a8
Signed-off-by: Florent Dardenne (dafl) <dafl@odoo.com>
2023-09-13 09:39:01 +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 

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 

Related: 
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-09-11 10:29:03 +00:00
Odoo's Mergebot
1c072f0ac2 [FW][FIX] developer/tutorials/discover_js_framework: fix broken "domain.js" link
The link pointing to domain.js file was broken.
The xml id on the line before that is also broken but it will be fixed with PR#5699.

closes 

Forward-port-of: 
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Armin FalDiS <armin.fallah96@gmail.com>
Co-authored-by: Armin FalDiS <fara@odoo.com>
2023-09-04 09:19:17 +00:00
Andrea Tasselli
2f9645c1a6 [FW][FIX] developer/tutorials/discover_js_framework: add missing this
closes 

Forward-port-of: 
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-08-31 06:16:02 +00:00
Pierre Rousseau
be064dff98 [IMP] list: add open_form_view to list attributes
Task-id 3063425

closes 

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-08-29 11:10:54 +00:00
Xavier (XPL)
692fe78bd1 [FIX] install: fix reference and redirect
closes 

X-original-commit: 2b9ffdb240
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2023-08-19 21:05:40 +02:00
Antoine Vandevenne (anv)
a5d10930d6 [REM] payment_providers: remove mentions of extra fees
task-3358581

closes 

Related: 
Related: 
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 

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 

Related: 
Related: 
Related: 
Signed-off-by: Julien Castiaux (juc) <juc@odoo.com>
2023-08-18 09:49:36 +02:00
Antoine Vandevenne (anv)
0e97376921 [FIX] tutorials/getting_started: fix typos in example model name
Commit f36c612d13 changed the model name
in Chapter 4 without updating the other occurences.

closes 

X-original-commit: b6f923d111
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-08-17 18:43:18 +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 

Forward-port-of: 
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  the necessity to tag owl templates with an owl="1"
attribute has been removed, update the docs to reflect that.

closes 

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 

X-original-commit: bf5c888446
Related: 
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 

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 

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
chyde-clearwater
3758cd5899 [IMP] tutorials/getting_started: disambiguate example model name
I removed the dot notation in the  "_name" variable for the example
model. AKA, "test.model" is now named "test_model".

Dot notation implies a data structure relationship between a <model> and
it's parent (or class etc) <test> (like test.model() or Test.model).
There is no relationship like this between a <test> and <model> - it's
just one thing: a <test model>.

The seeming "benefit" of the ORM translating dots to underscores doesn't
justify this naming convention.  Yes, I know it's a string, but still,
this seems confusing for newbies and adds unnecessary complexity (why
name the same thing differently in different places?)

closes 

X-original-commit: f36c612d13
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-07-18 13:07:47 +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 

Forward-port-of: 
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 

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 

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 

Related: 
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 

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: 
2023-07-04 12:47:01 +02:00
Rémy Voet (ryv)
13544bca17 [IMP] orm: name_get into display_name




closes 

Signed-off-by: Rémy Voet (ryv) <ryv@odoo.com>
2023-06-28 17:41:15 +02:00
Benoit Socias
0df9068892 [FIX] howto/rdtraining: ch.13 adapt reference to salesperson field
In chapter 13 the `property_ids` field is defined as the inverse of a
`user_id` field. But in chapter 8 when the salesperson field is added,
no such name is given to it.

This commit adapts the description to reference the general concept of
the field used to link to the salesperson instead of an actual field
identifier.

task-3381757

closes 

X-original-commit: 3a131c829a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-06-27 13:44:38 +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 

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 

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 

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
Jonathan Castillo (jcs)
8553f68bb8 [MOV] accounting: restructuration of the accounting documentation
This commit improves the structure of the accounting documentation by
- reducing the levels necessary to reach the information
- grouping some docs
- moving content to their parent category page (content in all levels)
- renaming some sections to reflect the structure of the app better

task-3330093

closes 

X-original-commit: c68cc154ed
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-05-22 11:43:14 +02:00
Mathieu Duckerts-Antoine
70b69857e9 [IMP] abstract actions: adapt code after some legacy code removal
closes 

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: 
2023-05-17 14:46:58 +02:00
Mathieu Duckerts-Antoine
1491cce9d6 [IMP] views: document attributes "class" and "js_class"
Part-of: 
2023-05-17 14:46:58 +02:00
CVDE-odoo
26f00581c4 [ADD] developer/howto: guide for theming
A complete guide on how to create a custom website theme for Odoo

closes 

X-original-commit: 892fd3e2ac
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-05-12 08:17:09 +02:00
Antoine Vandevenne (anv)
fd933208d3 [IMP] tutorials/getting_started: rework the environment setup guide
This commit replaces a big chunk of the instructions relative to the
environment setup with a reference to the equivalent steps listed in the
contribution guide. It also moves the content of the "Create your first
PR" section from chapter 16 to chapter 2, as readers were struggling
with the Git configuration required to push their work to GitHub as they
progressed through the tutorial.

closes 

X-original-commit: 26e12696c1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-05-11 18:25:41 +02:00
Antoine Vandevenne (anv)
8c29d1fd6a [FIX] reference/services: mark optional the params parameter of rpc
closes 

X-original-commit: c1b38dc1f3
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-27 18:25:21 +02:00
Antoine Vandevenne (anv)
b1a76aec63 [IMP] tutorials/js_framework: reword, clarify and improve instructions
X-original-commit: b58dbb1fbb
Part-of: 
2023-04-27 18:25:21 +02:00
Antoine Vandevenne (anv)
08f472ef28 [IMP] tutorials/js_framework: freeze GitHub links with line numbers
A few links were already outdated. Either the referenced code was no
longer on the same line, or the file didn't exist anymore.

This commit freezes all links targeting a specific line on the odoo/odoo
repository by selecting a specific commit.

X-original-commit: 6e746c851f
Part-of: 
2023-04-27 18:25:20 +02:00
Antoine Vandevenne (anv)
d90e09c8b7 [IMP] tutorials/js_framework: retarget links to the current major branch
Commits pushed on the odoo/tutorials repository are not automatically
forward-ported, which makes it cumbersome to keep all SaaS branches up
to date.

Because of this, and because Odoo developers are very unlikely to follow
tutorials specific to a SaaS branch, links to odoo/tutorials now target
the current major branch, or master if applicable. SaaS branches have
also been deleted from the odoo/tutorials repository.

X-original-commit: ce14b2cfb5
Part-of: 
2023-04-27 18:25:20 +02:00
Géry Debongnie
adb845eb17 [IMP] developer/tutorials: separate js framework tutorial in two parts
This commit splits the 7 chapters of the JS tutorial in two
smaller and more focused tutorials:
- a basic one (Discover the JS framework)
- and an advanced one (Master the odoo web framework)

closes 

X-original-commit: b6b9de70d2
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-25 11:22:48 +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 

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 

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



closes 

Related: 
Signed-off-by: Rémy Voet <ryv@odoo.com>
2023-04-19 21:58:12 +02:00
Mahmoud Metwally
d69383d7ae [FW][FIX] howtos/company: fix typos
closes 

Forward-port-of: 
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-17 18:01:15 +02:00
Mahmoud Metwally
3117592e26 [FW][FIX] developer/web_services: fix typo
closes 

Forward-port-of: 
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-14 11:49:17 +02:00
wangting
9fb8c5c354 [FIX] tutorials/js_framework: fix typo
closes 

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-13 16:40:41 +02:00