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.

72 lines
2.6 KiB

  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :alt: License: AGPL-3
  3. ========================
  4. QWeb for email templates
  5. ========================
  6. This module was written to allow you to write email templates in QWeb instead
  7. of jinja2. The advantage here is that with QWeb, you can make use of
  8. inheritance and the ``call`` statement, which allows you to reuse designs and
  9. snippets in multiple templates, making your development process simpler.
  10. Furthermore, QWeb views are easier to edit with the integrated ACE editor.
  11. Usage
  12. =====
  13. To use this module, you need to:
  14. * Select `QWeb` in the field `Body templating engine`
  15. * Select a QWeb view to be used to render the body field
  16. * Apart from QWeb's standard variables, you also have access to ``object`` and
  17. ``email_template``, which are browse records of the current object and the
  18. email template in use, respectively.
  19. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  20. :alt: Try me on Runbot
  21. :target: https://runbot.odoo-community.org/runbot/205/10.0
  22. Demo data contains an example on how to separate corporate identity from a
  23. template's content.
  24. For further information, please visit:
  25. * https://www.odoo.com/forum/help-1
  26. Bug Tracker
  27. ===========
  28. Bugs are tracked on `GitHub Issues <https://github.com/OCA/social/issues>`_.
  29. In case of trouble, please check there if your issue has already been reported.
  30. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
  31. `here <https://github.com/OCA/social/issues/new?body=module:%20email_template_qweb%0Aversion:%209.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  32. Credits
  33. =======
  34. Contributors
  35. ------------
  36. * Holger Brunn <hbrunn@therp.nl>
  37. * Dave Lasley <dave@laslabs.com>
  38. Do not contact contributors directly about help with questions or problems concerning
  39. this addon, but use the `forum <https://www.odoo.com/forum/help-1>`_,
  40. the `community mailing list <mailto:community@mail.odoo.com>`_,
  41. or the `appropriate specialized mailinglist <https://odoo-community.org/groups>`_ for help,
  42. and the bug tracker linked in `Bug Tracker`_ above for technical issues.
  43. Maintainer
  44. ----------
  45. .. image:: https://odoo-community.org/logo.png
  46. :alt: Odoo Community Association
  47. :target: https://odoo-community.org
  48. This module is maintained by the OCA.
  49. OCA, or the Odoo Community Association, is a nonprofit organization whose
  50. mission is to support the collaborative development of Odoo features and
  51. promote its widespread use.
  52. To contribute to this module, please visit https://odoo-community.org.