Metadata-Version: 2.1
Name: odoo-addon-footer_extra_info_base
Version: 16.0.1.0.0
Requires-Python: >=3.10
Requires-Dist: odoo>=16.0a,<16.1dev
Summary: Base module to include extra info in PDF footer
Home-page: https://github.com/sygel-technology/sy-web
License: AGPL-3
Author: Sygel, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 16.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3

======================
Footer Extra Info Base
======================

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

.. |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-sygel--technology%2Fsy--web-lightgray.png?logo=github
    :target: https://github.com/sygel-technology/sy-web/tree/16.0/footer_extra_info_base
    :alt: sygel-technology/sy-web

|badge1| |badge2| |badge3|

This is a base module and does nothing on its own. It provides an
abstract model that can be instantiated to include additional
information on PDF reports footer.

**Table of contents**

.. contents::
   :local:

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

In order to include additional information in the PDF footer of a given
model, it is necessary to create a new module that depends on this one
and do the following:

1. Inherit the abstract class "footer.extra.info.mixin" from the model
   which could add information to the PDF footer.
2. Override the \_compute_footer_extra_info method in
   "footer.extra.info.mixin" to set a value in field footer_extra_info,
   which is the field that contains the information that is added to the
   PDF footer.

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

Bugs are tracked on `GitHub Issues <https://github.com/sygel-technology/sy-web/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/sygel-technology/sy-web/issues/new?body=module:%20footer_extra_info_base%0Aversion:%2016.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
-------

* Sygel

Contributors
------------

-  Manuel Regidor <manuel.regidor@sygel.es>
-  Valentín Vinadre <valentin.vinagre@sygel.es>

Maintainers
-----------

This module is part of the `sygel-technology/sy-web <https://github.com/sygel-technology/sy-web/tree/16.0/footer_extra_info_base>`_ project on GitHub.

You are welcome to contribute.
