From 2c4ec16c7d4bec9897a7bc756326e69b93445525 Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Tue, 16 Mar 2021 13:31:31 +0000 Subject: [PATCH] [UPD] README.rst --- server_action_navigate/README.rst | 122 ++++++++++++++++++ .../static/description/index.html | 94 +++++++++----- 2 files changed, 186 insertions(+), 30 deletions(-) diff --git a/server_action_navigate/README.rst b/server_action_navigate/README.rst index 2f8de2de..0c10b46e 100644 --- a/server_action_navigate/README.rst +++ b/server_action_navigate/README.rst @@ -6,3 +6,125 @@ Server Actions - Navigate !! This file is generated by oca-gen-addon-readme !! !! changes will be overwritten. !! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--backend-lightgray.png?logo=github + :target: https://github.com/OCA/server-backend/tree/12.0/server_action_navigate + :alt: OCA/server-backend +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-backend-12-0/server-backend-12-0-server_action_navigate + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/253/12.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module provides a generic tool to have the possibility to see a list of +records associated to a given selection of records. This is basically the UI version of ``recordset.mapped('field1.field2')``. + +For example, if you use the sale module, you can configure an action to see +all the products that have been sold for a given selection of sale orders. + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +* Go to 'Setting / Technical / Actions / Server Actions' + +* Create a new item + +.. figure:: https://raw.githubusercontent.com/OCA/server-backend/12.0/server_action_navigate/static/description/ir_actions_server_form.png + +* Set a name that will be used for the Contextual Action + +* Choose a model + +* Select 'Navigate' option in the field 'Action To Do' + +* Then, select a field of this model. It can be a ``one2many``, ``many2many``, + ``many2one`` field. + +* You can then optionally select another fields (#2) that belong to the previous + selected field (#1) relation model + +* Once done, click on the 'Create Contextual Action' to generate a new 'More options' + button. + + +**Extra options** + +* You can define groups whose members will have access to that option. + +* You can select an action that will be used to display the target field list. + +Usage +===== + +* Go to a tree view, for a model for which you have defined a navigation action. + +* click on 'Action' Button + +.. figure:: https://raw.githubusercontent.com/OCA/server-backend/12.0/server_action_navigate/static/description/sale_order_tree.png + + +* then click on the name of the configured Action and see the results + +.. figure:: https://raw.githubusercontent.com/OCA/server-backend/12.0/server_action_navigate/static/description/product_product_tree.png + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* GRAP + +Contributors +~~~~~~~~~~~~ + +* Sylvain LE GAL (https://www.twitter.com/legalsylvain) + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +.. |maintainer-legalsylvain| image:: https://github.com/legalsylvain.png?size=40px + :target: https://github.com/legalsylvain + :alt: legalsylvain + +Current `maintainer `__: + +|maintainer-legalsylvain| + +This module is part of the `OCA/server-backend `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/server_action_navigate/static/description/index.html b/server_action_navigate/static/description/index.html index 073274ff..b56ca7f2 100644 --- a/server_action_navigate/static/description/index.html +++ b/server_action_navigate/static/description/index.html @@ -4,7 +4,7 @@ -Mass Operation Abstract +Server Actions - Navigate -
-

Mass Operation Abstract

+
+

Server Actions - Navigate

-

Beta License: AGPL-3 OCA/server-ux Translate me on Weblate Try me on Runbot

-

This module provides generic tools to develop modules that process mass -operations on any models.

+

Beta License: AGPL-3 OCA/server-backend Translate me on Weblate Try me on Runbot

+

This module provides a generic tool to have the possibility to see a list of +records associated to a given selection of records. This is basically the UI version of recordset.mapped('field1.field2').

+

For example, if you use the sale module, you can configure an action to see +all the products that have been sold for a given selection of sale orders.

Table of contents

-
-

Known issues / Roadmap

+
+

Configuration

    -
  • Propose this module in the OCA. (server-tools repository)
    • -
  • refactor mass_editing and mass_sorting OCA modules to depend on -this module.
    • -
  • Develop new modules like:
    • +
  • Go to ‘Setting / Technical / Actions / Server Actions’
    • +
  • Create a new item
-
    -
  1. mass_scripting to have the possibility to execute custom python code -on any model, for selected items.
    2. -
+
+https://raw.githubusercontent.com/OCA/server-backend/12.0/server_action_navigate/static/description/ir_actions_server_form.png +
+
    +
  • Set a name that will be used for the Contextual Action
    • +
  • Choose a model
    • +
  • Select ‘Navigate’ option in the field ‘Action To Do’
    • +
  • Then, select a field of this model. It can be a one2many, many2many, +many2one field.
    • +
  • You can then optionally select another fields (#2) that belong to the previous +selected field (#1) relation model
    • +
  • Once done, click on the ‘Create Contextual Action’ to generate a new ‘More options’ +button.
    • +
+

Extra options

+
    +
  • You can define groups whose members will have access to that option.
    • +
  • You can select an action that will be used to display the target field list.
    • +
+
+
+

Usage

+
    +
  • Go to a tree view, for a model for which you have defined a navigation action.
    • +
  • click on ‘Action’ Button
    • +
+
+https://raw.githubusercontent.com/OCA/server-backend/12.0/server_action_navigate/static/description/sale_order_tree.png +
+
    +
  • then click on the name of the configured Action and see the results
    • +
+
+https://raw.githubusercontent.com/OCA/server-backend/12.0/server_action_navigate/static/description/product_product_tree.png +
-

Bug Tracker

-

Bugs are tracked on GitHub Issues. +

Bug Tracker

+

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed -feedback.

+feedback.

Do not contact contributors directly about support or help with technical issues.

-

Credits

+

Credits

-

Authors

+

Authors

  • GRAP
-

Maintainers

+

Maintainers

This module is maintained by the OCA.

Odoo Community Association

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

-

This module is part of the OCA/server-ux project on GitHub.

+

Current maintainer:

+

legalsylvain

+

This module is part of the OCA/server-backend project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.