[IMP] product_pack: improve README

OCA · Feb 8, 2024 · 23ceb33 · 23ceb33
1 parent 977942c
commit 23ceb33
Show file tree

Hide file tree

Showing 3 changed files with 59 additions and 0 deletions.
diff --git a/product_pack/README.rst b/product_pack/README.rst
@@ -70,6 +70,15 @@ 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 the components | Yes, configurable |
+| **Detailed - Totalized** | Yes, with their prices at 0 | Components + Pack (unless you set a price for the pack in the pricelist) | 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 + Pack (unless you set a price for the pack in the pricelist) | 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,12 @@ 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 the components | Yes, configurable |
+| **Detailed - Totalized** | Yes, with their prices at 0 | Components + Pack (unless you set a price for the pack in the pricelist) | 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 + Pack (unless you set a price for the pack in the pricelist) | 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
@@ -421,6 +421,47 @@ <h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
 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.</li>
 </ul>
+<table class="table table-striped table-bordered">
+  <thead>
+    <tr>
+      <th>Pack type</th>
+      <th>Show components on SO?</th>
+      <th>Sale price</th>
+      <th>Discount</th>
+      <th>Can be modified?</th>
+    </tr>
+  </thead>
+  <tbody>
+    <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 + Pack (unless you set a price for the pack in the pricelist)</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 + Pack (unless you set a price for the pack in the pricelist)</td>
+      <td>Applies to the total (pack + components)</td>
+      <td>No</td>
+    </tr>
+  </tbody>
+</table>
 </blockquote>
 </div>
 <div class="section" id="known-issues-roadmap">