diff --git a/partner_multi_relation_tabs/README.rst b/partner_multi_relation_tabs/README.rst index b74ef9700..debef275b 100644 --- a/partner_multi_relation_tabs/README.rst +++ b/partner_multi_relation_tabs/README.rst @@ -1,42 +1,147 @@ -.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg - :target: http://www.gnu.org/licenses/agpl - :alt: License: AGPL-3 +================================= +Show partner relations in own tab +================================= + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! 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%2Fpartner--contact-lightgray.png?logo=github + :target: https://github.com/OCA/partner-contact/tree/10.0/partner_multi_relation_tabs + :alt: OCA/partner-contact +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/partner-contact-10-0/partner-contact-10-0-partner_multi_relation_tabs + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/134/10.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module adds the possibility to show certain partner relations in a +tab on the partner form, in addition to in the list of all relations. + +This can be useful if certain relation types are regularly used and should +be overseeable at a glace. + +For instance you can make a tab named 'board' that will show all the board +members of a company, by showing the relations of types ceo, cto, cfo and +board member. + +**Table of contents** + +.. contents:: + :local: -======================== -Partner Relations in tab -======================== +Usage +===== -This module adds the possibility to show certain partner relations in its own -tab instead of the list of all relations. This can be useful if certain -relation types are regularly used and should be overseeable at a glace. +Relation Type Tabs +~~~~~~~~~~~~~~~~~~ +Before being able to show certain types of relations on a tab in the partner +form, you will have to define the tab. -Usage -===== +Do that in Partners / Partners / Contacts / Relation Tabs. + +.. image:: https://raw.githubusercontent.com/OCA/partner-contact/10.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-tab-configuration.png + +If you specify nothing, the tab will be shown on all partner forms that have +tabs (page elements). Normally you will select to show the tab only on +partners that are companies/organisations, or only for persons. You can also +select a category to further limit for which partners the tab wil be shown. + +The possibility exists to show a tab only on specific partners. For instance +on your own company partner. + +Relation Types +~~~~~~~~~~~~~~ + +In configuring the relation types, you can select which type of relation will +be shown on which tab. It is possible to show multiple types on one tab. + +Do that in Partners / Partners / Contacts / Partner Relation Types. + +For example on a 'executive board' tab, you might want to show the CEO of a +company, but also the CFO, the CTO and normal board members. + +You might specify a tab for both the 'left side' of a relation, as for the +'right side' or inverse relation. So a relation 'company has ceo', with +inverse type 'person is ceo of' might specify the 'board' tab for the +company type of the relation, but possibly a 'positions held' tab for the +person side of the relation, so on the partner form of a person you see in +one tab all positions or functions a person has, regardless in which company +or organisation. + +For each side of a relation, the partner contact type and the partner category +must be consistent with those specified for the tab. + +.. image:: https://raw.githubusercontent.com/OCA/partner-contact/10.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-relation-type-configuration.png + +Partner Form +~~~~~~~~~~~~ + +The partner form will contain extra tab pages, for each tab that is +appropiate for that partner. So a company partner does not show the tabs that +are meant for persons and vice versa. Also tabs meant for partners with +a certain category/label will only show if partners have that label. + +When adding relations on a tab, only relation types appropiate for that tab +can be selected. -To use this module, you need to: +Example of adding a relation: -#. Go to ... +.. image:: https://raw.githubusercontent.com/OCA/partner-contact/10.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-partner-edit.png -.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas - :alt: Try me on Runbot - :target: https://runbot.odoo-community.org/runbot/partner-contact/10.0 +Example of a filled out board tab: +.. image:: https://raw.githubusercontent.com/OCA/partner-contact/10.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-partner-display.png + +Deleting tabs +~~~~~~~~~~~~~ + +When a tab is deleted, this will in no way effect the existing relations + +However the references on the relation types to the deleted tabs will also be +cleared. + +Searching Relations by Tab +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You can search relations with the tab on which they are shown. For instance +to find all board members. + +Do that in Partners / Partners / Partner Relations. + +.. image:: https://raw.githubusercontent.com/OCA/partner-contact/10.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-relation-search.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 smash it by providing detailed and welcomed feedback. +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 +~~~~~~~ + +* Therp BV Contributors ------------- +~~~~~~~~~~~~ * Holger Brunn * Alexandre Fayolle @@ -44,20 +149,19 @@ Contributors * Ronald Portier * George Daramouskas -Do not contact contributors directly about support or help with technical issues. - +Maintainers +~~~~~~~~~~~ -Maintainer ----------- +This module is maintained by the OCA. .. image:: https://odoo-community.org/logo.png :alt: Odoo Community Association :target: https://odoo-community.org -This module is maintained by the OCA. - 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. -To contribute to this module, please visit https://odoo-community.org. +This module is part of the `OCA/partner-contact `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/partner_multi_relation_tabs/readme/CONTRIBUTORS.rst b/partner_multi_relation_tabs/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000..e26dd7ee6 --- /dev/null +++ b/partner_multi_relation_tabs/readme/CONTRIBUTORS.rst @@ -0,0 +1,5 @@ +* Holger Brunn +* Alexandre Fayolle +* Stéphane Bidoul +* Ronald Portier +* George Daramouskas diff --git a/partner_multi_relation_tabs/readme/DESCRIPTION.rst b/partner_multi_relation_tabs/readme/DESCRIPTION.rst new file mode 100644 index 000000000..81e8d227f --- /dev/null +++ b/partner_multi_relation_tabs/readme/DESCRIPTION.rst @@ -0,0 +1,9 @@ +This module adds the possibility to show certain partner relations in a +tab on the partner form, in addition to in the list of all relations. + +This can be useful if certain relation types are regularly used and should +be overseeable at a glace. + +For instance you can make a tab named 'board' that will show all the board +members of a company, by showing the relations of types ceo, cto, cfo and +board member. diff --git a/partner_multi_relation_tabs/readme/USAGE.rst b/partner_multi_relation_tabs/readme/USAGE.rst new file mode 100644 index 000000000..2c9247abb --- /dev/null +++ b/partner_multi_relation_tabs/readme/USAGE.rst @@ -0,0 +1,78 @@ +Relation Type Tabs +~~~~~~~~~~~~~~~~~~ + +Before being able to show certain types of relations on a tab in the partner +form, you will have to define the tab. + +Do that in Partners / Partners / Contacts / Relation Tabs. + +.. image:: https://raw.githubusercontent.com/OCA/partner-contact/10.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-tab-configuration.png + +If you specify nothing, the tab will be shown on all partner forms that have +tabs (page elements). Normally you will select to show the tab only on +partners that are companies/organisations, or only for persons. You can also +select a category to further limit for which partners the tab wil be shown. + +The possibility exists to show a tab only on specific partners. For instance +on your own company partner. + +Relation Types +~~~~~~~~~~~~~~ + +In configuring the relation types, you can select which type of relation will +be shown on which tab. It is possible to show multiple types on one tab. + +Do that in Partners / Partners / Contacts / Partner Relation Types. + +For example on a 'executive board' tab, you might want to show the CEO of a +company, but also the CFO, the CTO and normal board members. + +You might specify a tab for both the 'left side' of a relation, as for the +'right side' or inverse relation. So a relation 'company has ceo', with +inverse type 'person is ceo of' might specify the 'board' tab for the +company type of the relation, but possibly a 'positions held' tab for the +person side of the relation, so on the partner form of a person you see in +one tab all positions or functions a person has, regardless in which company +or organisation. + +For each side of a relation, the partner contact type and the partner category +must be consistent with those specified for the tab. + +.. image:: https://raw.githubusercontent.com/OCA/partner-contact/10.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-relation-type-configuration.png + +Partner Form +~~~~~~~~~~~~ + +The partner form will contain extra tab pages, for each tab that is +appropiate for that partner. So a company partner does not show the tabs that +are meant for persons and vice versa. Also tabs meant for partners with +a certain category/label will only show if partners have that label. + +When adding relations on a tab, only relation types appropiate for that tab +can be selected. + +Example of adding a relation: + +.. image:: https://raw.githubusercontent.com/OCA/partner-contact/10.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-partner-edit.png + +Example of a filled out board tab: + +.. image:: https://raw.githubusercontent.com/OCA/partner-contact/10.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-partner-display.png + +Deleting tabs +~~~~~~~~~~~~~ + +When a tab is deleted, this will in no way effect the existing relations + +However the references on the relation types to the deleted tabs will also be +cleared. + +Searching Relations by Tab +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You can search relations with the tab on which they are shown. For instance +to find all board members. + +Do that in Partners / Partners / Partner Relations. + +.. image:: https://raw.githubusercontent.com/OCA/partner-contact/10.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-relation-search.png diff --git a/partner_multi_relation_tabs/static/description/index.html b/partner_multi_relation_tabs/static/description/index.html new file mode 100644 index 000000000..037452fca --- /dev/null +++ b/partner_multi_relation_tabs/static/description/index.html @@ -0,0 +1,497 @@ + + + + + + +Show partner relations in own tab + + + +
+

