Author: |
Therp BV, Camptocamp SA, Odoo Community Association (OCA) |
License: |
AGPL-3 |
Branch: |
14.0-abi_master |
Repository: |
acsone/web |
Dependencies: |
web,
and
web_editor |
Languages: |
CSS (397, 4.0%),
HTML (509, 5.2%),
JSON (8196, 83.4%),
JavaScript (498, 5.1%),
Markdown (72, 0.7%),
Python (23, 0.2%),
Sass (20, 0.2%),
XML (35, 0.4%),
and
reStructuredText (78, 0.8%) |
Other branches: |
13.0-bp-web_widget_ckeditor,
14.0,
and
14.0-x2many_2d_matrix-sbj |
Other repositories: |
AITIC/web,
AntoniRomera/web,
Change2improve/web,
Darknroses/web,
Digital5-Odoo/web,
ForgeFlow/web,
GSLabIt/web,
Ingeos/web,
KKamaa/web,
LevelPrime/web,
OCA/web,
StefanRijnhart/web,
Tecnativa/web,
Vauxoo/web,
agrista/odoo-web,
akretion/web,
aurestic/web,
blooparksystems/web,
bmya/web,
brain-tec/web,
brian10048/web,
camptocamp/web,
coopiteasy/web,
dingguijin/web,
ecosoft-odoo/web,
gastonfeng/web,
gfcapalbo/web,
initOS/web,
kmee/web,
leanhtuan1996/web,
legalsylvain/web,
modoolar/oca-web,
mohamedhagag/web,
onurugur/web,
sodexis/web,
sunflowerit/web,
tegin/web,
trevi-software/web,
ursais/web,
versada/web,
and
vialaurea/OCA-web |
<h1 class="title">CKEditor Widget</h1>
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/web/tree/14.0/web_widget_ckeditor"><img alt="OCA/web" src="https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/web-14-0/web-14-0-web_widget_ckeditor"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/162/14.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>This module adds a new widget <cite>ckeditor</cite> to edit HTML fields using CKEditor.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id2">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id4">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id5">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id6">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id7">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<a name="configuration"></a>
<h2><a class="toc-backref" href="#id1">Configuration</a></h2>
<p>By default, this module will replace the original <cite>html</cite> wysiwyg field with CKEditor.
The original <cite>html</cite> widget will be renamed as <cite>html_odoo</cite>.</p>
<p>If you only want to use <cite>ckeditor</cite> on specific views, you can disable the <cite>html</cite> widget
override by archiving the <cite>web_widget_ckeditor.assets_backend_field_html_override</cite> view.</p>
<p>When the global <cite>html</cite> widget replacement is disabled, <cite>ckeditor</cite> has to be explicitly
set on the desired <cite>ir.ui.view</cite>:</p>
<pre>
<code lang="xml"><field name="description_html" widget="ckeditor" /></code>
</pre>
<p>The CKEditor toolbar can be customized with an <cite>ir.config_parameter</cite>. To do so,
please create a parameter named <cite>web_widget_ckeditor.toolbar</cite>, and set the desired
toolbar items using either <cite>,</cite>, <cite>space</cite> or <cite>newline</cite> as separators.</p>
<pre class="code">
<code class="code">heading
| bold italic underline removeFormat
| fontSize fontColor fontBackgroundColor
| bulletedList numberedList alignment
| outdent indent pagebreak
| link imageUpload blockQuote insertTable
| undo redo</code>
</pre>
<p>There's more information about available toolbar items in the
<a class="reference external" href="https://ckeditor.com/docs/ckeditor5/latest/features/toolbar/toolbar.html">official CKEditor documentation page</a></p>
<a name="known-issues-roadmap"></a>
<h2><a class="toc-backref" href="#id2">Known issues / Roadmap</a></h2>
<ul class="simple">
<li>Allow to configure toolbar using widget's options.</li>
</ul>
<pre>
<code lang="xml"><field
name="description_html"
widget="ckeditor"
options="{'bulletedList': false, 'pageBreak': true}"
/></code>
</pre>
<ul class="simple">
<li>There seems to be a small incompatibility issue with <cite>web_drop_target</cite>.
<a class="reference external" href="https://github.com/OCA/web/pull/2083#issuecomment-970719103">More information here</a></li>
</ul>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id3">Bug Tracker</a></h2>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/web/issues">GitHub Issues</a>.
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
<a class="reference external" href="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**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
<a name="credits"></a>
<h2><a class="toc-backref" href="#id4">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id5">Authors</a></h3>
<ul class="simple">
<li>Therp BV</li>
<li>Camptocamp SA</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id6">Contributors</a></h3>
<ul>
<li><p class="first"><a class="reference external" href="https://www.therp.nl">Therp</a></p>
<blockquote>
<ul class="simple">
<li>Holger Brunn <<a class="reference external" href="mailto:hbrunn@therp.nl">hbrunn@therp.nl</a>></li>
<li>Stefan Rijnhart <<a class="reference external" href="mailto:stefan@therp.nl">stefan@therp.nl</a>></li>
<li>George Daramouskas <<a class="reference external" href="mailto:gdaramouskas@therp.nl">gdaramouskas@therp.nl</a>></li>
</ul>
</blockquote>
</li>
<li><p class="first"><a class="reference external" href="https://www.camptocamp.com">Camptocamp</a></p>
<blockquote>
<ul class="simple">
<li>Iván Todorovich <<a class="reference external" href="mailto:ivan.todorovich@camptocamp.com">ivan.todorovich@camptocamp.com</a>></li>
</ul>
</blockquote>
</li>
</ul>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id7">Maintainers</a></h3>
<p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>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.</p>
<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
<p><a class="reference external" href="https://github.com/ivantodorovich"><img alt="ivantodorovich" src="https://github.com/ivantodorovich.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/web/tree/14.0/web_widget_ckeditor">OCA/web</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>