From 833d65244600c0a15ca1f09c2efe48ab68689399 Mon Sep 17 00:00:00 2001 From: ernesto Date: Tue, 11 Dec 2018 23:43:31 -0500 Subject: [PATCH] [MIG] email_template_qweb: Migration to 12.0 --- email_template_qweb/README.rst | 69 ++- email_template_qweb/__manifest__.py | 5 +- email_template_qweb/readme/CONTRIBUTORS.rst | 6 + email_template_qweb/readme/DESCRIPTION.rst | 5 + email_template_qweb/readme/USAGE.rst | 5 + .../static/description/index.html | 446 ++++++++++++++++++ 6 files changed, 513 insertions(+), 23 deletions(-) create mode 100644 email_template_qweb/readme/CONTRIBUTORS.rst create mode 100644 email_template_qweb/readme/DESCRIPTION.rst create mode 100644 email_template_qweb/readme/USAGE.rst create mode 100644 email_template_qweb/static/description/index.html diff --git a/email_template_qweb/README.rst b/email_template_qweb/README.rst index 01e4b7e4..ffdc275d 100644 --- a/email_template_qweb/README.rst +++ b/email_template_qweb/README.rst @@ -1,17 +1,41 @@ -.. image:: https://img.shields.io/badge/license-AGPL--3-blue.png - :target: https://www.gnu.org/licenses/agpl - :alt: License: AGPL-3 - ======================== QWeb for email templates ======================== +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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-OCA%2Fsocial-lightgray.png?logo=github + :target: https://github.com/OCA/social/tree/12.0/email_template_qweb + :alt: OCA/social +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/social-12-0/social-12-0-email_template_qweb + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/205/12.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + This module was written to allow you to write email templates in QWeb instead of jinja2. The advantage here is that with QWeb, you can make use of inheritance and the ``call`` statement, which allows you to reuse designs and snippets in multiple templates, making your development process simpler. Furthermore, QWeb views are easier to edit with the integrated ACE editor. +**Table of contents** + +.. contents:: + :local: + Usage ===== @@ -21,45 +45,48 @@ To use this module, you need to: #. Select a QWeb view to be used to render the body field #. Apart from QWeb's standard variables, you also have access to ``object`` and ``email_template``, which are browse records of the current object and the email template in use, respectively. -.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas - :alt: Try me on Runbot - :target: https://runbot.odoo-community.org/runbot/205/11.0 - Bug Tracker =========== -Bugs are tracked on `GitHub Issues `_. In case of trouble, please -check there if your issue has already been reported. If you spotted it first, -help us smash it by providing detailed and welcomed feedback. +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. Credits ======= -Images ------- +Authors +~~~~~~~ -* Odoo Community Association: `Icon `_. +* Therp BV +* Tecnativa Contributors ------------- +~~~~~~~~~~~~ * Holger Brunn * Dave Lasley * Carlos Lopez Mite +* `Tecnativa `_: -Do not contact contributors directly about support or help with technical issues. + * Ernesto Tejeda + +Maintainers +~~~~~~~~~~~ -Maintainer ----------- +This module is maintained by the OCA. .. image:: https://odoo-community.org/logo.png :alt: Odoo Community Association :target: https://odoo-community.org -This module is maintained by the OCA. - OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use. -To contribute to this module, please visit https://odoo-community.org. +This module is part of the `OCA/social `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/email_template_qweb/__manifest__.py b/email_template_qweb/__manifest__.py index e9f01b27..ab816c1a 100644 --- a/email_template_qweb/__manifest__.py +++ b/email_template_qweb/__manifest__.py @@ -2,8 +2,9 @@ # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html). { "name": "QWeb for email templates", - "version": "11.0.1.0.0", - "author": "Therp BV,Odoo Community Association (OCA)", + "version": "12.0.1.0.0", + "author": "Therp BV, " + "Odoo Community Association (OCA)", "license": "AGPL-3", "category": "Marketing", "summary": "Use the QWeb templating mechanism for emails", diff --git a/email_template_qweb/readme/CONTRIBUTORS.rst b/email_template_qweb/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000..e19a1872 --- /dev/null +++ b/email_template_qweb/readme/CONTRIBUTORS.rst @@ -0,0 +1,6 @@ +* Holger Brunn +* Dave Lasley +* Carlos Lopez Mite +* `Tecnativa `_: + + * Ernesto Tejeda \ No newline at end of file diff --git a/email_template_qweb/readme/DESCRIPTION.rst b/email_template_qweb/readme/DESCRIPTION.rst new file mode 100644 index 00000000..b216735e --- /dev/null +++ b/email_template_qweb/readme/DESCRIPTION.rst @@ -0,0 +1,5 @@ +This module was written to allow you to write email templates in QWeb instead +of jinja2. The advantage here is that with QWeb, you can make use of +inheritance and the ``call`` statement, which allows you to reuse designs and +snippets in multiple templates, making your development process simpler. +Furthermore, QWeb views are easier to edit with the integrated ACE editor. diff --git a/email_template_qweb/readme/USAGE.rst b/email_template_qweb/readme/USAGE.rst new file mode 100644 index 00000000..67eb0b21 --- /dev/null +++ b/email_template_qweb/readme/USAGE.rst @@ -0,0 +1,5 @@ +To use this module, you need to: + +#. Select `QWeb` in the field `Body templating engine` +#. Select a QWeb view to be used to render the body field +#. Apart from QWeb's standard variables, you also have access to ``object`` and ``email_template``, which are browse records of the current object and the email template in use, respectively. diff --git a/email_template_qweb/static/description/index.html b/email_template_qweb/static/description/index.html new file mode 100644 index 00000000..227c1d81 --- /dev/null +++ b/email_template_qweb/static/description/index.html @@ -0,0 +1,446 @@ + + + + + + +QWeb for email templates + + + +
+

QWeb for email templates

+ + +

Beta License: AGPL-3 OCA/social Translate me on Weblate Try me on Runbot

+

This module was written to allow you to write email templates in QWeb instead +of jinja2. The advantage here is that with QWeb, you can make use of +inheritance and the call statement, which allows you to reuse designs and +snippets in multiple templates, making your development process simpler. +Furthermore, QWeb views are easier to edit with the integrated ACE editor.

+

Table of contents

+ +
+

Usage

+

To use this module, you need to:

+
    +
  1. Select QWeb in the field Body templating engine
    2. +
  2. Select a QWeb view to be used to render the body field
    3. +
  3. Apart from QWeb’s standard variables, you also have access to object and email_template, which are browse records of the current object and the email template in use, respectively.
    4. +
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Therp BV
    • +
  • Tecnativa
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.

+

This module is part of the OCA/social project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ +