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.

93 lines
3.2 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 sucks a lot, so these templates are very
  12. verbose to ensure compatibility in most scenarios. Ideas are taken from
  13. 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. Usage
  20. =====
  21. To use this module, you need to:
  22. #. Install any module that makes use of the website mail designer, such as
  23. ``mass_mailing``.
  24. #. Edit an email with the website mail designer.
  25. #. You have a new collection of snippets. Use them as usual.
  26. If you choose the *Horizontal Separator* snippet, you will be able to set its
  27. height too. For that, you will have to aim carefully to click inside the green
  28. line, and then use the option that will float above it.
  29. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  30. :alt: Try me on Runbot
  31. :target: https://runbot.odoo-community.org/runbot/205/8.0
  32. Known issues / Roadmap
  33. ======================
  34. * Snippet code sucks, but that's because mail client HTML engines suck. I
  35. hope we will be able to improve this as mail clients keep improving.
  36. * To set the *Horizontal Separator* height, you have to click inside it, which
  37. will insert a ``<br type="_moz"/>`` in Firefox, that will make it seem like
  38. its height is at least like a caret, even if you set a lower value. Do not
  39. worry, it goes away when you press *Save*.
  40. Bug Tracker
  41. ===========
  42. Bugs are tracked on `GitHub Issues
  43. <https://github.com/OCA/social/issues>`_. In case of trouble, please
  44. check there if your issue has already been reported. If you spotted it first,
  45. help us smashing it by providing a detailed and welcomed `feedback
  46. <https://github.com/OCA/
  47. social/issues/new?body=module:%20
  48. website_mail_snippet_responsive%0Aversion:%20
  49. 8.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  50. Credits
  51. =======
  52. Images
  53. ------
  54. * Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
  55. Contributors
  56. ------------
  57. * Daniel Gómez-Zurita <danielgz@antiun.com>
  58. * Rafael Blasco <rafabn@antiun.com>
  59. * Jairo Llopis <yajo.sk8@gmail.com>
  60. Maintainer
  61. ----------
  62. .. image:: https://odoo-community.org/logo.png
  63. :alt: Odoo Community Association
  64. :target: https://odoo-community.org
  65. This module is maintained by the OCA.
  66. OCA, or the Odoo Community Association, is a nonprofit organization whose
  67. mission is to support the collaborative development of Odoo features and
  68. promote its widespread use.
  69. To contribute to this module, please visit https://odoo-community.org.