Skip to content

Latest commit

 

History

History
93 lines (63 loc) · 2.8 KB

README.rst

File metadata and controls

93 lines (63 loc) · 2.8 KB

This addon is a ckeditor integration for Plone.

https://secure.travis-ci.org/collective/collective.ckeditor.png

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 https://github.com/collective/collective.ckeditor

Please report issues at https://github.com/collective/collective.ckeditor/issues

After checking out sources, run the included buildout.

This installs copy_ckeditor_code script. This script 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:

http://yourplonesite/++resource++ckeditor/

You need to run bin/copy_ckeditor_code prior to run any Zope/Plone instance with your development collective.ckeditor. Anyway, if you forget, your instance will break with a ConfigurationError:

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

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.