Browse Source

Better readme.

pull/501/head
François Kawala 5 years ago
parent
commit
06ff4a226b
  1. 36
      pos_barcode_tare/README.rst
  2. 32
      pos_barcode_tare/readme/DESCRIPTION.rst
  3. 2
      pos_barcode_tare/readme/ROADMAP.rst
  4. BIN
      pos_barcode_tare/static/description/POS_with_button.png
  5. 53
      pos_barcode_tare/static/description/index.html
  6. BIN
      pos_barcode_tare/static/description/label.png
  7. BIN
      pos_barcode_tare/static/description/null_weight.png
  8. BIN
      pos_barcode_tare/static/description/ready_to_print.png
  9. BIN
      pos_barcode_tare/static/description/zoom_action_widget.png

36
pos_barcode_tare/README.rst

@ -25,18 +25,30 @@ Point of Sale - Tare barecode labels for loose goods
|badge1| |badge2| |badge3| |badge4| |badge5| |badge1| |badge2| |badge3| |badge4| |badge5|
This add-on enable POS to read and print tare barcodes. A tare barcode is used to sell loose goods in a bring your own container (BYOC) scheme.
This add-on enables POS to read and print tare barcodes. We print a barcode tare label to sell loose goods in a Bring Your Own Container (BYOC) scheme.
The BYOC scheme has four steps: The BYOC scheme has four steps:
1. The cashier weights the container and sticks the tare bar code onto the customer's container.
2. The customer takes the desired quantity of the good s-he wants to buy.
3. The cashier weights the filled container and good, POS gives the corresponding price.
4. The cashier scans the tare bar code, POS removes the container's weight from the latest product of the order.
1. The cashier weighs the container and sticks the tare bar code onto the customer's pot.
2. The customer takes the desired quantity of the goods s-he wants to buy.
3. The cashier weighs the filled container and goods, and POS gives the corresponding price.
4. The cashier scans the tare bar code, and POS removes the container's weight from the latest product of the order.
This add-on adds a news screen to POS to (web) print the tare barcode labels. This add-on enables POS to read a tare
barecode. When such a barcode is read, POS adjusts the weight of the latest article in the order list.
The new weight is equal to the total weight minus the tare weight. The price is updated accordingly to the weight
change.
This add-on adds a news screen to POS to print (web) the tare barcode labels. This add-on enables POS to read a tare barcode. Reading a barcode makes POS adjust the weight of the latest article in the order list. The new weight is equal to the total weight minus the tare weight. The price is updated accordingly to the weight change.
POS home screen is now:
.. image:: https://raw.githubusercontent.com/OCA/pos/9.0/pos_barcode_tare/static/description/POS_with_button.png
The label screen is:
.. image:: https://raw.githubusercontent.com/OCA/pos/9.0/pos_barcode_tare/static/description/null_weight.png
When we read a weight the impression button is enabled
.. image:: https://raw.githubusercontent.com/OCA/pos/9.0/pos_barcode_tare/static/description/ready_to_print.png
A barcode label looks like:
.. image:: https://raw.githubusercontent.com/OCA/pos/9.0/pos_barcode_tare/static/description/label.png
Zoom on the action widget:
.. image:: https://raw.githubusercontent.com/OCA/pos/9.0/pos_barcode_tare/static/description/zoom_action_widget.png
**Table of contents** **Table of contents**
@ -48,6 +60,12 @@ Usage
Install this add-on and configure the point of sale where you want to be able to use the tare barecode. The label printing is done using web print. To streamline the label printing it is advised to use the silent printing mode (firefox) or the kiosk printing (chrome). Install this add-on and configure the point of sale where you want to be able to use the tare barecode. The label printing is done using web print. To streamline the label printing it is advised to use the silent printing mode (firefox) or the kiosk printing (chrome).
Known issues / Roadmap
======================
- Use barcode nomenclature instead of hardcoded barcode prefix 21.
- Add french translation.
Bug Tracker Bug Tracker
=========== ===========

32
pos_barcode_tare/readme/DESCRIPTION.rst