Show partner relations in own tab

+ + +

Beta License: AGPL-3 OCA/partner-contact Translate me on Weblate Try me on Runbot

+

This module adds the possibility to show certain partner relations in a +tab on the partner form, in addition to in the list of all relations.

+

This can be useful if certain relation types are regularly used and should +be overseeable at a glace.

+

For instance you can make a tab named ‘board’ that will show all the board +members of a company, by showing the relations of types ceo, cto, cfo and +board member.

+

Table of contents

+ +
+

Usage

+
+

Relation Type Tabs

+

Before being able to show certain types of relations on a tab in the partner +form, you will have to define the tab.

+

Do that in Partners / Partners / Contacts / Relation Tabs.

+https://raw.githubusercontent.com/OCA/partner-contact/10.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-tab-configuration.png +

If you specify nothing, the tab will be shown on all partner forms that have +tabs (page elements). Normally you will select to show the tab only on +partners that are companies/organisations, or only for persons. You can also +select a category to further limit for which partners the tab wil be shown.

+

The possibility exists to show a tab only on specific partners. For instance +on your own company partner.

+
+
+

Relation Types

+

In configuring the relation types, you can select which type of relation will +be shown on which tab. It is possible to show multiple types on one tab.

+

Do that in Partners / Partners / Contacts / Partner Relation Types.

