~opencrea/+junk/aprobio

« back to all changes in this revision

Viewing changes to email_template_qweb/README.rst

  • Committer: joannes
  • Date: 2017-05-17 09:40:42 UTC
  • Revision ID: joannes@debian-20170517094042-47q3j6on72w2h1il
community module

Show diffs side-by-side

added added

removed removed

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