@ -1,12 +1,24 @@
This add-on enable POS to read and print tare barcodes. A tare barcode is used to sell loose goods in a bring your own container (BYOC) scheme.
This add-on enables POS to read and print tare barcodes. We print a barcode tare label to sell loose goods in a Bring Your Own Container (BYOC) scheme.
The BYOC scheme has four steps: The BYOC scheme has four steps:
1. The cashier weights the container and sticks the tare bar code onto the customer's container.
2. The customer takes the desired quantity of the good s-he wants to buy.
3. The cashier weights the filled container and good, POS gives the corresponding price.
4. The cashier scans the tare bar code, POS removes the container's weight from the latest product of the order.
This add-on adds a news screen to POS to (web) print the tare barcode labels. This add-on enables POS to read a tare
barecode. When such a barcode is read, POS adjusts the weight of the latest article in the order list.
The new weight is equal to the total weight minus the tare weight. The price is updated accordingly to the weight
change.
1. The cashier weighs the container and sticks the tare bar code onto the customer's pot.
2. The customer takes the desired quantity of the goods s-he wants to buy.
3. The cashier weighs the filled container and goods, and POS gives the corresponding price.
4. The cashier scans the tare bar code, and POS removes the container's weight from the latest product of the order.
This add-on adds a news screen to POS to print (web) the tare barcode labels. This add-on enables POS to read a tare barcode. Reading a barcode makes POS adjust the weight of the latest article in the order list. The new weight is equal to the total weight minus the tare weight. The price is updated accordingly to the weight change.
POS home screen is now:
.. image:: ../static/description/POS_with_button.png
The label screen is:
.. image:: ../static/description/null_weight.png
When we read a weight the impression button is enabled
.. image:: ../static/description/ready_to_print.png
A barcode label looks like:
.. image:: ../static/description/label.png
Zoom on the action widget:
.. image:: ../static/description/zoom_action_widget.png

2
pos_barcode_tare/readme/ROADMAP.rst

@ -0,0 +1,2 @@
- Use barcode nomenclature instead of hardcoded barcode prefix 21.
- Add french translation.

BIN
pos_barcode_tare/static/description/POS_with_button.png

After

Width: 1920  |  Height: 1080  |  Size: 625 KiB

53
pos_barcode_tare/static/description/index.html