+

For example on a ‘executive board’ tab, you might want to show the CEO of a +company, but also the CFO, the CTO and normal board members.

+

You might specify a tab for both the ‘left side’ of a relation, as for the +‘right side’ or inverse relation. So a relation ‘company has ceo’, with +inverse type ‘person is ceo of’ might specify the ‘board’ tab for the +company type of the relation, but possibly a ‘positions held’ tab for the +person side of the relation, so on the partner form of a person you see in +one tab all positions or functions a person has, regardless in which company +or organisation.

+

For each side of a relation, the partner contact type and the partner category +must be consistent with those specified for the tab.

+https://raw.githubusercontent.com/OCA/partner-contact/10.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-relation-type-configuration.png +
+
+

Partner Form

+

The partner form will contain extra tab pages, for each tab that is +appropiate for that partner. So a company partner does not show the tabs that +are meant for persons and vice versa. Also tabs meant for partners with +a certain category/label will only show if partners have that label.

+

When adding relations on a tab, only relation types appropiate for that tab +can be selected.

+

Example of adding a relation:

+https://raw.githubusercontent.com/OCA/partner-contact/10.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-partner-edit.png +

Example of a filled out board tab:

+https://raw.githubusercontent.com/OCA/partner-contact/10.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-partner-display.png +
+
+

Deleting tabs

+

When a tab is deleted, this will in no way effect the existing relations

+

However the references on the relation types to the deleted tabs will also be +cleared.

+
+
+

Searching Relations by Tab

+

You can search relations with the tab on which they are shown. For instance +to find all board members.

+

Do that in Partners / Partners / Partner Relations.

+https://raw.githubusercontent.com/OCA/partner-contact/10.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-relation-search.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

+
    +
  • Therp BV
    • +
+
+
+

Contributors

+ +
+
+

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/partner-contact project on GitHub.

+

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

+
+
+
+ + diff --git a/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-partner-display.png b/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-partner-display.png new file mode 100644 index 000000000..8b8853e6b Binary files /dev/null and b/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-partner-display.png differ diff --git a/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-partner-edit.png b/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-partner-edit.png new file mode 100644 index 000000000..f1ca2c9ff Binary files /dev/null and b/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-partner-edit.png differ diff --git a/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-relation-search.png b/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-relation-search.png new file mode 100644 index 000000000..b5af8908f Binary files /dev/null and b/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-relation-search.png differ diff --git a/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-relation-type-configuration.png b/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-relation-type-configuration.png new file mode 100644 index 000000000..afd65fd62 Binary files /dev/null and b/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-relation-type-configuration.png differ diff --git a/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-tab-configuration.png b/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-tab-configuration.png new file mode 100644 index 000000000..a62a41280 Binary files /dev/null and b/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-tab-configuration.png differ diff --git a/partner_multi_relation_tabs/views/res_partner_tab.xml b/partner_multi_relation_tabs/views/res_partner_tab.xml index db1d1170e..4a2d5beed 100644 --- a/partner_multi_relation_tabs/views/res_partner_tab.xml +++ b/partner_multi_relation_tabs/views/res_partner_tab.xml @@ -15,12 +15,27 @@ res.partner.tab
- - - - - - + + + + + + + + + + +