[IMP] product_multi_barcode: readme improved

Improve Readme USAGE, DESCRIPTIOM files and add the screenshot to be more user-friendly

product_multi_barcode/README.rst

@@ -28,7 +28,12 @@ Multiple barcodes on products
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
 
-This module allows you to define multiple barcodes on products.
+This module extends the standard product functionality by allowing multiple barcodes per product. Key features:
+
+* Define multiple barcodes for each product
+* Set main barcode by changing the sequence of the barcodes for each product
+* Search and find products using any of their assigned barcodes
+* Maintain full compatibility with standard barcode scanning operations
 
 **Table of contents**
 
@@ -38,9 +43,23 @@ This module allows you to define multiple barcodes on products.
 Usage
 =====
 
-A list of barcodes is available for each product with a priority, so a main barcode
+How to Set Multiple Barcodes for a Product:
+============================================
+
+1. Navigate to Products
+2. Select the desired product
+3. Add custom barcodes in the "Barcodes" field
+4. Set barcode priority by moving them up or down in the sequence
+5. Save the product
+
+Note: A list of barcodes is available for each product with a priority, so a main barcode
 code is defined.
 
+.. figure:: https://raw.githubusercontent.com/OCA/stock-logistics-barcode/16.0/product_multi_barcode/static/description/product_multi_barcode.png
+   :alt: Product Multi Barcode
+   :width: 600 px
+
+
 Bug Tracker
 ===========
 

product_multi_barcode/readme/DESCRIPTION.rst

@@ -1 +1,6 @@
-This module allows you to define multiple barcodes on products.
+This module extends the standard product functionality by allowing multiple barcodes per product. Key features:
+
+* Define multiple barcodes for each product
+* Set main barcode by changing the sequence of the barcodes for each product
+* Search and find products using any of their assigned barcodes
+* Maintain full compatibility with standard barcode scanning operations

product_multi_barcode/readme/USAGE.rst

@@ -1,2 +1,16 @@
-A list of barcodes is available for each product with a priority, so a main barcode
+How to Set Multiple Barcodes for a Product:
+============================================
+
+1. Navigate to Products
+2. Select the desired product
+3. Add custom barcodes in the "Barcodes" field
+4. Set barcode priority by moving them up or down in the sequence
+5. Save the product
+
+Note: A list of barcodes is available for each product with a priority, so a main barcode
 code is defined.
+
+.. figure:: ../static/description/product_multi_barcode.png
+   :alt: Product Multi Barcode
+   :width: 600 px
+

product_multi_barcode/static/description/index.html

@@ -8,10 +8,11 @@
 
 /*
 :Author: David Goodger (goodger@python.org)
-:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
+:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
 :Copyright: This stylesheet has been placed in the public domain.
 
 Default cascading style sheet for the HTML output of Docutils.
+Despite the name, some widely supported CSS2 features are used.
 
 See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
 customize this style sheet.
@@ -274,7 +275,7 @@
   margin-left: 2em ;
   margin-right: 2em }
 
-pre.code .ln { color: grey; } /* line numbers */
+pre.code .ln { color: gray; } /* line numbers */
 pre.code, code { background-color: #eeeeee }
 pre.code .comment, code .comment { color: #5C6576 }
 pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
@@ -300,7 +301,7 @@
 span.pre {
   white-space: pre }
 
-span.problematic {
+span.problematic, pre.problematic {
   color: red }
 
 span.section-subtitle {
@@ -369,37 +370,57 @@ <h1 class="title">Multiple barcodes on products</h1>
 !! source digest: sha256:9ef01fd1fe41f2bceb16613c4a7d5ca731849f60e90f640626becbdd4d0511d2
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
 <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/stock-logistics-barcode/tree/16.0/product_multi_barcode"><img alt="OCA/stock-logistics-barcode" src="https://img.shields.io/badge/github-OCA%2Fstock--logistics--barcode-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/stock-logistics-barcode-16-0/stock-logistics-barcode-16-0-product_multi_barcode"><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/stock-logistics-barcode&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 multiple barcodes on products.</p>
+<p>This module extends the standard product functionality by allowing multiple barcodes per product. Key features:</p>
+<ul class="simple">
+<li>Define multiple barcodes for each product</li>
+<li>Set main barcode by changing the sequence of the barcodes for each product</li>
+<li>Search and find products using any of their assigned barcodes</li>
+<li>Maintain full compatibility with standard barcode scanning operations</li>
+</ul>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
 <li><a class="reference internal" href="#usage" id="toc-entry-1">Usage</a></li>
-<li><a class="reference internal" href="#bug-tracker" id="toc-entry-2">Bug Tracker</a></li>
-<li><a class="reference internal" href="#credits" id="toc-entry-3">Credits</a><ul>
-<li><a class="reference internal" href="#authors" id="toc-entry-4">Authors</a></li>
-<li><a class="reference internal" href="#contributors" id="toc-entry-5">Contributors</a></li>
-<li><a class="reference internal" href="#maintainers" id="toc-entry-6">Maintainers</a></li>
+<li><a class="reference internal" href="#how-to-set-multiple-barcodes-for-a-product" id="toc-entry-2">How to Set Multiple Barcodes for a Product:</a></li>
+<li><a class="reference internal" href="#bug-tracker" id="toc-entry-3">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="toc-entry-4">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="toc-entry-5">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="toc-entry-6">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="toc-entry-7">Maintainers</a></li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="section" id="usage">
 <h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
-<p>A list of barcodes is available for each product with a priority, so a main barcode
+</div>
+<div class="section" id="how-to-set-multiple-barcodes-for-a-product">
+<h1><a class="toc-backref" href="#toc-entry-2">How to Set Multiple Barcodes for a Product:</a></h1>
+<ol class="arabic simple">
+<li>Navigate to Products</li>
+<li>Select the desired product</li>
+<li>Add custom barcodes in the “Barcodes” field</li>
+<li>Set barcode priority by moving them up or down in the sequence</li>
+<li>Save the product</li>
+</ol>
+<p>Note: A list of barcodes is available for each product with a priority, so a main barcode
 code is defined.</p>
+<div class="figure">
+<img alt="Product Multi Barcode" src="https://raw.githubusercontent.com/OCA/stock-logistics-barcode/16.0/product_multi_barcode/static/description/product_multi_barcode.png" style="width: 600px;" />
+</div>
 </div>
 <div class="section" id="bug-tracker">
-<h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-3">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/stock-logistics-barcode/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 to smash it by providing a detailed and welcomed
 <a class="reference external" href="https://github.com/OCA/stock-logistics-barcode/issues/new?body=module:%20product_multi_barcode%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
 <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="#toc-entry-3">Credits</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-4">Credits</a></h1>
 <div class="section" id="authors">
-<h2><a class="toc-backref" href="#toc-entry-4">Authors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-5">Authors</a></h2>
 <ul class="simple">
 <li>Camptocamp</li>
 <li>Trey</li>
@@ -409,7 +430,7 @@ <h2><a class="toc-backref" href="#toc-entry-4">Authors</a></h2>
 </ul>
 </div>
 <div class="section" id="contributors">
-<h2><a class="toc-backref" href="#toc-entry-5">Contributors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
 <ul class="simple">
 <li>Guewen Baconnier (Camptocamp)</li>
 <li>Roberto Lizana (Trey)</li>
@@ -425,9 +446,11 @@ <h2><a class="toc-backref" href="#toc-entry-5">Contributors</a></h2>
 </ul>
 </div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#toc-entry-6">Maintainers</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-7">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>
+<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
 mission is to support the collaborative development of Odoo features and
 promote its widespread use.</p>