@ -368,30 +368,38 @@ ul.auto-toc {
!! changes will be overwritten. !! !! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external" 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" 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" href="https://github.com/OCA/pos/tree/9.0/pos_barcode_tare"><img alt="OCA/pos" src="https://img.shields.io/badge/github-OCA%2Fpos-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/pos-9-0/pos-9-0-pos_barcode_tare"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/184/9.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p> <p><a class="reference external" 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" 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" href="https://github.com/OCA/pos/tree/9.0/pos_barcode_tare"><img alt="OCA/pos" src="https://img.shields.io/badge/github-OCA%2Fpos-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/pos-9-0/pos-9-0-pos_barcode_tare"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/184/9.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>This add-on enable POS to read and print tare barcodes. A tare barcode is used to sell loose goods in a bring your own container (BYOC) scheme.</p>
<p>This add-on enables POS to read and print tare barcodes. We print a barcode tare label to sell loose goods in a Bring Your Own Container (BYOC) scheme.</p>
<dl class="docutils"> <dl class="docutils">
<dt>The BYOC scheme has four steps:</dt> <dt>The BYOC scheme has four steps:</dt>
<dd><ol class="first last arabic simple"> <dd><ol class="first last arabic simple">
<li>The cashier weights the container and sticks the tare bar code onto the customer’s container.</li>
<li>The customer takes the desired quantity of the good s-he wants to buy.</li>
<li>The cashier weights the filled container and good, POS gives the corresponding price.</li>
<li>The cashier scans the tare bar code, POS removes the container’s weight from the latest product of the order.</li>
<li>The cashier weighs the container and sticks the tare bar code onto the customer’s pot.</li>
<li>The customer takes the desired quantity of the goods s-he wants to buy.</li>
<li>The cashier weighs the filled container and goods, and POS gives the corresponding price.</li>
<li>The cashier scans the tare bar code, and POS removes the container’s weight from the latest product of the order.</li>
</ol> </ol>
</dd> </dd>
</dl> </dl>
<p>This add-on adds a news screen to POS to (web) print the tare barcode labels. This add-on enables POS to read a tare
barecode. When such a barcode is read, POS adjusts the weight of the latest article in the order list.
The new weight is equal to the total weight minus the tare weight. The price is updated accordingly to the weight
change.</p>
<p>This add-on adds a news screen to POS to print (web) the tare barcode labels. This add-on enables POS to read a tare barcode. Reading a barcode makes POS adjust the weight of the latest article in the order list. The new weight is equal to the total weight minus the tare weight. The price is updated accordingly to the weight change.</p>
<p>POS home screen is now:
.. image:: <a class="reference external" href="https://raw.githubusercontent.com/OCA/pos/9.0/pos_barcode_tare/static/description/POS_with_button.png">https://raw.githubusercontent.com/OCA/pos/9.0/pos_barcode_tare/static/description/POS_with_button.png</a></p>
<p>The label screen is:
.. image:: <a class="reference external" href="https://raw.githubusercontent.com/OCA/pos/9.0/pos_barcode_tare/static/description/null_weight.png">https://raw.githubusercontent.com/OCA/pos/9.0/pos_barcode_tare/static/description/null_weight.png</a></p>
<p>When we read a weight the impression button is enabled
.. image:: <a class="reference external" href="https://raw.githubusercontent.com/OCA/pos/9.0/pos_barcode_tare/static/description/ready_to_print.png">https://raw.githubusercontent.com/OCA/pos/9.0/pos_barcode_tare/static/description/ready_to_print.png</a></p>
<p>A barcode label looks like:
.. image:: <a class="reference external" href="https://raw.githubusercontent.com/OCA/pos/9.0/pos_barcode_tare/static/description/label.png">https://raw.githubusercontent.com/OCA/pos/9.0/pos_barcode_tare/static/description/label.png</a></p>
<p>Zoom on the action widget:
.. image:: <a class="reference external" href="https://raw.githubusercontent.com/OCA/pos/9.0/pos_barcode_tare/static/description/zoom_action_widget.png">https://raw.githubusercontent.com/OCA/pos/9.0/pos_barcode_tare/static/description/zoom_action_widget.png</a></p>
<p><strong>Table of contents</strong></p> <p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents"> <div class="contents local topic" id="contents">
<ul class="simple"> <ul class="simple">
<li><a class="reference internal" href="#usage" id="id1">Usage</a></li> <li><a class="reference internal" href="#usage" id="id1">Usage</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id3">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id4">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id6">Maintainers</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id2">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id4">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id5">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id6">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id7">Maintainers</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -400,8 +408,15 @@ change.</p>
<h1><a class="toc-backref" href="#id1">Usage</a></h1> <h1><a class="toc-backref" href="#id1">Usage</a></h1>
<p>Install this add-on and configure the point of sale where you want to be able to use the tare barecode. The label printing is done using web print. To streamline the label printing it is advised to use the silent printing mode (firefox) or the kiosk printing (chrome).</p> <p>Install this add-on and configure the point of sale where you want to be able to use the tare barecode. The label printing is done using web print. To streamline the label printing it is advised to use the silent printing mode (firefox) or the kiosk printing (chrome).</p>
</div> </div>
<div class="section" id="known-issues-roadmap">
<h1><a class="toc-backref" href="#id2">Known issues / Roadmap</a></h1>
<ul class="simple">
<li>Use barcode nomenclature instead of hardcoded barcode prefix 21.</li>
<li>Add french translation.</li>
</ul>
</div>
<div class="section" id="bug-tracker"> <div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1>
<h1><a class="toc-backref" href="#id3">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/pos/issues">GitHub Issues</a>. <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/pos/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported. 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 If you spotted it first, help us smashing it by providing a detailed and welcomed
@ -409,22 +424,22 @@ 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> <p>Do not contact contributors directly about support or help with technical issues.</p>
</div> </div>
<div class="section" id="credits"> <div class="section" id="credits">
<h1><a class="toc-backref" href="#id3">Credits</a></h1>
<h1><a class="toc-backref" href="#id4">Credits</a></h1>
<div class="section" id="authors"> <div class="section" id="authors">
<h2><a class="toc-backref" href="#id4">Authors</a></h2>
<h2><a class="toc-backref" href="#id5">Authors</a></h2>
<ul class="simple"> <ul class="simple">
<li>Le Nid</li> <li>Le Nid</li>
</ul> </ul>
</div> </div>
<div class="section" id="contributors"> <div class="section" id="contributors">
<h2><a class="toc-backref" href="#id5">Contributors</a></h2>
<h2><a class="toc-backref" href="#id6">Contributors</a></h2>
<ul class="simple"> <ul class="simple">
<li>Le Nid</li> <li>Le Nid</li>
<li>CoopITEasy</li> <li>CoopITEasy</li>
</ul> </ul>
</div> </div>
<div class="section" id="maintainers"> <div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id6">Maintainers</a></h2>
<h2><a class="toc-backref" href="#id7">Maintainers</a></h2>
<p>This module is maintained by the OCA.</p> <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 <p>OCA, or the Odoo Community Association, is a nonprofit organization whose

BIN
pos_barcode_tare/static/description/label.png

After

Width: 576  |  Height: 393  |  Size: 7.4 KiB

BIN
pos_barcode_tare/static/description/null_weight.png

After

Width: 1920  |  Height: 1080  |  Size: 50 KiB

BIN
pos_barcode_tare/static/description/ready_to_print.png

After

Width: 1920  |  Height: 1080  |  Size: 50 KiB

BIN
pos_barcode_tare/static/description/zoom_action_widget.png

After

Width: 438  |  Height: 295  |  Size: 16 KiB

Loading…
Cancel
Save