You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

167 lines
6.4 KiB

  1. =================================
  2. Show partner relations in own tab
  3. =================================
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fpartner--contact-lightgray.png?logo=github
  15. :target: https://github.com/OCA/partner-contact/tree/11.0/partner_multi_relation_tabs
  16. :alt: OCA/partner-contact
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/partner-contact-11-0/partner-contact-11-0-partner_multi_relation_tabs
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/134/11.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module adds the possibility to show certain partner relations in a
  25. tab on the partner form, in addition to in the list of all relations.
  26. This can be useful if certain relation types are regularly used and should
  27. be overseeable at a glace.
  28. For instance you can make a tab named 'board' that will show all the board
  29. members of a company, by showing the relations of types ceo, cto, cfo and
  30. board member.
  31. **Table of contents**
  32. .. contents::
  33. :local:
  34. Usage
  35. =====
  36. Relation Type Tabs
  37. ~~~~~~~~~~~~~~~~~~
  38. Before being able to show certain types of relations on a tab in the partner
  39. form, you will have to define the tab.
  40. Do that in Contacts / Relations / Relation Tabs.
  41. .. image:: https://raw.githubusercontent.com/OCA/partner-contact/11.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-tab-configuration.png
  42. If you specify nothing, the tab will be shown on all partner forms that have
  43. tabs (page elements). Normally you will select to show the tab only on
  44. partners that are companies/organisations, or only for persons. You can also
  45. select a category to further limit for which partners the tab wil be shown.
  46. The possibility exists to show a tab only on specific partners. For instance
  47. on your own company partner.
  48. Relation Types
  49. ~~~~~~~~~~~~~~
  50. In configuring the relation types, you can select which type of relation will
  51. be shown on which tab. It is possible to show multiple types on one tab.
  52. Do that in Contacts / Relations / Relation Types.
  53. For example on a 'executive board' tab, you might want to show the CEO of a
  54. company, but also the CFO, the CTO and normal board members.
  55. You might specify a tab for both the 'left side' of a relation, as for the
  56. 'right side' or inverse relation. So a relation 'company has ceo', with
  57. inverse type 'person is ceo of' might specify the 'board' tab for the
  58. company type of the relation, but possibly a 'positions held' tab for the
  59. person side of the relation, so on the partner form of a person you see in
  60. one tab all positions or functions a person has, regardless in which company
  61. or organisation.
  62. For each side of a relation, the partner contact type and the partner category
  63. must be consistent with those specified for the tab.
  64. .. image:: https://raw.githubusercontent.com/OCA/partner-contact/11.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-relation-type-configuration.png
  65. Partner Form
  66. ~~~~~~~~~~~~
  67. The partner form will contain extra tab pages, for each tab that is
  68. appropiate for that partner. So a company partner does not show the tabs that
  69. are meant for persons and vice versa. Also tabs meant for partners with
  70. a certain category/label will only show if partners have that label.
  71. When adding relations on a tab, only relation types appropiate for that tab
  72. can be selected.
  73. Example of adding a relation:
  74. .. image:: https://raw.githubusercontent.com/OCA/partner-contact/11.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-partner-edit.png
  75. Example of a filled out board tab:
  76. .. image:: https://raw.githubusercontent.com/OCA/partner-contact/11.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-partner-display.png
  77. Deleting tabs
  78. ~~~~~~~~~~~~~
  79. When a tab is deleted, this will in no way effect the existing relations.
  80. However the references on the relation types to the deleted tabs will also be
  81. cleared.
  82. Searching Relations by Tab
  83. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  84. You can search relations with the tab on which they are shown. For instance
  85. to find all board members.
  86. Do that in Contacts / Relations / Relations.
  87. .. image:: https://raw.githubusercontent.com/OCA/partner-contact/11.0/partner_multi_relation_tabs/static/description/partner_multi_relation_tabs-relation-search.png
  88. Bug Tracker
  89. ===========
  90. Bugs are tracked on `GitHub Issues <https://github.com/OCA/partner-contact/issues>`_.
  91. In case of trouble, please check there if your issue has already been reported.
  92. If you spotted it first, help us smashing it by providing a detailed and welcomed
  93. `feedback <https://github.com/OCA/partner-contact/issues/new?body=module:%20partner_multi_relation_tabs%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  94. Do not contact contributors directly about support or help with technical issues.
  95. Credits
  96. =======
  97. Authors
  98. ~~~~~~~
  99. * Therp BV
  100. Contributors
  101. ~~~~~~~~~~~~
  102. * Holger Brunn <hbrunn@therp.nl>
  103. * Alexandre Fayolle <alexandre.fayolle@camptocamp.com>
  104. * Stéphane Bidoul <stephane.bidoul@acsone.eu>
  105. * Ronald Portier <ronald@therp.nl>
  106. * George Daramouskas <gdaramouskas@therp.nl>
  107. Maintainers
  108. ~~~~~~~~~~~
  109. This module is maintained by the OCA.
  110. .. image:: https://odoo-community.org/logo.png
  111. :alt: Odoo Community Association
  112. :target: https://odoo-community.org
  113. OCA, or the Odoo Community Association, is a nonprofit organization whose
  114. mission is to support the collaborative development of Odoo features and
  115. promote its widespread use.
  116. This module is part of the `OCA/partner-contact <https://github.com/OCA/partner-contact/tree/11.0/partner_multi_relation_tabs>`_ project on GitHub.
  117. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.