Skip to content

Commit

Permalink
[IMP] mail_layout_force: pre-commit auto fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
sergioM-S73 committed Jan 28, 2025
1 parent 004deb6 commit 9dced53
Show file tree
Hide file tree
Showing 9 changed files with 107 additions and 93 deletions.
69 changes: 36 additions & 33 deletions mail_layout_force/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,34 +17,36 @@ Mail Layout Force
: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/16.0/mail_layout_force
:target: https://github.com/OCA/social/tree/17.0/mail_layout_force
:alt: OCA/social
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/social-16-0/social-16-0-mail_layout_force
:target: https://translation.odoo-community.org/projects/social-17-0/social-17-0-mail_layout_force
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/social&target_branch=16.0
:target: https://runboat.odoo-community.org/builds?repo=OCA/social&target_branch=17.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

Odoo will add a default email layout on most commercial communications.

The email layout is a ``QWeb`` view that ends up wrapping the message body
when sending an email. It usually displays the related document reference,
the company logo, and a small footer saying "Powered by Odoo".
The email layout is a ``QWeb`` view that ends up wrapping the message
body when sending an email. It usually displays the related document
reference, the company logo, and a small footer saying "Powered by
Odoo".

There are notably two main layouts used in Odoo, and the user can't control when
they're used, as it's hardcoded into the different applications.
There are notably two main layouts used in Odoo, and the user can't
control when they're used, as it's hardcoded into the different
applications.

* ``mail.mail_notification_light``
* ``mail.mail_notification_paynow``
- ``mail.mail_notification_light``
- ``mail.mail_notification_paynow``

This module allows to force a specific layout for a given ``email.template``,
effectively overwritting the one hardcoded by Odoo.
This module allows to force a specific layout for a given
``email.template``, effectively overwritting the one hardcoded by Odoo.

This allows you to fully customize the way Odoo emails are rendered and sent
to your customers.
This allows you to fully customize the way Odoo emails are rendered and
sent to your customers.

**Table of contents**

Expand All @@ -54,50 +56,51 @@ to your customers.
Configuration
=============

# Go to Configuration > Technical > Emails > Templates
# Open the desired ``email.template`` record.
# In Advanced Parameters tab, find the Force Layout field.
# Go to Configuration > Technical > Emails > Templates # Open the
desired ``email.template`` record. # In Advanced Parameters tab, find
the Force Layout field.

You can leave it empty to use the default email layout (chosen by Odoo).
You can force a custom email layout of your own.
You can use the *Mail: No-Layout notification template* to prevent Odoo
from adding a layout.
You can force a custom email layout of your own. You can use the *Mail:
No-Layout notification template* to prevent Odoo from adding a layout.

To configure a custom layout of your own, some technical knowledge is needed.
You can see how the existing layouts are defined for details or inspiration:
To configure a custom layout of your own, some technical knowledge is
needed. You can see how the existing layouts are defined for details or
inspiration:

* ``mail.mail_notification_light``
* ``mail.mail_notification_paynow``
* ``mail.mail_notification_borders``
- ``mail.mail_notification_light``
- ``mail.mail_notification_paynow``
- ``mail.mail_notification_borders``

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/social/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/social/issues/new?body=module:%20mail_layout_force%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
`feedback <https://github.com/OCA/social/issues/new?body=module:%20mail_layout_force%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

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

Credits
=======

Authors
~~~~~~~
-------

* Camptocamp

Contributors
~~~~~~~~~~~~
------------

* `Camptocamp <https://www.camptocamp.com>`_
- `Camptocamp <https://www.camptocamp.com>`__

* Iván Todorovich <[email protected]>
* Abraham Anes <[email protected]>
- Iván Todorovich <[email protected]>

- Abraham Anes <[email protected]>

Maintainers
~~~~~~~~~~~
-----------

This module is maintained by the OCA.

Expand All @@ -117,6 +120,6 @@ Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-ivantodorovich|

