Commit Graph

66 Commits

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

closes odoo/documentation#8276

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2024-03-21 12:41:50 +00:00
Denis Ledoux
3b56832297 [FIX] qweb: type "overrinding"
overrinding -> overriding

closes odoo/documentation#6050

X-original-commit: d141144be5
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-10-06 16:43:28 +00:00
imanie383
56eed9771e [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#5459

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-08-11 14:43:56 +02:00
Marc Durepos
c85031b3fc [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#5094

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-07-13 10:40:51 +02:00
Antoine Vandevenne (anv)
c1b38dc1f3 [FIX] reference/services: mark optional the params parameter of rpc
closes odoo/documentation#3994

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-27 11:30:29 +02:00
fdardenne
7e4435deb8 [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#3969

Signed-off-by: Dardenne Florent (dafl) <dafl@odoo.com>
2023-04-04 16:06:19 +02:00
luvi
7a9d807bcc [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#3580

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-15 13:52:53 +01:00
Jonathan Castillo (jcs)
17319f92b2 [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#3581

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-15 12:51:21 +01:00
luvi
fc79df42fd [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#3504

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-08 15:24:35 +01:00
Mahmoud Metwally
e6269ae56e [FW][FIX] developer/javascript_reference: typos and phrasing
closes odoo/documentation#3474

Forward-port-of: odoo/documentation#3470
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-02-02 17:27:02 +01:00
stefanorigano (SRI)
2ca32b40bc [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#3093

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-12 18:19:27 +01:00
fdardenne
54628b4f5b [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#3222

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 16:00:50 +01:00
Mahmoud Metwally
9705552a6b Update qweb.rst
closes odoo/documentation#3288

X-original-commit: 8cde1f7b74
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-04 15:10:00 +01:00
Antoine Vandevenne (anv)
fa2d0f6363 [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#3166

X-original-commit: 12e1085199
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-09 10:40:06 +01:00
Ivan Kropotkin
17bb126cab [FW][FIX] developer/reference: code example
closes odoo/documentation#3027

Forward-port-of: odoo/documentation#2943
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-25 03:52:51 +01:00
Victor Feyens
b2121b7891 [FIX] developer/*: code blocks linting & fixes
invalid xml
invalid python
correct indentation

closes odoo/documentation#3001

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-24 21:38:37 +01:00
Victor Feyens
387cf15e7f [FIX] developer/*: consistent code-block language specification
Part-of: odoo/documentation#3001
2022-11-24 21:38:37 +01:00
Victor Feyens
568e8a28fa [FIX] developer/mobile: use spaces and not tabs for indentation
closes odoo/documentation#2983

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-18 20:30:01 +01:00
Victor Feyens
1b811f8de8 [FIX] *: unbalanced literal markups
Part-of: odoo/documentation#2983
2022-11-18 20:30:01 +01:00
Victor Feyens
c367974170 [FIX] *: remove trailing whitespaces
Part-of: odoo/documentation#2983
2022-11-18 20:30:01 +01:00
Victor Feyens
968ed0a17a [FIX] *: enforce 1 newline on files end
Part-of: odoo/documentation#2983
2022-11-18 20:30:00 +01:00
Antoine Guenet
390126a28a [ADD] frontend: documentation for the editor's Powerbox
This adds a simple documentation for the editor's Powerbox and creates
the base for the editor's own documentation in general.

closes odoo/documentation#2586

Signed-off-by: Antoine Guenet (age) <age@odoo.com>
2022-08-19 11:52:46 +02:00
poma-odoo
ab03f8a9f3 [FW][FIX] developer/frontend: small typos
closes odoo/documentation#2610

Forward-port-of: odoo/documentation#2584
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-08-18 18:25:46 +02:00
Antoine Vandevenne (anv)
5244bd6e23 [IMP] developer/javascript: unify the styling of API references
Now that a new styling for API references was added with commit 934f45c,
we can remove the extra CSS that was crafted specifically for JavaScript
API references with commit 05a0a49a. While we're at it, this commit also
applies the new styling to definition lists that were missing it, like
it was done for the page on views with commit 120ae785.

closes odoo/documentation#2378

X-original-commit: 31a9d4a340
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-04 17:47:40 +02:00
Gorash
7c4656f0c4 [IMP] qweb: document 't-cache' and 't-nocache' directives
related with: https://github.com/odoo/odoo/pull/88276

closes odoo/documentation#2056

Related: odoo/enterprise#27582
Related: odoo/upgrade#3451
Related: odoo/odoo#88276
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-03 16:40:21 +02:00
Antoine Vandevenne (anv)
8722ea902e [MOV] content/*: move resource files into their related page's directory
Since odoo/documentation#903, the guideline for the location of new
resource (images, downloadable files, RST includes...) files is to place
those inside the directory of the RST page that references them.

For example, if `doc1.rst` has a reference to `image.png` and to
`download.zip`, the file structure should look like this:

├── parent_doc/
│     └── doc1/
│     │     └── image.png
│     │     └── download.zip
│     └── doc1.rst
│     └── doc2.rst
├── parent_doc.rst

Before this commit, most of the resource files were still located inside
'media' directories holding all the resource files referenced by RST
pages located at the same level as these directories. In the example
above, a single 'media' directory would hold all the resource files
referenced by both `doc1.rst` and `doc2.rst`. Doing so prevented us from
figuring out easily which resource file was referenced by which RST page
and, thus, lead to unused resource files piling up in the repository. It
also made it more complicated to define codeowners regex rules because a
team could not simply be assigned to `/some_page.*` but needed to be
assigned to both `/some_page\.rst` and to the location of 'media'.

In order to help new content writers figure out the guideline when
taking examples from other RST pages, this commit retroactively applies
the guideline to existing resource files and 'media' directories. The
left-over resource files that are not referenced by any RST page are
removed.

task-2497965

Part-of: odoo/documentation#2068
2022-05-20 14:18:54 +02:00
Beshoy Nabeih
d5d232bb50 [FIX] developer/frontend: typo in the user menu registry example
closes odoo/documentation#2039

X-original-commit: 6d30d81a76
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 18:06:18 +02:00
John Kirkwood (kij)
ded1e69553 [IMP] developer: clarify options for many2one widget
Only `no_create` is required to hide both the 'Create "xxx"' and the
'Create and Edit...' dropdown menu options.

closes odoo/documentation#2016

X-original-commit: 599a137ffc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-18 16:05:03 +02:00
wan
889c9cf0f9 [REF] i18n/localization.rst: rework the entire localization tutorial
closes odoo/documentation#1969

X-original-commit: 9db567159d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: William André (wan) <wan@odoo.com>
Co-authored-by: William Andre <wan@odoo.com>
Co-authored-by: Ivan Yelizariev <iel@odoo.com>
2022-05-09 14:03:24 +02:00
Bruno Boi
0c0a7086ac [IMP] hooks: usePosition new API
closes odoo/documentation#1598

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-21 10:15:16 +01:00
Victor Feyens
d4367c4d9a [FIX] developer/http: adapt to recent httppocalypse changes
See https://github.com/odoo/odoo/pull/78857

closes odoo/documentation#1640

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-02-28 15:25:48 +00:00
Mathieu Duckerts-Antoine
9f179bd49d [IMP] hooks: useAutofocus new API
Recently, the API of useAutofocus has been simplified (see 4308de6aab).
Here we adapt its documentation.

closes odoo/documentation#1572

Signed-off-by: Mathieu Duckerts-Antoine <dam@odoo.com>
2022-02-11 16:06:42 +00:00
Mathieu Duckerts-Antoine
2269ee51e8 [REF] notifications: removal of param messageIsHtml
closes odoo/documentation#1557

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-02-10 13:22:39 +00:00
Mathieu Duckerts-Antoine
484d245556 [IMP] hooks: document useAutofocus
Part-of: odoo/documentation#1557
2022-02-10 13:22:38 +00:00
Antoine Vandevenne (anv)
6172c98159 [ADD] developer/reference/frontend: add an icons library page
task-2704984

closes odoo/documentation#1462

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-08 14:26:42 +00:00
Demesmaeker
8966e001c2 [IMP] integration_testing: add information about JS touring
Adding basic information about `How to make a test tour`.

task-2742841

closes odoo/documentation#1524

X-original-commit: dbd5a1e1bb
Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 15:55:41 +00:00
Niranjan Abhyankar
ce9cc2f48b [FIX] developer/javascript_cheatsheet: fix a typo
closes odoo/documentation#1521

X-original-commit: d9e2ab6feb
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 13:46:10 +00:00
Stan
194f215662 [IMP] qweb: mention the two possible syntaxes for t-attf
closes odoo/documentation#1467

X-original-commit: cdb8d51131
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-12 09:56:04 +00:00
luvi
331b7b6285 [ADD] developer: actionswiper doc added
This commit adds the developer documentation for a
component recently added to the web_enterprise module.
It also includes examples and a screenshot used in the
documentation.

closes odoo/documentation#1432

X-original-commit: 7763c22db4
Signed-off-by: Géry Debongnie <ged@odoo.com>
Signed-off-by: Luca Vitali <luvi@odoo.com>
2021-12-21 07:42:52 +00:00
Julien Castiaux
e410776f24 [FIX] developer/reference/javascript_reference
The "qweb key of the manifest" file was still mentionned even if it has
been replaced by the assets bundles.

See related task: 2352566

closes odoo/documentation#1434

X-original-commit: dc832e1cc8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-17 11:37:39 +00:00
FrancoisGe
4335271352 [IMP] web: add tooltip on Dropdown
This commit adds the possibility to add a tooltip on a Dropdown.

closes odoo/documentation#1396

Signed-off-by: FrancoisGe <fge@odoo.com>
2021-12-15 08:12:01 +00:00
Samuel Degueldre
888fbb5c50 [IMP] web: adapt documentation to the removal of dropdown-item-selected
closes odoo/documentation#1404

Signed-off-by: Samuel Degueldre <sad@odoo.com>
2021-12-14 14:25:24 +00:00
Géry Debongnie
4233250b82 [IMP] developer: small rework of assets page (frontend)
This commit applies some remarks by Antoine.

closes odoo/documentation#1328

X-original-commit: 8c1003e363
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-19 13:35:18 +00:00
Bruno Boi
2d93b03dd0 [FIX] developer: effect service
closes odoo/documentation#1325

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-19 13:32:47 +00:00
luvi
24d0a9f71d [ADD] developer: scroller service added
This commit adds the documentation related to
the scroller service. This service is used for
the webclient to handle clicks on links and there
were no documentation related until now.

closes odoo/documentation#1326

X-original-commit: 1f84bab97d
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-19 12:36:54 +00:00
Géry Debongnie
eb9cd7558c [IMP] developer: list content of browser object (js)
closes odoo/documentation#1312

X-original-commit: d761910466
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-15 09:39:13 +00:00
Bruno Boi
d015bc03fa [IMP] developer: more info for usePosition JS hook
closes odoo/documentation#1309

X-original-commit: 43d838d826
Signed-off-by: Bruno Boi <boi@odoo.com>
2021-11-12 08:56:14 +00:00
Simon Genin (ges)
172c4490ef [ADD] developer: add js http service
closes odoo/documentation#1306

X-original-commit: bbc85e148e
Signed-off-by: Simon Genin (ges@odoo) <ges@odoo.com>
2021-11-09 18:20:14 +00:00
Géry Debongnie
81261e3c9d [IMP] developer: document formatters/parsers registries
and add entry for effects registry as well

closes odoo/documentation#1303

X-original-commit: 624131f712
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-08 16:22:51 +00:00
Géry Debongnie
7b4879a06c [IMP] developer: rewrite the page on assets
closes odoo/documentation#1302

X-original-commit: 8c79319011
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-08 16:22:48 +00:00