diff --git a/partner_multi_relation_tabs/README.rst b/partner_multi_relation_tabs/README.rst index c10c5b5df..82116e7bc 100644 --- a/partner_multi_relation_tabs/README.rst +++ b/partner_multi_relation_tabs/README.rst @@ -40,6 +40,88 @@ board member. .. contents:: :local: +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 Contacts / Relations / Relation Tabs. + +.. image:: https://raw.githubusercontent.com/OCA/partner-contact/11.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 Contacts / Relations / 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/11.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/11.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/11.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 Contacts / Relations / Relations. + +.. image:: https://raw.githubusercontent.com/OCA/partner-contact/11.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-relation-search.png + Bug Tracker =========== diff --git a/partner_multi_relation_tabs/readme/USAGE.rst b/partner_multi_relation_tabs/readme/USAGE.rst new file mode 100644 index 000000000..7f1fb518c --- /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 Contacts / Relations / Relation Tabs. + +.. image:: https://raw.githubusercontent.com/OCA/partner-contact/11.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 Contacts / Relations / 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/11.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/11.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/11.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 Contacts / Relations / Relations. + +.. image:: https://raw.githubusercontent.com/OCA/partner-contact/11.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 index b75d3ee57..3bb590b48 100644 --- a/partner_multi_relation_tabs/static/description/index.html +++ b/partner_multi_relation_tabs/static/description/index.html @@ -378,17 +378,85 @@ 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 Contacts / Relations / Relation Tabs.

+https://raw.githubusercontent.com/OCA/partner-contact/11.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 Contacts / Relations / 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/11.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/11.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/11.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 Contacts / Relations / Relations.

+https://raw.githubusercontent.com/OCA/partner-contact/11.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-relation-search.png +
-

Bug Tracker

+

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 @@ -396,15 +464,15 @@ If you spotted it first, help us smashing it by providing a detailed and welcome

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

-

Credits

+

Credits

-

Authors

+

Authors

-

Contributors

+

Contributors

-

Maintainers

+

Maintainers

This module is maintained by the OCA.

Odoo Community Association

OCA, or the Odoo Community Association, is a nonprofit organization whose 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..c9161441c 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..6f3fab813 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..9f02641fc 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..b6babfc72 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..23cdf2e6d Binary files /dev/null and b/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-tab-configuration.png differ