mirror of
https://github.com/OCA/web.git
synced 2025-02-22 13:21:25 +02:00
[UPD] README.rst
This commit is contained in:
OCA-git-bot
143
web_widget_ckeditor/README.rst
Normal file
143
web_widget_ckeditor/README.rst
Normal file
@@ -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
|
||||
|
||||
<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>`_
|
||||
|
||||
Known issues / Roadmap
|
||||
======================
|
||||
|
||||
* Allow to configure toolbar using widget's options.
|
||||
|
||||
.. code-block:: xml
|
||||
|
||||
<field
|
||||
name="description_html"
|
||||
widget="ckeditor"
|
||||
options="{'bulletedList': false, 'pageBreak': true}"
|
||||
/>
|
||||
|
||||
|
||||
* There seems to be a small incompatibility issue with `web_drop_target`.
|
||||
`More information here <https://github.com/OCA/web/pull/2083#issuecomment-970719103>`_
|
||||
|
||||
Bug Tracker
|
||||
===========
|
||||
|
||||
Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/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 <https://github.com/OCA/web/issues/new?body=module:%20web_widget_ckeditor%0Aversion:%2014.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
|
||||
|
||||
Do not contact contributors directly about support or help with technical issues.
|
||||
|
||||
Credits
|
||||
=======
|
||||
|
||||
Authors
|
||||
~~~~~~~
|
||||
|
||||
* Therp BV
|
||||
* Camptocamp SA
|
||||
|
||||
Contributors
|
||||
~~~~~~~~~~~~
|
||||
|
||||
* `Therp <https://www.therp.nl>`_
|
||||
|
||||
* Holger Brunn <hbrunn@therp.nl>
|
||||
* Stefan Rijnhart <stefan@therp.nl>
|
||||
* George Daramouskas <gdaramouskas@therp.nl>
|
||||
|
||||
* `Camptocamp <https://www.camptocamp.com>`_
|
||||
|
||||
* Iván Todorovich <ivan.todorovich@camptocamp.com>
|
||||
|
||||
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 <https://odoo-community.org/page/maintainer-role>`__:
|
||||
|
||||
|maintainer-ivantodorovich|
|
||||
|
||||
This module is part of the `OCA/web <https://github.com/OCA/web/tree/14.0/web_widget_ckeditor>`_ project on GitHub.
|
||||
|
||||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|
||||
Reference in New Issue
Block a user