From b9dbb9c68163805fe919f1b55b52174a14acf63b Mon Sep 17 00:00:00 2001
From: Rafi Zadanly <zadanlyr@gmail.com>
Date: Wed, 8 Mar 2023 11:00:15 +0700
Subject: add web widget ckeditor

---
 web_widget_ckeditor/readme/CONFIGURE.rst | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 web_widget_ckeditor/readme/CONFIGURE.rst

(limited to 'web_widget_ckeditor/readme/CONFIGURE.rst')

diff --git a/web_widget_ckeditor/readme/CONFIGURE.rst b/web_widget_ckeditor/readme/CONFIGURE.rst
new file mode 100644
index 0000000..50409ef
--- /dev/null
+++ b/web_widget_ckeditor/readme/CONFIGURE.rst
@@ -0,0 +1,32 @@
+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
+
+    <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.
+
+.. 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
+<https://ckeditor.com/docs/ckeditor5/latest/features/toolbar/toolbar.html>`_
-- 
cgit v1.2.3