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.

107 lines
3.8 KiB

  1. ==================================
  2. Web Editor Background Color Picker
  3. ==================================
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
  13. :alt: License: LGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github
  15. :target: https://github.com/OCA/web/tree/12.0/web_editor_background_color
  16. :alt: OCA/web
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/web-12-0/web-12-0-web_editor_background_color
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/162/12.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module extends the functionality of the web editor to support
  25. setting a custom background color to any snippet allowing you to customize it.
  26. .. figure:: https://user-images.githubusercontent.com/973709/46802401-1c915180-cd55-11e8-9397-f198548a690c.gif
  27. :alt: Screenshot of color picker in mass mailing editor
  28. **Table of contents**
  29. .. contents::
  30. :local:
  31. Usage
  32. =====
  33. To use this module, you need to:
  34. #. Install any module that makes use of the web editor, such as
  35. ``mass_mailing`` or ``website``.
  36. #. Use that module's facilities to edit some web content.
  37. #. Drag & drop any snippet into the web editor body.
  38. #. Click on *Customize > Text-Image > Background Color > </> icon*.
  39. #. Choose a custom color by either:
  40. * Writing any valid HTML color code in the text input.
  41. * Selecting a color from the color picker.
  42. Known issues / Roadmap
  43. ======================
  44. * Preview when user plays with colors.
  45. See https://github.com/OCA/web/pull/1327#issuecomment-509621572 to understand
  46. the (co/i)mplications.
  47. * When (& if) Odoo merges https://github.com/odoo/odoo/pull/34687, this
  48. module will no longer be needed.
  49. Bug Tracker
  50. ===========
  51. Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
  52. In case of trouble, please check there if your issue has already been reported.
  53. If you spotted it first, help us smashing it by providing a detailed and welcomed
  54. `feedback <https://github.com/OCA/web/issues/new?body=module:%20web_editor_background_color%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  55. Do not contact contributors directly about support or help with technical issues.
  56. Credits
  57. =======
  58. Authors
  59. ~~~~~~~
  60. * Tecnativa
  61. Contributors
  62. ~~~~~~~~~~~~
  63. * Jairo Llopis <jairo.llopis@tecnativa.com> - https://www.tecnativa.com
  64. Other credits
  65. ~~~~~~~~~~~~~
  66. * This addon includes code copied from bootstrap-colorpicker_
  67. .. _bootstrap-colorpicker: https://github.com/itsjavi/bootstrap-colorpicker/tree/2.5.3
  68. Maintainers
  69. ~~~~~~~~~~~
  70. This module is maintained by the OCA.
  71. .. image:: https://odoo-community.org/logo.png
  72. :alt: Odoo Community Association
  73. :target: https://odoo-community.org
  74. OCA, or the Odoo Community Association, is a nonprofit organization whose
  75. mission is to support the collaborative development of Odoo features and
  76. promote its widespread use.
  77. This module is part of the `OCA/web <https://github.com/OCA/web/tree/12.0/web_editor_background_color>`_ project on GitHub.
  78. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.