Skip to content


Subversion checkout URL

You can clone with
Download ZIP
JavaScript HTML Python CSS RobotFramework PHP Shell
Latest commit 8e4e431 @gotcha gotcha update changelog
Failed to load latest commit information.
.cache infra: buildout refresh & travis setup
docs update changelog
src/collective pep8
.coveragerc Define a .coveragerc to restrict report to collective.ckeditor
.gitignore tune ignore
.travis.yml Travis-ci: use containers infra: fix MANIFEST
README.rst Update README.rst
base.cfg pin codeanalysis infra: buildout refresh & travis setup
buildout.cfg infra: buildout refresh & travis setup
setup.cfg migrate tests to p.a.testing
test-4.0.x.cfg infra: buildout refresh & travis setup
test-4.1.x.cfg infra: buildout refresh & travis setup
test-4.3.x.cfg infra: buildout refresh & travis setup
test-4.4.x.cfg infra: buildout refresh & travis setup
travis.cfg infra: fix travis



This addon is a ckeditor integration for Plone.

How to install

You can install it as any Plone addon. Please follow official documentation.

Please use CKeditor for Plone > 4.

The code source can be found at

Please report issues at



Go to ZMi-->portal_setup-->Upgrades, choose "collective.ckeditor:default" profile and execute the upgrade steps.


Release 4.3.0 comes with the Enhanced Image plugin (image2). It is not enabled by default as it removes some of the advanced functionality provided by the default image plugin (image). However, the Enhanced Image plugin provides the ability to add a caption together with the image. It is also much more user-friendly.

To enable the plugin, you need to setup ckeditor_properties through generic setup propertiestool.xml:

<?xml version="1.0"?>
<object name="portal_properties" meta_type="Plone Properties Tool">
 <object name="ckeditor_properties" meta_type="Plone Property Sheet">
  <property name="removePlugins" type="lines">
   <element value="image"/>
  <property name="plugins" type="lines">
   <element value="ajaxsave;/++resource++cke_ajaxsave/plugin.js"/>
   <element value="image2;/++resource++ckeditor/plugins/image2/plugin.js"/>

This disables the image (default) plugin and enables the image2 plugin.

The image2 plugin comes with two specific settings (configurable only through generic setup):

<?xml version="1.0"?>
<object name="portal_properties" meta_type="Plone Properties Tool">
 <object name="ckeditor_properties" meta_type="Plone Property Sheet">
  <property name="image2_captionedClass" type="string">image</property>
  <property name="image2_alignClasses" type="lines">
   <element value="image-left"/>
   <element value=""/>
   <element value="image-right"/>

The settings are image2_captionedClass and image2_alignClasses. The values above are the default values.

If you enable the plugin, you also need to setup Plone to accept the figcaption tag.

This is done by configuring HTML filtering with a setup handler like:

def enable_figcaption(p):
    """ Allow figcaption as valid tag in portal_transforms safe_html"""

    from Products.PortalTransforms.Transform import make_config_persistent

    pt = getToolByName(p, 'portal_transforms')
    tid = 'safe_html'
    if not tid in pt.objectIds():
    trans = pt[tid]
    tconfig = trans._config

    validtags = tconfig['valid_tags']
    validtags.update({'figcaption': 1})

    trans._p_changed = True
    trans.reload()'added figcaption as valid tag')




If you try to run a Zope/Plone instance with a collective.ckeditor checkout, your instance will break with a ConfigurationError:

Directory .../browser/ckeditor does not exist.

After checking out collective.ckeditor sources, run the included buildout.

This installs and runs the copy_ckeditor_code script. It takes care of copying ckeditor code in the appropriate browser/ckeditor directory.

The browser/ckeditor directory makes ckeditor javascript code available to the browser at:


How to Release

Obviously, the ckeditor code also needs to be included in the released eggs.

collective.ckeditor registers an entry point for zest.releaser that (if called properly) takes care of copying the code when preparing the release.

However, in order to take advantage of the entry point, you have to use the bin/fullrelease locally installed by the development buildout instead of a globally installed fullrelease.

Only the local bin/fullrelease script can see the entry_point registered by collective.ckeditor.

How to update to a newer version of CKEditor

Valid for CKEditor 4

  1. Go to

  2. Choose preset Full

  3. Do not modify included plugins.

  4. Select skin Moono color

  5. Click Add all link beside Languages to choose label

  6. Agree with the terms ;-)

  7. Download CKEditor

  8. Unzip archive

  9. Replace all content of src/collective/ckeditor/_src/ckeditor directory with the contents of ckeditor 4 directory from the archive.

  10. Download and install image2 plugin and its dependencies in src/collective/ckeditor/_src/ckeditor/plugins directory. In June 2014, they are found at:

  11. Run bin/copy_ckeditor_code

  12. Test

Tests status




Something went wrong with that request. Please try again.