diff --git a/web_widget_ckeditor/README.rst b/web_widget_ckeditor/README.rst new file mode 100644 index 000000000..f55b1f463 --- /dev/null +++ b/web_widget_ckeditor/README.rst @@ -0,0 +1,143 @@ +=============== +CKEditor Widget +=============== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github + :target: https://github.com/OCA/web/tree/14.0/web_widget_ckeditor + :alt: OCA/web +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/web-14-0/web-14-0-web_widget_ckeditor + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/162/14.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module adds a new widget `ckeditor` to edit HTML fields using CKEditor. + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +By default, this module will replace the original `html` wysiwyg field with CKEditor. +The original `html` widget will be renamed as `html_odoo`. + +If you only want to use `ckeditor` on specific views, you can disable the `html` widget +override by archiving the `web_widget_ckeditor.assets_backend_field_html_override` view. + +When the global `html` widget replacement is disabled, `ckeditor` has to be explicitly +set on the desired `ir.ui.view`: + +.. code-block:: xml + + + + +The CKEditor toolbar can be customized with an `ir.config_parameter`. To do so, +please create a parameter named `web_widget_ckeditor.toolbar`, and set the desired +toolbar items using either `,`, `space` or `newline` as separators. + +.. code-block:: + + heading + | bold italic underline removeFormat + | fontSize fontColor fontBackgroundColor + | bulletedList numberedList alignment + | outdent indent pagebreak + | link imageUpload blockQuote insertTable + | undo redo + + +There's more information about available toolbar items in the +`official CKEditor documentation page +`_ + +Known issues / Roadmap +====================== + +* Allow to configure toolbar using widget's options. + +.. code-block:: xml + + + + +* There seems to be a small incompatibility issue with `web_drop_target`. + `More information here `_ + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Therp BV +* Camptocamp SA + +Contributors +~~~~~~~~~~~~ + +* `Therp `_ + + * Holger Brunn + * Stefan Rijnhart + * George Daramouskas + +* `Camptocamp `_ + + * Iván Todorovich + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +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. + +.. |maintainer-ivantodorovich| image:: https://github.com/ivantodorovich.png?size=40px + :target: https://github.com/ivantodorovich + :alt: ivantodorovich + +Current `maintainer `__: + +|maintainer-ivantodorovich| + +This module is part of the `OCA/web `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/web_widget_ckeditor/static/description/index.html b/web_widget_ckeditor/static/description/index.html new file mode 100644 index 000000000..b3377db68 --- /dev/null +++ b/web_widget_ckeditor/static/description/index.html @@ -0,0 +1,482 @@ + + + + + + +CKEditor Widget + + + +
+

CKEditor Widget

+ + +

Beta License: AGPL-3 OCA/web Translate me on Weblate Try me on Runbot

+

This module adds a new widget ckeditor to edit HTML fields using CKEditor.

+

Table of contents

+ +
+

Configuration

+

By default, this module will replace the original html wysiwyg field with CKEditor. +The original html widget will be renamed as html_odoo.

+

If you only want to use ckeditor on specific views, you can disable the html widget +override by archiving the web_widget_ckeditor.assets_backend_field_html_override view.

+

When the global html widget replacement is disabled, ckeditor has to be explicitly +set on the desired ir.ui.view:

+
+<field name="description_html" widget="ckeditor" />
+
+

The CKEditor toolbar can be customized with an ir.config_parameter. To do so, +please create a parameter named web_widget_ckeditor.toolbar, and set the desired +toolbar items using either ,, space or newline as separators.

+
+heading
+| bold italic underline removeFormat
+| fontSize fontColor fontBackgroundColor
+| bulletedList numberedList alignment
+| outdent indent pagebreak
+| link imageUpload blockQuote insertTable
+| undo redo
+
+

There’s more information about available toolbar items in the +official CKEditor documentation page

+
+
+

Known issues / Roadmap

+
    +
  • Allow to configure toolbar using widget’s options.
    • +
+
+<field
+    name="description_html"
+    widget="ckeditor"
+    options="{'bulletedList': false, 'pageBreak': true}"
+/>
+
+ +
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +feedback.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • Therp BV
    • +
  • Camptocamp SA
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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.

+

Current maintainer:

+

ivantodorovich

+

This module is part of the OCA/web project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ +