NextERP/documentation
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
18.0
documentation/content-rst/developer/howtos.rst

113 lines
2.8 KiB
ReStructuredText
Raw Permalink Normal View History

[IMP] toctrees: redesign and new card component The goal of this commit is to propose a first step towards a new `.. card::` directive for the toctrees. This is a first design proposition for this new card component in raw html for the fallback page `howtos.rst` The long term objective is to redesign the toctrees by implementing card components, clearer toctree list design and custom html pages. Related to task-3059229 closes odoo/documentation#3408 X-original-commit: 64363d86400bd7a533e948ee8102ed3f4f764f56 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-13 00:07:53 +07:00
:show-content:
:hide-page-toc:
[IMP] *: exclude empty TOC pages from search results When searching for a string that can be found in a TOC page's content, that page is listed in the search results. This is not a wanted behavior because TOC pages without the 'show-content' metadata directive are not supposed to be accessible. This commit adds a 'nosearch' metadata directive to all TOC pages without a 'show-content' metadata directive, hence removing them from search results. task-2527419
2021-06-09 16:10:25 +07:00
[ADD] developer/tutorials: add a directory for developer tutorials task-2991663 X-original-commit: 73ce4d6cd8e77be17c9a2e14150f27f27b5dbc00 Part-of: odoo/documentation#3660
2023-02-17 21:48:38 +07:00
=============
How-to guides
=============
[REF][MOV] documentation apocalypse Prior to this commit, the Odoo documentation was mainly split between two repositories: odoo/odoo/doc and odoo/documentation-user. Some bits of documentation were also hosted elsewhere (e.g., wiki, upgrade, ...). This was causing several problems among which: - The theme, config, Makefile, and similar technical resources had to be duplicated. This resulted in inconsistent layout, features, and build environments from one documentation to another. - Some pages did not fit either documentation as they were relevant for both users and developers. Some were relevant to neither of the two (e.g., DB management). - Cross-doc references had to be absolute links and they broke often. - Merging large image files in the developer documentation would bloat the odoo/odoo repository. Some contributions had to be lightened to avoid merging too many images (e.g., Odoo development tutorials). - Long-time contributors to the user documentation were chilly about going through the merging process of the developer documentation because of the runbot, mergebot, `odoo-dev` repository, etc. - Some contributors would look for the developer documentation in the `odoo/documentation-user` repository. - Community issues about the user documentation were submitted on the `odoo/odoo` repository and vice-versa. Merging all documentations in one repository will allow us to have one place, one theme, one work process, and one set of tools (build environment, ...) for all of the Odoo docs. As this is a good opportunity to revamp the layout of the documentation, a brand new theme replaces the old one. It features a new way to navigate the documentation, centered on the idea of always letting the reader know what is the context (enclosing section, child pages, page structure ...) of the page they are reading. The previous theme would quickly confuse readers as they navigated the documentation and followed cross-application links. The chance is also taken to get rid of all the technical dangling parts, performance issues, and left-overs. Except for some page-specific JS scripts, the Odoo theme Sphinx extension is re-written from scratch based on the latest Sphinx release to benefit from the improvements and ease future contributions. task-2351938 task-2352371 task-2205684 task-2352544 Closes #945
2021-04-30 17:40:29 +07:00
.. toctree::
[IMP] developer: improve navigation in top-level pages Prior to this commit, users had to either know in advance or guess the location of the content they were looking for. Top-level pages of the "Developer" section of the documentation, in particular the "Developer" page itself, were listing their sub-pages without directions for users. This commit brings the following changes to improve the navigation: - add directions for users on the "Developer" page and list the three main categories of developer documentation ("Tutorials", "How-to guides", and "Reference") with explanations of their content and target audience; - add categories for content cards on the "Tutorials" and "How-to guides" pages, and fine-tune the toctree of the "Reference" page to more easily locate specific topics; - clarify what are the "Python framework" and the "JavaScript framework" by relabelling them to "Server framework" and "Web framework" on top-level pages, as some users were confused to find that the JS framework was not responsible for the server, and others that the documentation for QWeb template is located in the Python documentation; - extract the "Setup guide" from the "Getting started" tutorial and rename the latter to "Server framework 101" to allow reusing the setup guide in other tutorials and make clear that the "Server framework 101" tutorial is not about the Web framework. task-3802536 closes odoo/documentation#8712 X-original-commit: 7f623b6ad5aac4c5ab3e21886cfb3331ee2b5c63 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com> Co-authored-by: Valeriya (vchu) <vchu@odoo.com>
2024-04-09 16:54:08 +07:00
howtos/scss_tips
howtos/javascript_field
howtos/javascript_view
howtos/javascript_client_action
howtos/standalone_owl_application
howtos/frontend_owl_components
howtos/website_themes
howtos/web_services
howtos/company
howtos/create_reports
howtos/accounting_localization
howtos/translations
howtos/connect_device
howtos/upgrade_custom_db
Frontend development
====================
[IMP] toctrees: redesign and new card component The goal of this commit is to propose a first step towards a new `.. card::` directive for the toctrees. This is a first design proposition for this new card component in raw html for the fallback page `howtos.rst` The long term objective is to redesign the toctrees by implementing card components, clearer toctree list design and custom html pages. Related to task-3059229 closes odoo/documentation#3408 X-original-commit: 64363d86400bd7a533e948ee8102ed3f4f764f56 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-13 00:07:53 +07:00
[ADD] extensions/cards: add an extension to implement cards The extension adds two new directive: - `cards` is the row container for one or more `card` directives. - `card` is the implementation of a Bootstrap card that accepts a `target` argument for the href of the card, a `large` option to render the card on two columns, a `tag` option to display a single arbitrary tag on the card, and arbitrary content that is shown in the card body. task-3141419 closes odoo/documentation#3689 X-original-commit: 34bc63d2bc887042f5eb15ecc5a0a0681c09f01e Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-18 23:37:41 +07:00
.. cards::
.. card:: Write lean easy-to-maintain CSS
:target: howtos/scss_tips
Follow this guide to keep the technical debt of your CSS code under control.
[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: 7e4435deb8ca089849e2622740a4a2ce7e9780b8 Signed-off-by: Dardenne Florent (dafl) <dafl@odoo.com>
2023-03-11 02:56:38 +07:00
.. card:: Customize a field
:target: howtos/javascript_field
[IMP] developer: improve navigation in top-level pages Prior to this commit, users had to either know in advance or guess the location of the content they were looking for. Top-level pages of the "Developer" section of the documentation, in particular the "Developer" page itself, were listing their sub-pages without directions for users. This commit brings the following changes to improve the navigation: - add directions for users on the "Developer" page and list the three main categories of developer documentation ("Tutorials", "How-to guides", and "Reference") with explanations of their content and target audience; - add categories for content cards on the "Tutorials" and "How-to guides" pages, and fine-tune the toctree of the "Reference" page to more easily locate specific topics; - clarify what are the "Python framework" and the "JavaScript framework" by relabelling them to "Server framework" and "Web framework" on top-level pages, as some users were confused to find that the JS framework was not responsible for the server, and others that the documentation for QWeb template is located in the Python documentation; - extract the "Setup guide" from the "Getting started" tutorial and rename the latter to "Server framework 101" to allow reusing the setup guide in other tutorials and make clear that the "Server framework 101" tutorial is not about the Web framework. task-3802536 closes odoo/documentation#8712 X-original-commit: 7f623b6ad5aac4c5ab3e21886cfb3331ee2b5c63 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com> Co-authored-by: Valeriya (vchu) <vchu@odoo.com>
2024-04-09 16:54:08 +07:00
Learn how to customize field components in the web framework.
[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: 7e4435deb8ca089849e2622740a4a2ce7e9780b8 Signed-off-by: Dardenne Florent (dafl) <dafl@odoo.com>
2023-03-11 02:56:38 +07:00
.. card:: Customize a view type
:target: howtos/javascript_view
[IMP] developer: improve navigation in top-level pages Prior to this commit, users had to either know in advance or guess the location of the content they were looking for. Top-level pages of the "Developer" section of the documentation, in particular the "Developer" page itself, were listing their sub-pages without directions for users. This commit brings the following changes to improve the navigation: - add directions for users on the "Developer" page and list the three main categories of developer documentation ("Tutorials", "How-to guides", and "Reference") with explanations of their content and target audience; - add categories for content cards on the "Tutorials" and "How-to guides" pages, and fine-tune the toctree of the "Reference" page to more easily locate specific topics; - clarify what are the "Python framework" and the "JavaScript framework" by relabelling them to "Server framework" and "Web framework" on top-level pages, as some users were confused to find that the JS framework was not responsible for the server, and others that the documentation for QWeb template is located in the Python documentation; - extract the "Setup guide" from the "Getting started" tutorial and rename the latter to "Server framework 101" to allow reusing the setup guide in other tutorials and make clear that the "Server framework 101" tutorial is not about the Web framework. task-3802536 closes odoo/documentation#8712 X-original-commit: 7f623b6ad5aac4c5ab3e21886cfb3331ee2b5c63 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com> Co-authored-by: Valeriya (vchu) <vchu@odoo.com>
2024-04-09 16:54:08 +07:00
Learn how to customize view types in the web framework.
[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: 7e4435deb8ca089849e2622740a4a2ce7e9780b8 Signed-off-by: Dardenne Florent (dafl) <dafl@odoo.com>
2023-03-11 02:56:38 +07:00
.. card:: Create a client action
:target: howtos/javascript_client_action
[IMP] developer: improve navigation in top-level pages Prior to this commit, users had to either know in advance or guess the location of the content they were looking for. Top-level pages of the "Developer" section of the documentation, in particular the "Developer" page itself, were listing their sub-pages without directions for users. This commit brings the following changes to improve the navigation: - add directions for users on the "Developer" page and list the three main categories of developer documentation ("Tutorials", "How-to guides", and "Reference") with explanations of their content and target audience; - add categories for content cards on the "Tutorials" and "How-to guides" pages, and fine-tune the toctree of the "Reference" page to more easily locate specific topics; - clarify what are the "Python framework" and the "JavaScript framework" by relabelling them to "Server framework" and "Web framework" on top-level pages, as some users were confused to find that the JS framework was not responsible for the server, and others that the documentation for QWeb template is located in the Python documentation; - extract the "Setup guide" from the "Getting started" tutorial and rename the latter to "Server framework 101" to allow reusing the setup guide in other tutorials and make clear that the "Server framework 101" tutorial is not about the Web framework. task-3802536 closes odoo/documentation#8712 X-original-commit: 7f623b6ad5aac4c5ab3e21886cfb3331ee2b5c63 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com> Co-authored-by: Valeriya (vchu) <vchu@odoo.com>
2024-04-09 16:54:08 +07:00
Learn how to create client actions in the web framework.
[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: 7e4435deb8ca089849e2622740a4a2ce7e9780b8 Signed-off-by: Dardenne Florent (dafl) <dafl@odoo.com>
2023-03-11 02:56:38 +07:00
[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 odoo/documentation#6553 X-original-commit: 1fc36ffa82067ec4b24e873a4ab5efaff1877334 Related: odoo/odoo#143073 Signed-off-by: Samuel Degueldre (sad) <sad@odoo.com>
2023-11-17 16:24:45 +07:00
.. card:: Create a standalone Owl application
:target: howtos/standalone_owl_application
Learn how to create a public-facing Owl application outside of the web client using a
[IMP] developer: improve navigation in top-level pages Prior to this commit, users had to either know in advance or guess the location of the content they were looking for. Top-level pages of the "Developer" section of the documentation, in particular the "Developer" page itself, were listing their sub-pages without directions for users. This commit brings the following changes to improve the navigation: - add directions for users on the "Developer" page and list the three main categories of developer documentation ("Tutorials", "How-to guides", and "Reference") with explanations of their content and target audience; - add categories for content cards on the "Tutorials" and "How-to guides" pages, and fine-tune the toctree of the "Reference" page to more easily locate specific topics; - clarify what are the "Python framework" and the "JavaScript framework" by relabelling them to "Server framework" and "Web framework" on top-level pages, as some users were confused to find that the JS framework was not responsible for the server, and others that the documentation for QWeb template is located in the Python documentation; - extract the "Setup guide" from the "Getting started" tutorial and rename the latter to "Server framework 101" to allow reusing the setup guide in other tutorials and make clear that the "Server framework 101" tutorial is not about the Web framework. task-3802536 closes odoo/documentation#8712 X-original-commit: 7f623b6ad5aac4c5ab3e21886cfb3331ee2b5c63 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com> Co-authored-by: Valeriya (vchu) <vchu@odoo.com>
2024-04-09 16:54:08 +07:00
controller and the web framework.
[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 odoo/documentation#6553 X-original-commit: 1fc36ffa82067ec4b24e873a4ab5efaff1877334 Related: odoo/odoo#143073 Signed-off-by: Samuel Degueldre (sad) <sad@odoo.com>
2023-11-17 16:24:45 +07:00
[IMP] web: create how-to for using Owl components in the frontend closes odoo/documentation#8149 X-original-commit: e2598534865e0a1c526de5dbfc0b1722077b6bc4 Signed-off-by: Samuel Degueldre (sad) <sad@odoo.com>
2024-03-13 16:57:49 +07:00
.. card:: Use Owl components on the portal and website
:target: howtos/frontend_owl_components
Learn how to use Owl components on the portal and website.
[IMP] developer: improve navigation in top-level pages Prior to this commit, users had to either know in advance or guess the location of the content they were looking for. Top-level pages of the "Developer" section of the documentation, in particular the "Developer" page itself, were listing their sub-pages without directions for users. This commit brings the following changes to improve the navigation: - add directions for users on the "Developer" page and list the three main categories of developer documentation ("Tutorials", "How-to guides", and "Reference") with explanations of their content and target audience; - add categories for content cards on the "Tutorials" and "How-to guides" pages, and fine-tune the toctree of the "Reference" page to more easily locate specific topics; - clarify what are the "Python framework" and the "JavaScript framework" by relabelling them to "Server framework" and "Web framework" on top-level pages, as some users were confused to find that the JS framework was not responsible for the server, and others that the documentation for QWeb template is located in the Python documentation; - extract the "Setup guide" from the "Getting started" tutorial and rename the latter to "Server framework 101" to allow reusing the setup guide in other tutorials and make clear that the "Server framework 101" tutorial is not about the Web framework. task-3802536 closes odoo/documentation#8712 X-original-commit: 7f623b6ad5aac4c5ab3e21886cfb3331ee2b5c63 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com> Co-authored-by: Valeriya (vchu) <vchu@odoo.com>
2024-04-09 16:54:08 +07:00
.. card:: Website themes
:target: howtos/website_themes
Learn how to customize your website by creating a custom theme.
Server-side development
=======================
.. cards::
[ADD] extensions/cards: add an extension to implement cards The extension adds two new directive: - `cards` is the row container for one or more `card` directives. - `card` is the implementation of a Bootstrap card that accepts a `target` argument for the href of the card, a `large` option to render the card on two columns, a `tag` option to display a single arbitrary tag on the card, and arbitrary content that is shown in the card body. task-3141419 closes odoo/documentation#3689 X-original-commit: 34bc63d2bc887042f5eb15ecc5a0a0681c09f01e Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-18 23:37:41 +07:00
.. card:: Web services
:target: howtos/web_services
Learn more about Odoo's web services.
.. card:: Multi-company guidelines
:target: howtos/company
Learn how to manage multiple companies and deal with the records-related specificities of a
multi-company environment.
[REF] developer: rewrite sql view as a howto SQL view was formerly part of the dashboard tutorial which is now obsolete. Since creating a SQL view as a tutorial does not make sense anymore, it has been converted into a simple howto. closes odoo/documentation#4035 Task: 3226581 X-original-commit: 7124542ed9fcaa474d552cca5a9aff2f5a3c7c08 Signed-off-by: Tiffany Chang <tic@odoo.com>
2023-04-04 21:50:43 +07:00
.. card:: Create customized reports
:target: howtos/create_reports
Learn how to create customized reports with SQL Views.
[ADD] extensions/cards: add an extension to implement cards The extension adds two new directive: - `cards` is the row container for one or more `card` directives. - `card` is the implementation of a Bootstrap card that accepts a `target` argument for the href of the card, a `large` option to render the card on two columns, a `tag` option to display a single arbitrary tag on the card, and arbitrary content that is shown in the card body. task-3141419 closes odoo/documentation#3689 X-original-commit: 34bc63d2bc887042f5eb15ecc5a0a0681c09f01e Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-18 23:37:41 +07:00
.. card:: Accounting localization
:target: howtos/accounting_localization
Learn how to build a localization module, create bank operation models and dynamic reports.
.. card:: Translating modules
:target: howtos/translations
Learn how to provide translation abilities to your module.
.. card:: Connect with a device
:target: howtos/connect_device
Learn how to enable a module to detect and communicate with an IoT device.
[ADD] Upgrade documentation: How-to-guide for developers closes odoo/documentation#7336 X-original-commit: 44f4683519f55e7a864811c8fa1260018a3ab8b1 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-11-17 19:07:25 +07:00
[IMP] developer: improve navigation in top-level pages Prior to this commit, users had to either know in advance or guess the location of the content they were looking for. Top-level pages of the "Developer" section of the documentation, in particular the "Developer" page itself, were listing their sub-pages without directions for users. This commit brings the following changes to improve the navigation: - add directions for users on the "Developer" page and list the three main categories of developer documentation ("Tutorials", "How-to guides", and "Reference") with explanations of their content and target audience; - add categories for content cards on the "Tutorials" and "How-to guides" pages, and fine-tune the toctree of the "Reference" page to more easily locate specific topics; - clarify what are the "Python framework" and the "JavaScript framework" by relabelling them to "Server framework" and "Web framework" on top-level pages, as some users were confused to find that the JS framework was not responsible for the server, and others that the documentation for QWeb template is located in the Python documentation; - extract the "Setup guide" from the "Getting started" tutorial and rename the latter to "Server framework 101" to allow reusing the setup guide in other tutorials and make clear that the "Server framework 101" tutorial is not about the Web framework. task-3802536 closes odoo/documentation#8712 X-original-commit: 7f623b6ad5aac4c5ab3e21886cfb3331ee2b5c63 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com> Co-authored-by: Valeriya (vchu) <vchu@odoo.com>
2024-04-09 16:54:08 +07:00
Custom development
==================
.. cards::
[ADD] Upgrade documentation: How-to-guide for developers closes odoo/documentation#7336 X-original-commit: 44f4683519f55e7a864811c8fa1260018a3ab8b1 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-11-17 19:07:25 +07:00
.. card:: Upgrade a customized database
:target: howtos/upgrade_custom_db
[IMP] developer: improve navigation in top-level pages Prior to this commit, users had to either know in advance or guess the location of the content they were looking for. Top-level pages of the "Developer" section of the documentation, in particular the "Developer" page itself, were listing their sub-pages without directions for users. This commit brings the following changes to improve the navigation: - add directions for users on the "Developer" page and list the three main categories of developer documentation ("Tutorials", "How-to guides", and "Reference") with explanations of their content and target audience; - add categories for content cards on the "Tutorials" and "How-to guides" pages, and fine-tune the toctree of the "Reference" page to more easily locate specific topics; - clarify what are the "Python framework" and the "JavaScript framework" by relabelling them to "Server framework" and "Web framework" on top-level pages, as some users were confused to find that the JS framework was not responsible for the server, and others that the documentation for QWeb template is located in the Python documentation; - extract the "Setup guide" from the "Getting started" tutorial and rename the latter to "Server framework 101" to allow reusing the setup guide in other tutorials and make clear that the "Server framework 101" tutorial is not about the Web framework. task-3802536 closes odoo/documentation#8712 X-original-commit: 7f623b6ad5aac4c5ab3e21886cfb3331ee2b5c63 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com> Co-authored-by: Valeriya (vchu) <vchu@odoo.com>
2024-04-09 16:54:08 +07:00
Learn how to upgrade a customized database, as well as the code and data of its custom
modules.
Reference in New Issue Copy Permalink