In ir.actions.server, the variable containing the record(s) is not
`self`, but `record` and `records`.
Also, since there is a word about `store` attribute for computed
fields, this commit specifies the behaviour of `readonly` attribute.
closesodoo/documentation#11484
Signed-off-by: Vallaeys Valentin (vava) <vava@odoo.com>
- Updated documentation to include details on the new bank statement
extraction via OCR.
- Removed mention of unsupported discount, product, and unit features
from invoice_lines feature.
Task-3895452
closesodoo/documentation#11389
X-original-commit: 8c93ff790e
Signed-off-by: Joris Makauskis (jmak) <jmak@odoo.com>
Introduce a new tutorial about creating Odoo modules using XML data files
instead of Python code.
This guide is follows closely the 'Server Framework 101' tutorial and
covers the following:
- Module structure and deployment
- Defining models and fields
- Setting up security and access rights
- Creating views and actions
- Implementing relational fields (many2one, many2many, one2many)
- Working with computed and related fields
- Adding business logic through server actions and automation rules
- Creating website controllers for API endpoints
The tutorial includes practical exercises and code examples to reinforce
learning, catering to developers who need to customize Odoo without writing
Python code (e.g. Odoo PS-Tech employees, partners that focus on SaaS instances
or author of Industry modules).
Task-4167176
closesodoo/documentation#11050
Signed-off-by: Bouvy Damien (dbo) <dbo@odoo.com>
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.
closesodoo/documentation#10729
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The attribute of `record` data operations should be `id` and not `name`.
closesodoo/documentation#10704
X-original-commit: e41e618116
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit aims to update the documentation regarding the adaptability of
widgets in the graph view of Odoo.
Task-3861721
closesodoo/documentation#10573
Signed-off-by: Mathieu Duckerts-Antoine (dam) <dam@odoo.com>
A typo was found. The word "customeKanbanView" is misspelled and should be "customKanbanView", which is the constant exported correctly in the code. Therefore, the corrected line would be:
closesodoo/documentation#9661
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
js framework/Build a Dashboard/part 8 (LazyComponent)
There is no explicit instructions on how to use `LazyComponent`.
- add an example code snippet for minimal use of `LazyComponent`
- add the `.js` extension to the file you're supposed to create to make it a bit more intuitive
- fix `actions` registry name (missing an s)
- reword instructions in a more straightforward way
closesodoo/documentation#9521
Signed-off-by: Florent Dardenne (dafl) <dafl@odoo.com>
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.
closesodoo/documentation#9180
Signed-off-by: Samuel Degueldre (sad) <sad@odoo.com>
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.
closesodoo/documentation#9185
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
* 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: 91a48bfe88closesodoo/documentation#8836
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
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
closesodoo/documentation#8597
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Valeriya (vchu) <vchu@odoo.com>
- 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#8195
Closes: #7620
Signed-off-by: Rémy Voet (ryv) <ryv@odoo.com>
the "py" letter should be "by" to make the syntax correct and understood.
closesodoo/documentation#8296
Forward-port-of: odoo/documentation#8276
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
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.
closesodoo/documentation#8193
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
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
closesodoo/documentation#8061
Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
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.
closesodoo/documentation#8041
X-original-commit: e60affa6fe
Signed-off-by: Claire Bretton (clbr) <clbr@odoo.com>
The filter element attribute 'name' is now required since
odoo/odoo/commit/4ddc3231
closesodoo/documentation#7510
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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
closesodoo/documentation#5237
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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
closesodoo/documentation#6876
Task-id: 3623595
Signed-off-by: Géry Debongnie <ged@odoo.com>
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#70117closesodoo/documentation#6743
X-original-commit: 3d91c57b57
Signed-off-by: Julien Castiaux (juc) <juc@odoo.com>
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.
closesodoo/documentation#6669
Signed-off-by: Samuel Degueldre (sad) <sad@odoo.com>
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.
closesodoo/documentation#6631
X-original-commit: 620508fb29
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Claire Bretton (clbr) <clbr@odoo.com>
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: odoo/documentation#6631
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
closesodoo/documentation#6493
Related: odoo/odoo#142498
Signed-off-by: Samuel Degueldre (sad) <sad@odoo.com>
The tour utils were red and moved in Odoo (odoo/odoo#107618).
closesodoo/documentation#6514
X-original-commit: 1746c57ff4
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Rémi Rahir (rar) <rar@odoo.com>
