[MIG] mail_layout_force: Migration to 18.0

Author: AungKoKoLin1997

mail_layout_force/README.rst

@@ -35,16 +35,16 @@ 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
+There are notably three main layouts used in Odoo, and the user can't
 control when they're used, as it's hardcoded into the different
 applications.
 
--  ``mail.message_notification_email``
+-  ``mail.mail_notification_layout``
+-  ``mail.mail_notification_layout_with_responsible_signature``
 -  ``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.
+``email.template``, effectively overwriting the one hardcoded by Odoo.
 Additionally, it enables forcing a custom layout for emails that do not
 use an existing ``email.template`` record (e.g., when sending an email
 from the chatter).
@@ -60,9 +60,11 @@ sent 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.
+To configure a forced layout for email templates:
+
+1. Go to *Settings > Technical > Email > Email Templates*
+2. Open the desired ``email.template`` record
+3. In the *Settings* 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:
@@ -72,20 +74,26 @@ 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_layout``
+-  ``mail.mail_notification_layout_with_responsible_signature``
 -  ``mail.mail_notification_light``
--  ``mail.mail_notification_paynow``
--  ``mail.mail_notification_borders``
-
-To force a new custom layout for emails that do not use an existing
-``email.template`` record (e.g., emails sent from the chatter):
-
-#. Go to Settings > Technical > User Interface > Views. #. Copy the
-current layout (e.g., mail.message_notification_email) to create a new
-one, and remove any parts you don’t need. #. Open the layout that you
-want to swap with a substitute. Then, under the Layout Mapping tab: \*
-Set ``Substitute Layout`` to the new custom layout you created. \* Set
-``Models`` if you want to apply the replacement only to specific models.
-If left empty, the email layout will be replaced for all models.
+
+To force a custom layout for emails that do not use an existing
+``email.template`` record (e.g., emails sent from the chatter), you can
+use the Layout Mapping feature:
+
+1. Go to *Settings > Technical > User Interface > Views*
+2. Copy the current layout (e.g.,
+   ``mail.mail_notification_layout_with_responsible_signature``) to
+   create a new custom layout, and customize it as needed
+3. Open the original layout view that you want to replace. Under the
+   *Layout Mapping* tab:
+
+   -  Click *Add a line*
+   -  Set *Substitute Layout* to the new custom layout you created
+   -  Set *Models* if you want to apply the replacement only to specific
+      models. If left empty, the email layout will be replaced for all
+      models
 
 Bug Tracker
 ===========

mail_layout_force/__manifest__.py

