[IMP] product_pack: improve README

OCA · Jul 4, 2024 · 0eaf236 · 0eaf236
1 parent 6d5f973
commit 0eaf236
Show file tree

Hide file tree

Showing 3 changed files with 77 additions and 2 deletions.
diff --git a/product_pack/README.rst b/product_pack/README.rst
@@ -7,7 +7,7 @@ Product Pack
    !! This file is generated by oca-gen-addon-readme !!
    !! changes will be overwritten.                   !!
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-   !! source digest: sha256:d6d79cfb1448cba3c8cc68f89101f6b53245f8a695effd2058ca881dac328748
+   !! source digest: sha256:6412314c32b470ebaa9ba73edd671e2513bf0b8c9faa4703dcb22faf76692670
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
@@ -70,6 +70,21 @@ The options of this field are the followings:
     components prices. The pack product will be the only one that has price
     and this one will be the price set in the pack product.
 
++-----------------------------+-----------------------------+---------------------------------+-----------------------------------------+----------------------+
+| **Pack type**               | **Show components on SO?**  | **Sale price**                  | **Discount**                            | **Can be modified?** |
++=============================+=============================+=================================+=========================================+======================+
+| **Detailed per components** | Yes, with their prices      | Components + Pack               | Applies to the price of the pack and    | Yes, configurable    |
+|                             |                             |                                 | the components                          |                      |
++-----------------------------+-----------------------------+---------------------------------+-----------------------------------------+----------------------+
+| **Detailed - Totalized**    | Yes, with their prices at 0 | Components                      | Applies to the total (pack + components)| No                   |
++-----------------------------+-----------------------------+---------------------------------+-----------------------------------------+----------------------+
+| **Detailed - Ignored**      | Yes, with their prices at 0 | Only Pack                       | Applies to the pack                     | No                   |
++-----------------------------+-----------------------------+---------------------------------+-----------------------------------------+----------------------+
+| **No detailed**             | No                          | Components                      | Applies to the total (pack + components)| No                   |
++-----------------------------+-----------------------------+---------------------------------+-----------------------------------------+----------------------+
+
+**Note:** If pricelist enabled, Odoo will display the price according to the corresponding pricelist. In the case of a pricelist with discount policy "Show public price & discount to the customer" keep in mind that the "Non Detailed" and "Detailed - Totalized in main product" packs do not display the discount.
+
 Known issues / Roadmap
 ======================
 

diff --git a/product_pack/readme/USAGE.rst b/product_pack/readme/USAGE.rst
@@ -28,3 +28,18 @@ The options of this field are the followings:
   * Ignored: will show each components but will not show
     components prices. The pack product will be the only one that has price
     and this one will be the price set in the pack product.
+
++-----------------------------+-----------------------------+---------------------------------+-----------------------------------------+----------------------+
+| **Pack type**               | **Show components on SO?**  | **Sale price**                  | **Discount**                            | **Can be modified?** |
++=============================+=============================+=================================+=========================================+======================+
+| **Detailed per components** | Yes, with their prices      | Components + Pack               | Applies to the price of the pack and    | Yes, configurable    |
+|                             |                             |                                 | the components                          |                      |
++-----------------------------+-----------------------------+---------------------------------+-----------------------------------------+----------------------+
+| **Detailed - Totalized**    | Yes, with their prices at 0 | Components                      | Applies to the total (pack + components)| No                   |
++-----------------------------+-----------------------------+---------------------------------+-----------------------------------------+----------------------+
+| **Detailed - Ignored**      | Yes, with their prices at 0 | Only Pack                       | Applies to the pack                     | No                   |
++-----------------------------+-----------------------------+---------------------------------+-----------------------------------------+----------------------+
+| **No detailed**             | No                          | Components                      | Applies to the total (pack + components)| No                   |
++-----------------------------+-----------------------------+---------------------------------+-----------------------------------------+----------------------+
+
+**Note:** If pricelist enabled, Odoo will display the price according to the corresponding pricelist. In the case of a pricelist with discount policy "Show public price & discount to the customer" keep in mind that the "Non Detailed" and "Detailed - Totalized in main product" packs do not display the discount.
diff --git a/product_pack/static/description/index.html b/product_pack/static/description/index.html
@@ -366,7 +366,7 @@ <h1 class="title">Product Pack</h1>
 !! This file is generated by oca-gen-addon-readme !!
 !! changes will be overwritten.                   !!
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-!! source digest: sha256:d6d79cfb1448cba3c8cc68f89101f6b53245f8a695effd2058ca881dac328748
+!! source digest: sha256:6412314c32b470ebaa9ba73edd671e2513bf0b8c9faa4703dcb22faf76692670
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
 <p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/product-pack/tree/16.0/product_pack"><img alt="OCA/product-pack" src="https://img.shields.io/badge/github-OCA%2Fproduct--pack-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/product-pack-16-0/product-pack-16-0-product_pack"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/product-pack&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
 <p>This module allows you to define a product as a <em>Product Pack</em>. Each
@@ -421,6 +421,51 @@ <h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
 and this one will be the price set in the pack product.</li>
 </ul>
 </blockquote>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="19%" />
+<col width="21%" />
+<col width="27%" />
+<col width="14%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head"><strong>Pack type</strong></th>
+<th class="head"><strong>Show components on SO?</strong></th>
+<th class="head"><strong>Sale price</strong></th>
+<th class="head"><strong>Discount</strong></th>
+<th class="head"><strong>Can be modified?</strong></th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td><strong>Detailed per components</strong></td>
+<td>Yes, with their prices</td>
+<td>Components + Pack</td>
+<td>Applies to the price of the pack and
+the components</td>
+<td>Yes, configurable</td>
+</tr>
+<tr><td><strong>Detailed - Totalized</strong></td>
+<td>Yes, with their prices at 0</td>
+<td>Components</td>
+<td>Applies to the total (pack + components)</td>
+<td>No</td>
+</tr>
+<tr><td><strong>Detailed - Ignored</strong></td>
+<td>Yes, with their prices at 0</td>
+<td>Only Pack</td>
+<td>Applies to the pack</td>
+<td>No</td>
+</tr>
+<tr><td><strong>No detailed</strong></td>
+<td>No</td>
+<td>Components</td>
+<td>Applies to the total (pack + components)</td>
+<td>No</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Note:</strong> If pricelist enabled, Odoo will display the price according to the corresponding pricelist. In the case of a pricelist with discount policy “Show public price &amp; discount to the customer” keep in mind that the “Non Detailed” and “Detailed - Totalized in main product” packs do not display the discount.</p>
 </div>
 <div class="section" id="known-issues-roadmap">
 <h1><a class="toc-backref" href="#toc-entry-2">Known issues / Roadmap</a></h1>