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.

116 lines
4.0 KiB

  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  3. :alt: License: AGPL-3
  4. =============================================
  5. Responsive Layout Snippets for Writing Emails
  6. =============================================
  7. This module extends the functionality of the website mail designer to support a
  8. responsive layout and allow you to read those mails comfortably in a mobile
  9. mail client.
  10. Well... actually this is not really responsive. It is pseudo-responsive.
  11. Responsiveness in current mail clients is years behind browsers', so these
  12. templates are very verbose to ensure compatibility in most scenarios. Ideas are
  13. taken from https://css-tricks.com/ideas-behind-responsive-emails/.
  14. Installation
  15. ============
  16. This module is prepared to be compatible with module ``website_mail_bg_color``.
  17. If you install it, you will be able to change snippets' background colors, but
  18. it is not required.
  19. Configuration
  20. =============
  21. To change the default background color for buttons:
  22. * Go to *Settings > Configuration > Website Settings > Mail >
  23. Mail button color*.
  24. * Input `any valid CSS2 color value
  25. <https://www.w3.org/TR/CSS2/syndata.html#value-def-color>`_.
  26. Usage
  27. =====
  28. To use this module, you need to:
  29. #. Install any module that makes use of the website mail designer, such as
  30. ``mass_mailing``.
  31. #. Edit an email with the website mail designer.
  32. #. You have a new collection of snippets under *Email Design* section. Use them
  33. as usual.
  34. If you choose the *Horizontal Separator* snippet, you will be able to set its
  35. height too. For that, you will have to aim carefully to click inside the green
  36. line, and then use the option that will float above it.
  37. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  38. :alt: Try me on Runbot
  39. :target: https://runbot.odoo-community.org/runbot/205/8.0
  40. Known issues / Roadmap
  41. ======================
  42. * Snippet is ugly, but that's because mail client HTML engines usually lack
  43. many of the modern CSS and HTML features. I hope we will be able to improve
  44. this as mail clients keep improving.
  45. * To set the *Horizontal Separator* height, you have to click inside it, which
  46. will insert a ``<br type="_moz"/>`` in Firefox, that will make it seem like
  47. its height is at least like a caret, even if you set a lower value. Do not
  48. worry, it goes away when you press *Save*.
  49. * Some elements do not render with the proper width in MS Outlook. This should
  50. be added inside each snippet to make them work::
  51. <!--[if gte mso]>
  52. <style type="text/css">
  53. .fluid { width: 600px !important; }
  54. </style>
  55. <![endif]-->
  56. But right now the view parser eats comments, and if you avoid that then
  57. CKEditor will eat them, so there's not an easy solution for now.
  58. Bug Tracker
  59. ===========
  60. Bugs are tracked on `GitHub Issues
  61. <https://github.com/OCA/social/issues>`_. In case of trouble, please
  62. check there if your issue has already been reported. If you spotted it first,
  63. help us smashing it by providing a detailed and welcomed `feedback
  64. <https://github.com/OCA/
  65. social/issues/new?body=module:%20
  66. website_mail_snippet_responsive%0Aversion:%20
  67. 8.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  68. Credits
  69. =======
  70. Images
  71. ------
  72. * Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
  73. Contributors
  74. ------------
  75. * Daniel Gómez-Zurita <danielgz@antiun.com>
  76. * Rafael Blasco <rafabn@antiun.com>
  77. * Jairo Llopis <yajo.sk8@gmail.com>
  78. Maintainer
  79. ----------
  80. .. image:: https://odoo-community.org/logo.png
  81. :alt: Odoo Community Association
  82. :target: https://odoo-community.org
  83. This module is maintained by the OCA.
  84. OCA, or the Odoo Community Association, is a nonprofit organization whose
  85. mission is to support the collaborative development of Odoo features and
  86. promote its widespread use.
  87. To contribute to this module, please visit https://odoo-community.org.