[IMP] partner_multi_relation_tabs. Add USAGE.rst with screenshots.

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
 ===========
 

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

partner_multi_relation_tabs/static/description/index.html

@@ -378,17 +378,85 @@ board member.</p>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
-<li><a class="reference internal" href="#bug-tracker" id="id1">Bug Tracker</a></li>
-<li><a class="reference internal" href="#credits" id="id2">Credits</a><ul>
-<li><a class="reference internal" href="#authors" id="id3">Authors</a></li>
-<li><a class="reference internal" href="#contributors" id="id4">Contributors</a></li>
-<li><a class="reference internal" href="#maintainers" id="id5">Maintainers</a></li>
+<li><a class="reference internal" href="#usage" id="id1">Usage</a><ul>
+<li><a class="reference internal" href="#relation-type-tabs" id="id2">Relation Type Tabs</a></li>
+<li><a class="reference internal" href="#relation-types" id="id3">Relation Types</a></li>
+<li><a class="reference internal" href="#partner-form" id="id4">Partner Form</a></li>
+<li><a class="reference internal" href="#deleting-tabs" id="id5">Deleting tabs</a></li>
+<li><a class="reference internal" href="#searching-relations-by-tab" id="id6">Searching Relations by Tab</a></li>
 </ul>
 </li>
+<li><a class="reference internal" href="#bug-tracker" id="id7">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="id8">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="id9">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="id10">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="id11">Maintainers</a></li>
 </ul>
+</li>
+</ul>
+</div>
+<div class="section" id="usage">
+<h1><a class="toc-backref" href="#id1">Usage</a></h1>
+<div class="section" id="relation-type-tabs">
+<h2><a class="toc-backref" href="#id2">Relation Type Tabs</a></h2>
+<p>Before being able to show certain types of relations on a tab in the partner
+form, you will have to define the tab.</p>
+<p>Do that in Contacts / Relations / Relation Tabs.</p>
+<img alt="https://raw.githubusercontent.com/OCA/partner-contact/11.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-tab-configuration.png" src="https://raw.githubusercontent.com/OCA/partner-contact/11.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-tab-configuration.png" />
+<p>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.</p>
+<p>The possibility exists to show a tab only on specific partners. For instance
+on your own company partner.</p>
+</div>
+<div class="section" id="relation-types">
+<h2><a class="toc-backref" href="#id3">Relation Types</a></h2>
+<p>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.</p>
+<p>Do that in Contacts / Relations / Relation Types.</p>
+<p>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.</p>
+<p>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.</p>
+<p>For each side of a relation, the partner contact type and the partner category
+must be consistent with those specified for the tab.</p>
+<img alt="https://raw.githubusercontent.com/OCA/partner-contact/11.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-relation-type-configuration.png" src="https://raw.githubusercontent.com/OCA/partner-contact/11.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-relation-type-configuration.png" />
+</div>
+<div class="section" id="partner-form">
+<h2><a class="toc-backref" href="#id4">Partner Form</a></h2>
+<p>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.</p>
+<p>When adding relations on a tab, only relation types appropiate for that tab
+can be selected.</p>
+<p>Example of adding a relation:</p>
+<img alt="https://raw.githubusercontent.com/OCA/partner-contact/11.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-partner-edit.png" src="https://raw.githubusercontent.com/OCA/partner-contact/11.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-partner-edit.png" />
+<p>Example of a filled out board tab:</p>
+<img alt="https://raw.githubusercontent.com/OCA/partner-contact/11.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-partner-display.png" src="https://raw.githubusercontent.com/OCA/partner-contact/11.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-partner-display.png" />
+</div>
+<div class="section" id="deleting-tabs">
+<h2><a class="toc-backref" href="#id5">Deleting tabs</a></h2>
+<p>When a tab is deleted, this will in no way effect the existing relations.</p>
+<p>However the references on the relation types to the deleted tabs will also be
+cleared.</p>
+</div>
+<div class="section" id="searching-relations-by-tab">
+<h2><a class="toc-backref" href="#id6">Searching Relations by Tab</a></h2>
+<p>You can search relations with the tab on which they are shown. For instance
+to find all board members.</p>
+<p>Do that in Contacts / Relations / Relations.</p>
+<img alt="https://raw.githubusercontent.com/OCA/partner-contact/11.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-relation-search.png" src="https://raw.githubusercontent.com/OCA/partner-contact/11.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-relation-search.png" />
+</div>
 </div>
 <div class="section" id="bug-tracker">
-<h1><a class="toc-backref" href="#id1">Bug Tracker</a></h1>
+<h1><a class="toc-backref" href="#id7">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/partner-contact/issues">GitHub Issues</a>.
 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
 <p>Do not contact contributors directly about support or help with technical issues.</p>
 </div>
 <div class="section" id="credits">
-<h1><a class="toc-backref" href="#id2">Credits</a></h1>
+<h1><a class="toc-backref" href="#id8">Credits</a></h1>
 <div class="section" id="authors">
-<h2><a class="toc-backref" href="#id3">Authors</a></h2>
+<h2><a class="toc-backref" href="#id9">Authors</a></h2>
 <ul class="simple">
 <li>Therp BV</li>
 </ul>
 </div>
 <div class="section" id="contributors">
-<h2><a class="toc-backref" href="#id4">Contributors</a></h2>
+<h2><a class="toc-backref" href="#id10">Contributors</a></h2>
 <ul class="simple">
 <li>Holger Brunn &lt;<a class="reference external" href="mailto:hbrunn&#64;therp.nl">hbrunn&#64;therp.nl</a>&gt;</li>
 <li>Alexandre Fayolle &lt;<a class="reference external" href="mailto:alexandre.fayolle&#64;camptocamp.com">alexandre.fayolle&#64;camptocamp.com</a>&gt;</li>
@@ -414,7 +482,7 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
 </ul>
 </div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#id5">Maintainers</a></h2>
+<h2><a class="toc-backref" href="#id11">Maintainers</a></h2>
 <p>This module is maintained by the OCA.</p>
 <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
 <p>OCA, or the Odoo Community Association, is a nonprofit organization whose