==========================================
Point of Sale - Custom Bill by Environment
==========================================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:f1584847bf35f621a07d253e84950595071042061b687ebef6193eb81a6f8b57
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
    :target: https://odoo-community.org/page/development-status
    :alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--env-lightgray.png?logo=github
    :target: https://github.com/OCA/server-env/tree/12.0/pos_environment
    :alt: OCA/server-env
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/server-env-12-0/server-env-12-0-pos_environment
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/server-env&target_branch=12.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module extends the Odoo point of sale module to allow administrator
to customize the bill printed by the point of sale, with a text depending
on your environment. (Development, , Pre Production, Production, etc...)

This module is based on the mechanism introduced by the ``server_environment``
module.

**Note**

This module works with or without IoT Box.

**Table of contents**

.. contents::
   :local:

Configuration
=============

* Open your module ``server_environment_files``

* In each environment folder, create a new file named ``pos_environment.conf``
  (for exemple)

* In each file, write a section like this one, depending on your environment

.. code-block::

  [pos_environment_header]
  line_1 = ===============================
  line_2 = TICKET EDITED ON A TEST
  line_3 = ENVIRONMENT
  line_4 = ===============================

  [pos_environment_footer]
  line_1 = ===============================
  line_2 = THIS TICKET HAS BEEN EDITED
  line_3 = ON A TEST ENVIRONMENT
  line_4 = -------------------------------
  line_5 = IT CAN NOT BE CONSIDERED
  line_6 = AS A PROOF OF PURCHASE
  line_7 = ===============================

**Internationalisation**

If you deploy Odoo in a multi languages context, you can add a suffix
``__xx_xx`` in the name of each line, where ``xx_xx`` is the language.
The text will be displayed on the bill, depending of the language of the
current user. Sample :

.. code-block::

  line_1 = ===============================
  line_2__en_US = TICKET EDITED ON A TEST SERVER
  line_2__fr_FR = TICKET EDITE SUR SERVEUR DE TEST
  line_3 = -------------------------------

**Note**

To be sure that your server is correctly configured, you can check the settings
in the Point of Sale configuration.


.. figure:: https://raw.githubusercontent.com/OCA/server-env/12.0/pos_environment/static/description/pos_config_form.png

Usage
=====

* Open Your Point of Sale

* Realize a sale

* The printed bill will display the custom message

.. figure:: https://raw.githubusercontent.com/OCA/server-env/12.0/pos_environment/static/description/receipt.png

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-env/issues>`_.
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
`feedback <https://github.com/OCA/server-env/issues/new?body=module:%20pos_environment%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
~~~~~~~

* GRAP

Contributors
~~~~~~~~~~~~

* Sylvain LE GAL (https://www.twitter.com/legalsylvain)

Maintainers
~~~~~~~~~~~

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

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.

This module is part of the `OCA/server-env <https://github.com/OCA/server-env/tree/12.0/pos_environment>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.