OCA reporting engine fork for dev and update.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

107 lines
4.2 KiB

6 years ago
  1. ==============
  2. Web QR Manager
  3. ==============
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github
  15. :target: https://github.com/OCA/reporting-engine/tree/11.0/report_qr
  16. :alt: OCA/reporting-engine
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/reporting-engine-11-0/reporting-engine-11-0-report_qr
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/143/11.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module allows to print QR in better structure than the standard odoo.
  25. The original image looks like the following
  26. .. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/11.0/report_qr/static/description/old_qr.png
  27. :alt: Original QR
  28. :width: 100 px
  29. With the new generator, it looks like:
  30. .. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/11.0/report_qr/static/description/new_qr.png
  31. :alt: New QR
  32. :width: 100 px
  33. **Table of contents**
  34. .. contents::
  35. :local:
  36. Usage
  37. =====
  38. When creating new reports, you should use a path like the following::
  39. <img t-att-src="'/report/qr/?value=%s&amp;error_correction=%s' % ('HELLO WORLD!', 3)" style="width:100;height:100"/>
  40. The **error_correction** parameter controls the error correction used for the QR Code. The following four constants are made available:
  41. * **error_correction** = 1: About 7% or less errors can be corrected.
  42. * **error_correction** = 0: About 15% or less errors can be corrected.
  43. * **error_correction** = 3: About 25% or less errors can be corrected.
  44. * **error_correction** = 2: About 30% or less errors can be corrected.
  45. The **box_size** parameter controls how many pixels each "box" of the QR code is. The default is 3.
  46. The **border** parameter controls how many boxes thick the border should be (the default is 4, which is the minimum according to the specs).
  47. The **version** parameter is an integer from 1 to 40 that controls the size of the QR Code (the smallest, version 1, is a 21x21 matrix). Set to None and use the fit parameter when making the code to determine this automatically.
  48. **fill_color** and **back_color** can change the background and the painting color of the QR, when using the default image factory.
  49. Bug Tracker
  50. ===========
  51. Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/issues>`_.
  52. In case of trouble, please check there if your issue has already been reported.
  53. If you spotted it first, help us smashing it by providing a detailed and welcomed
  54. `feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_qr%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  55. Do not contact contributors directly about support or help with technical issues.
  56. Credits
  57. =======
  58. Authors
  59. ~~~~~~~
  60. * Creu Blanca
  61. Contributors
  62. ~~~~~~~~~~~~
  63. * Enric Tobella <etobella@creublanca.es>
  64. Maintainers
  65. ~~~~~~~~~~~
  66. This module is maintained by the OCA.
  67. .. image:: https://odoo-community.org/logo.png
  68. :alt: Odoo Community Association
  69. :target: https://odoo-community.org
  70. OCA, or the Odoo Community Association, is a nonprofit organization whose
  71. mission is to support the collaborative development of Odoo features and
  72. promote its widespread use.
  73. This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/11.0/report_qr>`_ project on GitHub.
  74. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.