This module is part of the `OCA/social <https://github.com/OCA/social/tree/16.0/mail_layout_force>`_ project on GitHub.
This module is part of the `OCA/social <https://github.com/OCA/social/tree/17.0/mail_layout_force>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
3 changes: 3 additions & 0 deletions mail_layout_force/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["whool"]
build-backend = "whool.buildapi"
15 changes: 15 additions & 0 deletions mail_layout_force/readme/CONFIGURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
\# Go to Configuration \> Technical \> Emails \> Templates \# Open the
desired `email.template` record. \# In Advanced Parameters tab, find the
Force Layout field.

You can leave it empty to use the default email layout (chosen by Odoo).
You can force a custom email layout of your own. You can use the *Mail:
No-Layout notification template* to prevent Odoo from adding a layout.

To configure a custom layout of your own, some technical knowledge is
needed. You can see how the existing layouts are defined for details or
inspiration:

- `mail.mail_notification_light`
- `mail.mail_notification_paynow`
- `mail.mail_notification_borders`
15 changes: 0 additions & 15 deletions mail_layout_force/readme/CONFIGURE.rst

This file was deleted.

5 changes: 5 additions & 0 deletions mail_layout_force/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
- [Camptocamp](https://www.camptocamp.com)

> - Iván Todorovich \<<[email protected]>\>
- Abraham Anes \<<[email protected]>\>
4 changes: 0 additions & 4 deletions mail_layout_force/readme/CONTRIBUTORS.rst

This file was deleted.

19 changes: 19 additions & 0 deletions mail_layout_force/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Odoo will add a default email layout on most commercial communications.

The email layout is a `QWeb` view that ends up wrapping the message body
when sending an email. It usually displays the related document
reference, the company logo, and a small footer saying "Powered by
Odoo".

There are notably two main layouts used in Odoo, and the user can't
control when they're used, as it's hardcoded into the different
applications.

- `mail.mail_notification_light`
- `mail.mail_notification_paynow`

This module allows to force a specific layout for a given
`email.template`, effectively overwritting the one hardcoded by Odoo.

This allows you to fully customize the way Odoo emails are rendered and
sent to your customers.
17 changes: 0 additions & 17 deletions mail_layout_force/readme/DESCRIPTION.rst

This file was deleted.

53 changes: 29 additions & 24 deletions mail_layout_force/static/description/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@

/*
:Author: David Goodger ([email protected])
:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
Despite the name, some widely supported CSS2 features are used.
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
customize this style sheet.
Expand Down Expand Up @@ -274,7 +275,7 @@
margin-left: 2em ;
margin-right: 2em }

pre.code .ln { color: grey; } /* line numbers */
pre.code .ln { color: gray; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
Expand All @@ -300,7 +301,7 @@
span.pre {
white-space: pre }

span.problematic {
span.problematic, pre.problematic {
color: red }

span.section-subtitle {
Expand Down Expand Up @@ -368,21 +369,23 @@ <h1 class="title">Mail Layout Force</h1>
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:c5314ada1e6f4529b208d4653748418fd6191918d30118ac8c012aca2a801b06
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/social/tree/16.0/mail_layout_force"><img alt="OCA/social" src="https://img.shields.io/badge/github-OCA%2Fsocial-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/social-16-0/social-16-0-mail_layout_force"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/social&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/social/tree/17.0/mail_layout_force"><img alt="OCA/social" src="https://img.shields.io/badge/github-OCA%2Fsocial-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/social-17-0/social-17-0-mail_layout_force"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/social&amp;target_branch=17.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>Odoo will add a default email layout on most commercial communications.</p>
<p>The email layout is a <tt class="docutils literal">QWeb</tt> view that ends up wrapping the message body
when sending an email. It usually displays the related document reference,
the company logo, and a small footer saying “Powered by Odoo”.</p>
<p>There are notably two main layouts used in Odoo, and the user can’t control when
they’re used, as it’s hardcoded into the different applications.</p>
<p>The email layout is a <tt class="docutils literal">QWeb</tt> view that ends up wrapping the message
body when sending an email. It usually displays the related document
reference, the company logo, and a small footer saying “Powered by
Odoo”.</p>
<p>There are notably two main layouts used in Odoo, and the user can’t
control when they’re used, as it’s hardcoded into the different
applications.</p>
<ul class="simple">
<li><tt class="docutils literal">mail.mail_notification_light</tt></li>
<li><tt class="docutils literal">mail.mail_notification_paynow</tt></li>
</ul>
<p>This module allows to force a specific layout for a given <tt class="docutils literal">email.template</tt>,
effectively overwritting the one hardcoded by Odoo.</p>
<p>This allows you to fully customize the way Odoo emails are rendered and sent
to your customers.</p>
<p>This module allows to force a specific layout for a given
<tt class="docutils literal">email.template</tt>, effectively overwritting the one hardcoded by Odoo.</p>
<p>This allows you to fully customize the way Odoo emails are rendered and
sent to your customers.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
Expand All @@ -398,15 +401,15 @@ <h1 class="title">Mail Layout Force</h1>
</div>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
<p># Go to Configuration &gt; Technical &gt; Emails &gt; Templates
# Open the desired <tt class="docutils literal">email.template</tt> record.
# In Advanced Parameters tab, find the Force Layout field.</p>
<p># Go to Configuration &gt; Technical &gt; Emails &gt; Templates # Open the
desired <tt class="docutils literal">email.template</tt> record. # In Advanced Parameters tab, find
the Force Layout field.</p>
<p>You can leave it empty to use the default email layout (chosen by Odoo).
You can force a custom email layout of your own.
You can use the <em>Mail: No-Layout notification template</em> to prevent Odoo
from adding a layout.</p>
<p>To configure a custom layout of your own, some technical knowledge is needed.
You can see how the existing layouts are defined for details or inspiration:</p>
You can force a custom email layout of your own. You can use the <em>Mail:
No-Layout notification template</em> to prevent Odoo from adding a layout.</p>
<p>To configure a custom layout of your own, some technical knowledge is
needed. You can see how the existing layouts are defined for details or
inspiration:</p>
<ul class="simple">
<li><tt class="docutils literal">mail.mail_notification_light</tt></li>
<li><tt class="docutils literal">mail.mail_notification_paynow</tt></li>
Expand All @@ -418,7 +421,7 @@ <h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/social/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/social/issues/new?body=module:%20mail_layout_force%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<a class="reference external" href="https://github.com/OCA/social/issues/new?body=module:%20mail_layout_force%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
Expand Down Expand Up @@ -446,13 +449,15 @@ <h2><a class="toc-backref" href="#toc-entry-5">Contributors</a></h2>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#toc-entry-6">Maintainers</a></h2>
<p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<a class="reference external image-reference" href="https://odoo-community.org">
<img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
</a>
<p>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.</p>
<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
<p><a class="reference external image-reference" href="https://github.com/ivantodorovich"><img alt="ivantodorovich" src="https://github.com/ivantodorovich.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/social/tree/16.0/mail_layout_force">OCA/social</a> project on GitHub.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/social/tree/17.0/mail_layout_force">OCA/social</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
</div>
</div>
Expand Down

0 comments on commit 9dced53

Please sign in to comment.