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.

91 lines
3.5 KiB

  1. ========================
  2. Report Wkhtmltopdf Param
  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/12.0/report_wkhtmltopdf_param
  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-12-0/reporting-engine-12-0-report_wkhtmltopdf_param
  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/12.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module allows you to add new parameters for a paper format which are
  25. then forwarded to wkhtmltopdf command as arguments. To display the arguments
  26. that wkhtmltopdf accepts go to your command line and type 'wkhtmltopdf -H'.
  27. A commonly used parameter in Odoo is *--disable-smart-shrinking*, that will
  28. disable the automatic resizing of the PDF when converting. This is
  29. important when you intend to have a layout that conforms to certain alignment.
  30. It is very common whenever you need to conform the PDF to a predefined
  31. layoyut (e.g. checks, official forms,...).
  32. **Table of contents**
  33. .. contents::
  34. :local:
  35. Usage
  36. =====
  37. #. Go to *Settings* and press 'Activate the developer mode (with assets)'
  38. #. Go to *Settings - Technical - Reports - Paper Format*
  39. #. Add additional parameters indicating the command argument name (remember to
  40. add prefix -- or -) and value.
  41. Bug Tracker
  42. ===========
  43. Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/issues>`_.
  44. In case of trouble, please check there if your issue has already been reported.
  45. If you spotted it first, help us smashing it by providing a detailed and welcomed
  46. `feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_wkhtmltopdf_param%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  47. Do not contact contributors directly about support or help with technical issues.
  48. Credits
  49. =======
  50. Authors
  51. ~~~~~~~
  52. * Avoin.Systems
  53. * Eficent
  54. Contributors
  55. ~~~~~~~~~~~~
  56. * Miku Laitinen <miku@avoin.systems>
  57. * Jordi Ballester <jordi.ballester@eficent.com>
  58. Maintainers
  59. ~~~~~~~~~~~
  60. This module is maintained by the OCA.
  61. .. image:: https://odoo-community.org/logo.png
  62. :alt: Odoo Community Association
  63. :target: https://odoo-community.org
  64. OCA, or the Odoo Community Association, is a nonprofit organization whose
  65. mission is to support the collaborative development of Odoo features and
  66. promote its widespread use.
  67. This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/12.0/report_wkhtmltopdf_param>`_ project on GitHub.
  68. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.