@@ -5,7 +5,7 @@
 {
     "name": "Mail Layout Force",
     "summary": "Force a mail layout on selected email templates",
-    "version": "17.0.1.0.1",
+    "version": "18.0.1.0.0",
     "author": "Camptocamp, Odoo Community Association (OCA)",
     "maintainers": ["ivantodorovich"],
     "website": "https://github.com/OCA/mail",

mail_layout_force/migrations/17.0.1.0.1/pre-migration.py

@@ -17,10 +17,10 @@ def _notify_thread_by_email(
         model_description=False,
         force_email_company=False,
         force_email_lang=False,
+        subtitles=None,
         resend_existing=False,
         force_send=True,
         send_after_commit=True,
-        subtitles=None,
         **kwargs,
     ):
         msg_vals = msg_vals or {}
@@ -56,9 +56,9 @@ def _notify_thread_by_email(
             model_description=model_description,
             force_email_company=force_email_company,
             force_email_lang=force_email_lang,
+            subtitles=subtitles,
             resend_existing=resend_existing,
             force_send=force_send,
             send_after_commit=send_after_commit,
-            subtitles=subtitles,
             **kwargs,
         )

mail_layout_force/models/mail_thread.py

@@ -1,6 +1,8 @@
-\# Go to Configuration \> Technical \> Emails \> Templates \# Open the
-desired `email.template` record. \# In Advanced Parameters tab, find the
-Force Layout field.
+To configure a forced layout for email templates:
+
+1. Go to *Settings > Technical > Email > Email Templates*
+2. Open the desired `email.template` record
+3. In the *Settings* 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:
@@ -10,16 +12,17 @@ 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_layout`
+- `mail.mail_notification_layout_with_responsible_signature`
 - `mail.mail_notification_light`
-- `mail.mail_notification_paynow`
-- `mail.mail_notification_borders`
 
-To force a new custom layout for emails that do not use an existing ``email.template``
-record (e.g., emails sent from the chatter):
+To force a custom layout for emails that do not use an existing `email.template`
+record (e.g., emails sent from the chatter), you can use the Layout Mapping feature:
 
-#. Go to Settings > Technical > User Interface > Views.
-#. Copy the current layout (e.g., mail.message_notification_email) to create a new one, and remove any parts you don’t need.
-#. Open the layout that you want to swap with a substitute. Then, under the Layout Mapping tab:
-    * Set ``Substitute Layout`` to the new custom layout you created.
-    * Set ``Models`` if you want to apply the replacement only to specific models. If left empty,
-      the email layout will be replaced for all models.
+1. Go to *Settings > Technical > User Interface > Views*
+2. Copy the current layout (e.g., `mail.mail_notification_layout_with_responsible_signature`) to create a new custom layout, and customize it as needed
+3. Open the original layout view that you want to replace. Under the *Layout Mapping* tab:
+    * Click *Add a line*
+    * Set *Substitute Layout* to the new custom layout you created
+    * Set *Models* if you want to apply the replacement only to specific models. If left empty,
+      the email layout will be replaced for all models

mail_layout_force/readme/CONFIGURE.md

@@ -4,15 +4,15 @@ 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
+There are notably three main layouts used in Odoo, and the user can't control when
 they're used, as it's hardcoded into the different applications.
 
-* ``mail.message_notification_email``
+* ``mail.mail_notification_layout``
+* ``mail.mail_notification_layout_with_responsible_signature``
 * ``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. Additionally, it enables
+effectively overwriting the one hardcoded by Odoo. Additionally, it enables
 forcing a custom layout for emails that do not use an existing ``email.template``
 record (e.g., when sending an email from the chatter).
 

mail_layout_force/readme/DESCRIPTION.md

@@ -1,3 +1,3 @@
 id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink
-access_email_layout_mapping_all,email.layout.mapping.all,model_email_layout_mapping,,1,0,0,0
+access_email_layout_mapping_user,email.layout.mapping.user,model_email_layout_mapping,base.group_user,1,0,0,0
 access_email_layout_mapping_admin,email.layout.mapping.admin,model_email_layout_mapping,base.group_system,1,1,1,1

mail_layout_force/security/ir.model.access.csv

@@ -375,16 +375,16 @@ <h1 class="title">Mail Layout Force</h1>
 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
+<p>There are notably three 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.message_notification_email</tt></li>
+<li><tt class="docutils literal">mail.mail_notification_layout</tt></li>
+<li><tt class="docutils literal">mail.mail_notification_layout_with_responsible_signature</tt></li>
 <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.
+<tt class="docutils literal">email.template</tt>, effectively overwriting the one hardcoded by Odoo.
 Additionally, it enables forcing a custom layout for emails that do not
 use an existing <tt class="docutils literal">email.template</tt> record (e.g., when sending an email
 from the chatter).</p>
@@ -405,29 +405,41 @@ <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>To configure a forced layout for email templates:</p>
+<ol class="arabic simple">
+<li>Go to <em>Settings &gt; Technical &gt; Email &gt; Email Templates</em></li>
+<li>Open the desired <tt class="docutils literal">email.template</tt> record</li>
+<li>In the <em>Settings</em> tab, find the <em>Force Layout</em> field</li>
+</ol>
 <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>
 <ul class="simple">
+<li><tt class="docutils literal">mail.mail_notification_layout</tt></li>
+<li><tt class="docutils literal">mail.mail_notification_layout_with_responsible_signature</tt></li>
 <li><tt class="docutils literal">mail.mail_notification_light</tt></li>
-<li><tt class="docutils literal">mail.mail_notification_paynow</tt></li>
-<li><tt class="docutils literal">mail.mail_notification_borders</tt></li>
 </ul>
-<p>To force a new custom layout for emails that do not use an existing
-<tt class="docutils literal">email.template</tt> record (e.g., emails sent from the chatter):</p>
-<p>#. Go to Settings &gt; Technical &gt; User Interface &gt; Views. #. Copy the
-current layout (e.g., mail.message_notification_email) to create a new
-one, and remove any parts you don’t need. #. Open the layout that you
-want to swap with a substitute. Then, under the Layout Mapping tab: *
-Set <tt class="docutils literal">Substitute Layout</tt> to the new custom layout you created. * Set
-<tt class="docutils literal">Models</tt> if you want to apply the replacement only to specific models.
-If left empty, the email layout will be replaced for all models.</p>
+<p>To force a custom layout for emails that do not use an existing
+<tt class="docutils literal">email.template</tt> record (e.g., emails sent from the chatter), you can
+use the Layout Mapping feature:</p>
+<ol class="arabic simple">
+<li>Go to <em>Settings &gt; Technical &gt; User Interface &gt; Views</em></li>
+<li>Copy the current layout (e.g.,
+<tt class="docutils literal">mail.mail_notification_layout_with_responsible_signature</tt>) to
+create a new custom layout, and customize it as needed</li>
+<li>Open the original layout view that you want to replace. Under the
+<em>Layout Mapping</em> tab:<ul>
+<li>Click <em>Add a line</em></li>
+<li>Set <em>Substitute Layout</em> to the new custom layout you created</li>
+<li>Set <em>Models</em> if you want to apply the replacement only to specific
+models. If left empty, the email layout will be replaced for all
+models</li>
+</ul>
+</li>
+</ol>
 </div>
 <div class="section" id="bug-tracker">
 <h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>

mail_layout_force/static/description/index.html

@@ -49,7 +49,7 @@ def setUpClass(cls):
                 "force_email_layout_id": cls.view.id,
             }
         )
-        cls.partner = cls.env.ref("base.res_partner_10")
+        cls.partner = cls.env["res.partner"].create({"name": "Test Partner"})
         cls.partner.message_ids.unlink()
         cls.partner.message_subscribe([cls.partner.id])
 

mail_layout_force/tests/test_mail_layout_force.py

@@ -12,10 +12,10 @@
                     invisible="type != 'qweb'"
                 >
                     <field name="layout_mapping_line_ids" nolabel="1">
-                        <tree editable="bottom">
+                        <list editable="bottom">
                             <field name="substitute_layout_id" />
                             <field name="model_ids" widget="many2many_tags" />
-                        </tree>
+                        </list>
                     </field>
                 </page>
             </xpath>